class Table in Migrate Plus 8.4

Same name and namespace in other branches

8.5 src/Plugin/migrate/destination/Table.php \Drupal\migrate_plus\Plugin\migrate\destination\Table
8.3 src/Plugin/migrate/destination/Table.php \Drupal\migrate_plus\Plugin\migrate\destination\Table

Provides table destination plugin.

Use this plugin for a table not registered with Drupal Schema API.

Examples:


  destination:
    plugin: table
    # Key for the database connection to use for inserting records.
    database_key: roads_db
    # DB table for storage.
    table_name: roads
    # Maximum number of rows to insert in one query.
    batch_size: 3
    # Fields used by migrate to identify table rows uniquely. At least one
    # field is required.
    id_fields:
      name:
        type: string
      suburb:
        type: string
      ward:
        type: string
    # Mapping of column names to values set in migrate process.
    fields:
      name: name
      owner: owner
      suburb: suburb
      ward: ward
      type: type

For numeric id fields, migrate can generate the values on-the-fly, by enabling use_auto_increment; in such case, the id field may be ommitted from the 'fields' section:


  destination:
    plugin: table
    # ...
    id_fields:
      my_id_field:
        type: integer
        use_auto_increment: true
    # ...
    fields:
      non_my_id_field_1: non_my_id_field_1
      non_my_id_field_2: non_my_id_field_2

Plugin annotation


@MigrateDestination(
  id = "table"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
    class \Drupal\migrate_plus\Plugin\migrate\destination\Table implements ContainerFactoryPluginInterface

Expanded class hierarchy of Table

File

src/Plugin/migrate/destination/Table.php, line 71

Namespace

Drupal\migrate_plus\Plugin\migrate\destination

View source

class Table extends DestinationBase implements ContainerFactoryPluginInterface {

  /**
   * The name of the destination table.
   *
   * @var string
   */
  protected $tableName;

  /**
   * IDMap compatible array of id fields.
   *
   * @var array
   */
  protected $idFields;

  /**
   * Array of fields present on the destination table.
   *
   * @var array
   */
  protected $fields;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $dbConnection;

  /**
   * Constructs a new Table.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, Connection $connection) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration);
    $this->dbConnection = $connection;
    $this->tableName = $configuration['table_name'];
    $this->idFields = $configuration['id_fields'];
    $this->fields = isset($configuration['fields']) ? $configuration['fields'] : [];
    $this->supportsRollback = TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $db_key = !empty($configuration['database_key']) ? $configuration['database_key'] : NULL;
    return new static($configuration, $plugin_id, $plugin_definition, $migration, Database::getConnection('default', $db_key));
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    if (empty($this->idFields)) {
      throw new MigrateException('Id fields are required for a table destination');
    }
    return $this->idFields;
  }

  /**
   * {@inheritdoc}
   */
  public function fields(MigrationInterface $migration = NULL) {
    return $this->fields;
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $id = $row
      ->getSourceIdValues();
    if (count($id) != count($this->idFields)) {
      throw new MigrateSkipProcessException('All the id fields are required for a table migration.');
    }
    $values = $row
      ->getDestination();
    if ($this->fields) {
      $values = array_intersect_key($values, $this->fields);
    }
    $status = $this->dbConnection
      ->merge($this->tableName)
      ->key($id)
      ->fields($values)
      ->execute();
    return $status ? $id : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function rollback(array $destination_identifier) {
    $delete = $this->dbConnection
      ->delete($this->tableName);
    foreach ($destination_identifier as $field => $value) {
      $delete
        ->condition($field, $value);
    }
    $delete
      ->execute();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule	public	function	Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule	1
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
Table::$dbConnection	protected	property	The database connection.
Table::$fields	protected	property	Array of fields present on the destination table.
Table::$idFields	protected	property	IDMap compatible array of id fields.
Table::$tableName	protected	property	The name of the destination table.
Table::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Table::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Table::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
Table::import	public	function	Import the row. Overrides MigrateDestinationInterface::import
Table::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides DestinationBase::rollback
Table::__construct	public	function	Constructs a new Table. Overrides DestinationBase::__construct

You are here