SqlContentEntityStorage.php 61.4 KB
Newer Older
1 2
<?php

3
namespace Drupal\Core\Entity\Sql;
4

5
use Drupal\Core\Cache\CacheBackendInterface;
6
use Drupal\Core\Cache\MemoryCache\MemoryCacheInterface;
7
use Drupal\Core\Database\Connection;
8
use Drupal\Core\Database\Database;
9 10
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\SchemaException;
11 12
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\ContentEntityStorageBase;
13
use Drupal\Core\Entity\EntityBundleListenerInterface;
14 15 16 17
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityStorageException;
use Drupal\Core\Entity\EntityTypeInterface;
18
use Drupal\Core\Entity\Query\QueryInterface;
19
use Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface;
20
use Drupal\Core\Field\FieldDefinitionInterface;
21
use Drupal\Core\Field\FieldStorageDefinitionInterface;
22
use Drupal\Core\Language\LanguageInterface;
23
use Drupal\Core\Language\LanguageManagerInterface;
24 25 26
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
27
 * A content entity database storage implementation.
28
 *
29
 * This class can be used as-is by most content entity types. Entity types
30
 * requiring special handling can extend the class.
31
 *
32
 * The class uses \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
33
 * internally in order to automatically generate the database schema based on
34 35
 * the defined base fields. Entity types can override the schema handler to
 * customize the generated schema; e.g., to add additional indexes.
36 37
 *
 * @ingroup entity_api
38
 */
39
class SqlContentEntityStorage extends ContentEntityStorageBase implements SqlEntityStorageInterface, DynamicallyFieldableEntityStorageSchemaInterface, EntityBundleListenerInterface {
40 41 42 43 44 45 46

  /**
   * The mapping of field columns to SQL tables.
   *
   * @var \Drupal\Core\Entity\Sql\TableMappingInterface
   */
  protected $tableMapping;
47 48 49 50 51 52 53 54 55 56

  /**
   * Name of entity's revision database table field, if it supports revisions.
   *
   * Has the value FALSE if this entity does not use revisions.
   *
   * @var string
   */
  protected $revisionKey = FALSE;

57 58 59 60 61 62 63
  /**
   * The entity langcode key.
   *
   * @var string|bool
   */
  protected $langcodeKey = FALSE;

64 65 66 67 68 69 70
  /**
   * The default language entity key.
   *
   * @var string
   */
  protected $defaultLangcodeKey = FALSE;

71 72 73 74 75 76 77
  /**
   * The base table of the entity.
   *
   * @var string
   */
  protected $baseTable;

78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
  /**
   * The table that stores revisions, if the entity supports revisions.
   *
   * @var string
   */
  protected $revisionTable;

  /**
   * The table that stores properties, if the entity has multilingual support.
   *
   * @var string
   */
  protected $dataTable;

  /**
   * The table that stores revision field data if the entity supports revisions.
   *
   * @var string
   */
  protected $revisionDataTable;

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

106
  /**
107
   * The entity type's storage schema object.
108
   *
109
   * @var \Drupal\Core\Entity\Schema\EntityStorageSchemaInterface
110
   */
111
  protected $storageSchema;
112

113 114 115 116 117 118 119
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

120 121 122 123 124 125 126
  /**
   * Whether this storage should use the temporary table mapping.
   *
   * @var bool
   */
  protected $temporary = FALSE;

127 128 129
  /**
   * {@inheritdoc}
   */
130
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
131
    return new static(
132
      $entity_type,
133
      $container->get('database'),
134
      $container->get('entity.manager'),
135
      $container->get('cache.entity'),
136 137
      $container->get('language_manager'),
      $container->get('entity.memory_cache')
138 139 140
    );
  }

141 142 143 144 145 146 147 148 149 150 151
  /**
   * Gets the base field definitions for a content entity type.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   The array of base field definitions for the entity type, keyed by field
   *   name.
   */
  public function getFieldStorageDefinitions() {
    return $this->entityManager->getBaseFieldDefinitions($this->entityTypeId);
  }

152
  /**
153
   * Constructs a SqlContentEntityStorage object.
154
   *
155 156
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
157 158
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection to be used.
159 160
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
161
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache
162
   *   The cache backend to be used.
163 164
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
165 166
   * @param \Drupal\Core\Cache\MemoryCache\MemoryCacheInterface|null $memory_cache
   *   The memory cache backend to be used.
167
   */
168 169
  public function __construct(EntityTypeInterface $entity_type, Connection $database, EntityManagerInterface $entity_manager, CacheBackendInterface $cache, LanguageManagerInterface $language_manager, MemoryCacheInterface $memory_cache = NULL) {
    parent::__construct($entity_type, $entity_manager, $cache, $memory_cache);
170
    $this->database = $database;
171
    $this->languageManager = $language_manager;
172 173 174 175 176 177 178 179 180 181 182 183 184 185
    $this->initTableLayout();
  }

  /**
   * Initializes table name variables.
   */
  protected function initTableLayout() {
    // Reset table field values to ensure changes in the entity type definition
    // are correctly reflected in the table layout.
    $this->tableMapping = NULL;
    $this->revisionKey = NULL;
    $this->revisionTable = NULL;
    $this->dataTable = NULL;
    $this->revisionDataTable = NULL;
186 187

    // @todo Remove table names from the entity type definition in
188
    //   https://www.drupal.org/node/2232465.
189 190 191 192 193 194
    $this->baseTable = $this->entityType->getBaseTable() ?: $this->entityTypeId;
    $revisionable = $this->entityType->isRevisionable();
    if ($revisionable) {
      $this->revisionKey = $this->entityType->getKey('revision') ?: 'revision_id';
      $this->revisionTable = $this->entityType->getRevisionTable() ?: $this->entityTypeId . '_revision';
    }
195
    $translatable = $this->entityType->isTranslatable();
196 197
    if ($translatable) {
      $this->dataTable = $this->entityType->getDataTable() ?: $this->entityTypeId . '_field_data';
198
      $this->langcodeKey = $this->entityType->getKey('langcode');
199
      $this->defaultLangcodeKey = $this->entityType->getKey('default_langcode');
200 201 202 203 204 205 206
    }
    if ($revisionable && $translatable) {
      $this->revisionDataTable = $this->entityType->getRevisionDataTable() ?: $this->entityTypeId . '_field_revision';
    }
  }

  /**
207
   * Gets the base table name.
208 209 210 211 212 213 214 215 216
   *
   * @return string
   *   The table name.
   */
  public function getBaseTable() {
    return $this->baseTable;
  }

  /**
217
   * Gets the revision table name.
218 219 220 221 222 223 224 225 226
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionTable() {
    return $this->revisionTable;
  }

  /**
227
   * Gets the data table name.
228 229 230 231 232 233 234 235 236
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getDataTable() {
    return $this->dataTable;
  }

  /**
237
   * Gets the revision data table name.
238 239 240 241 242 243 244
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionDataTable() {
    return $this->revisionDataTable;
  }
245

246
  /**
247
   * Gets the entity type's storage schema object.
248
   *
249
   * @return \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
250
   *   The schema object.
251
   */
252 253 254 255
  protected function getStorageSchema() {
    if (!isset($this->storageSchema)) {
      $class = $this->entityType->getHandlerClass('storage_schema') ?: 'Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema';
      $this->storageSchema = new $class($this->entityManager, $this->entityType, $this, $this->database);
256
    }
257
    return $this->storageSchema;
258
  }
259

260
  /**
261 262 263 264 265
   * Updates the wrapped entity type definition.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The update entity type.
   *
266 267
   * @internal Only to be used internally by Entity API. Expected to be
   *   removed by https://www.drupal.org/node/2274017.
268
   */
269 270 271 272 273 274
  public function setEntityType(EntityTypeInterface $entity_type) {
    if ($this->entityType->id() == $entity_type->id()) {
      $this->entityType = $entity_type;
      $this->initTableLayout();
    }
    else {
275
      throw new EntityStorageException("Unsupported entity type {$entity_type->id()}");
276 277
    }
  }
278

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
  /**
   * Sets the wrapped table mapping definition.
   *
   * @param \Drupal\Core\Entity\Sql\TableMappingInterface $table_mapping
   *   The table mapping.
   *
   * @internal Only to be used internally by Entity API. Expected to be removed
   *   by https://www.drupal.org/node/2554235.
   */
  public function setTableMapping(TableMappingInterface $table_mapping) {
    $this->tableMapping = $table_mapping;
  }

  /**
   * Changes the temporary state of the storage.
   *
   * @param bool $temporary
   *   Whether to use a temporary table mapping or not.
   *
   * @internal Only to be used internally by Entity API.
   */
  public function setTemporary($temporary) {
    $this->temporary = $temporary;
  }

304 305 306 307 308 309 310 311 312 313 314
  /**
   * {@inheritdoc}
   */
  public function getTableMapping(array $storage_definitions = NULL) {
    $table_mapping = $this->tableMapping;

    // If we are using our internal storage definitions, which is our main use
    // case, we can statically cache the computed table mapping. If a new set
    // of field storage definitions is passed, for instance when comparing old
    // and new storage schema, we compute the table mapping without caching.
    if (!isset($this->tableMapping) || $storage_definitions) {
315
      $table_mapping_class = $this->temporary ? TemporaryTableMapping::class : DefaultTableMapping::class;
316 317
      $definitions = $storage_definitions ?: $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);

318 319
      /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping|\Drupal\Core\Entity\Sql\TemporaryTableMapping $table_mapping */
      $table_mapping = $table_mapping_class::create($this->entityType, $definitions);
320 321 322 323 324 325

      // Cache the computed table mapping only if we are using our internal
      // storage definitions.
      if (!$storage_definitions) {
        $this->tableMapping = $table_mapping;
      }
326
    }
327

328
    return $table_mapping;
329 330 331 332 333
  }

  /**
   * {@inheritdoc}
   */
334
  protected function doLoadMultiple(array $ids = NULL) {
335 336 337 338 339
    // Attempt to load entities from the persistent cache. This will remove IDs
    // that were loaded from $ids.
    $entities_from_cache = $this->getFromPersistentCache($ids);

    // Load any remaining entities from the database.
340 341 342 343
    if ($entities_from_storage = $this->getFromStorage($ids)) {
      $this->invokeStorageLoadHook($entities_from_storage);
      $this->setPersistentCache($entities_from_storage);
    }
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358

    return $entities_from_cache + $entities_from_storage;
  }

  /**
   * Gets entities from the storage.
   *
   * @param array|null $ids
   *   If not empty, return entities that match these IDs. Return all entities
   *   when NULL.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface[]
   *   Array of entities from the storage.
   */
  protected function getFromStorage(array $ids = NULL) {
359
    $entities = [];
360

361 362 363 364 365 366
    if (!empty($ids)) {
      // Sanitize IDs. Before feeding ID array into buildQuery, check whether
      // it is empty as this would load all entities.
      $ids = $this->cleanIds($ids);
    }

367 368 369 370 371 372 373 374 375 376 377 378 379 380
    if ($ids === NULL || $ids) {
      // Build and execute the query.
      $query_result = $this->buildQuery($ids)->execute();
      $records = $query_result->fetchAllAssoc($this->idKey);

      // Map the loaded records into entity objects and according fields.
      if ($records) {
        $entities = $this->mapFromStorageRecords($records);
      }
    }

    return $entities;
  }

381
  /**
382
   * Maps from storage records to entity objects, and attaches fields.
383
   *
384
   * @param array $records
385 386
   *   Associative array of query results, keyed on the entity ID or revision
   *   ID.
387
   * @param bool $load_from_revision
388 389
   *   (optional) Flag to indicate whether revisions should be loaded or not.
   *   Defaults to FALSE.
390 391 392 393
   *
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
394
  protected function mapFromStorageRecords(array $records, $load_from_revision = FALSE) {
395
    if (!$records) {
396
      return [];
397 398
    }

399 400 401 402 403 404 405 406
    // Get the names of the fields that are stored in the base table and, if
    // applicable, the revision table. Other entity data will be loaded in
    // loadFromSharedTables() and loadFromDedicatedTables().
    $field_names = $this->tableMapping->getFieldNames($this->baseTable);
    if ($this->revisionTable) {
      $field_names = array_unique(array_merge($field_names, $this->tableMapping->getFieldNames($this->revisionTable)));
    }

407
    $values = [];
408
    foreach ($records as $id => $record) {
409
      $values[$id] = [];
410 411 412
      // Skip the item delta and item value levels (if possible) but let the
      // field assign the value as suiting. This avoids unnecessary array
      // hierarchies and saves memory here.
413 414 415 416 417 418 419 420 421 422
      foreach ($field_names as $field_name) {
        $field_columns = $this->tableMapping->getColumnNames($field_name);
        // Handle field types that store several properties.
        if (count($field_columns) > 1) {
          foreach ($field_columns as $property_name => $column_name) {
            if (property_exists($record, $column_name)) {
              $values[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT][$property_name] = $record->{$column_name};
              unset($record->{$column_name});
            }
          }
423
        }
424
        // Handle field types that store only one property.
425
        else {
426 427 428 429 430
          $column_name = reset($field_columns);
          if (property_exists($record, $column_name)) {
            $values[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT] = $record->{$column_name};
            unset($record->{$column_name});
          }
431
        }
432
      }
433 434 435 436 437 438

      // Handle additional record entries that are not provided by an entity
      // field, such as 'isDefaultRevision'.
      foreach ($record as $name => $value) {
        $values[$id][$name][LanguageInterface::LANGCODE_DEFAULT] = $value;
      }
439
    }
440

441
    // Initialize translations array.
442
    $translations = array_fill_keys(array_keys($values), []);
443 444

    // Load values from shared and dedicated tables.
445
    $this->loadFromSharedTables($values, $translations, $load_from_revision);
446 447
    $this->loadFromDedicatedTables($values, $load_from_revision);

448
    $entities = [];
449 450 451 452 453
    foreach ($values as $id => $entity_values) {
      $bundle = $this->bundleKey ? $entity_values[$this->bundleKey][LanguageInterface::LANGCODE_DEFAULT] : FALSE;
      // Turn the record into an entity class.
      $entities[$id] = new $this->entityClass($entity_values, $this->entityTypeId, $bundle, array_keys($translations[$id]));
    }
454

455 456 457 458
    return $entities;
  }

  /**
459
   * Loads values for fields stored in the shared data tables.
460
   *
461
   * @param array &$values
462 463
   *   Associative array of entities values, keyed on the entity ID or the
   *   revision ID.
464 465
   * @param array &$translations
   *   List of translations, keyed on the entity ID.
466 467
   * @param bool $load_from_revision
   *   Flag to indicate whether revisions should be loaded or not.
468
   */
469 470
  protected function loadFromSharedTables(array &$values, array &$translations, $load_from_revision) {
    $record_key = !$load_from_revision ? $this->idKey : $this->revisionKey;
471 472 473 474
    if ($this->dataTable) {
      // If a revision table is available, we need all the properties of the
      // latest revision. Otherwise we fall back to the data table.
      $table = $this->revisionDataTable ?: $this->dataTable;
475
      $alias = $this->revisionDataTable ? 'revision' : 'data';
476
      $query = $this->database->select($table, $alias, ['fetch' => \PDO::FETCH_ASSOC])
477
        ->fields($alias)
478 479
        ->condition($alias . '.' . $record_key, array_keys($values), 'IN')
        ->orderBy($alias . '.' . $record_key);
480

481
      $table_mapping = $this->getTableMapping();
482
      if ($this->revisionDataTable) {
483 484
        // Find revisioned fields that are not entity keys. Exclude the langcode
        // key as the base table holds only the default language.
485
        $base_fields = array_diff($table_mapping->getFieldNames($this->baseTable), [$this->langcodeKey]);
486
        $revisioned_fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $base_fields);
487 488 489

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
490 491 492 493 494
        $data_fields = array_diff($table_mapping->getFieldNames($this->dataTable), $revisioned_fields, $base_fields);
        // If there are no data fields then only revisioned fields are needed
        // else both data fields and revisioned fields are needed to map the
        // entity values.
        $all_fields = $revisioned_fields;
495
        if ($data_fields) {
496
          $all_fields = array_merge($revisioned_fields, $data_fields);
497
          $query->leftJoin($this->dataTable, 'data', "(revision.$this->idKey = data.$this->idKey and revision.$this->langcodeKey = data.$this->langcodeKey)");
498 499 500 501 502 503 504 505 506 507 508
          $column_names = [];
          // Some fields can have more then one columns in the data table so
          // column names are needed.
          foreach ($data_fields as $data_field) {
            // \Drupal\Core\Entity\Sql\TableMappingInterface:: getColumNames()
            // returns an array keyed by property names so remove the keys
            // before array_merge() to avoid losing data with fields having the
            // same columns i.e. value.
            $column_names = array_merge($column_names, array_values($table_mapping->getColumnNames($data_field)));
          }
          $query->fields('data', $column_names);
509 510
        }

511
        // Get the revision IDs.
512
        $revision_ids = [];
513 514
        foreach ($values as $entity_values) {
          $revision_ids[] = $entity_values[$this->revisionKey][LanguageInterface::LANGCODE_DEFAULT];
515
        }
516
        $query->condition('revision.' . $this->revisionKey, $revision_ids, 'IN');
517 518
      }
      else {
519
        $all_fields = $table_mapping->getFieldNames($this->dataTable);
520 521
      }

522 523
      $result = $query->execute();
      foreach ($result as $row) {
524
        $id = $row[$record_key];
525 526

        // Field values in default language are stored with
527
        // LanguageInterface::LANGCODE_DEFAULT as key.
528 529
        $langcode = empty($row[$this->defaultLangcodeKey]) ? $row[$this->langcodeKey] : LanguageInterface::LANGCODE_DEFAULT;

530 531
        $translations[$id][$langcode] = TRUE;

532
        foreach ($all_fields as $field_name) {
533 534 535
          $columns = $table_mapping->getColumnNames($field_name);
          // Do not key single-column fields by property name.
          if (count($columns) == 1) {
536
            $values[$id][$field_name][$langcode] = $row[reset($columns)];
537 538
          }
          else {
539
            foreach ($columns as $property_name => $column_name) {
540
              $values[$id][$field_name][$langcode][$property_name] = $row[$column_name];
541
            }
542 543 544 545 546 547 548
          }
        }
      }
    }
  }

  /**
549
   * {@inheritdoc}
550
   */
551
  protected function doLoadRevisionFieldItems($revision_id) {
552
    @trigger_error('"\Drupal\Core\Entity\ContentEntityStorageBase::doLoadRevisionFieldItems()" is deprecated in Drupal 8.5.x and will be removed before Drupal 9.0.0. "\Drupal\Core\Entity\ContentEntityStorageBase::doLoadMultipleRevisionsFieldItems()" should be implemented instead. See https://www.drupal.org/node/2924915.', E_USER_DEPRECATED);
553

554 555 556 557 558 559 560 561 562 563
    $revisions = $this->doLoadMultipleRevisionsFieldItems([$revision_id]);

    return !empty($revisions) ? reset($revisions) : NULL;
  }

  /**
   * {@inheritdoc}
   */
  protected function doLoadMultipleRevisionsFieldItems($revision_ids) {
    $revisions = [];
564

565 566 567 568 569 570 571 572 573 574 575 576 577
    // Sanitize IDs. Before feeding ID array into buildQuery, check whether
    // it is empty as this would load all entity revisions.
    $revision_ids = $this->cleanIds($revision_ids, 'revision');

    if (!empty($revision_ids)) {
      // Build and execute the query.
      $query_result = $this->buildQuery(NULL, $revision_ids)->execute();
      $records = $query_result->fetchAllAssoc($this->revisionKey);

      // Map the loaded records into entity objects and according fields.
      if ($records) {
        $revisions = $this->mapFromStorageRecords($records, TRUE);
      }
578
    }
579

580
    return $revisions;
581 582 583
  }

  /**
584
   * {@inheritdoc}
585
   */
586 587 588 589
  protected function doDeleteRevisionFieldItems(ContentEntityInterface $revision) {
    $this->database->delete($this->revisionTable)
      ->condition($this->revisionKey, $revision->getRevisionId())
      ->execute();
590 591 592 593 594 595 596

    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
        ->condition($this->revisionKey, $revision->getRevisionId())
        ->execute();
    }

597
    $this->deleteRevisionFromDedicatedTables($revision);
598 599 600
  }

  /**
601
   * {@inheritdoc}
602 603 604 605
   */
  protected function buildPropertyQuery(QueryInterface $entity_query, array $values) {
    if ($this->dataTable) {
      // @todo We should not be using a condition to specify whether conditions
606 607
      //   apply to the default language. See
      //   https://www.drupal.org/node/1866330.
608 609
      // Default to the original entity language if not explicitly specified
      // otherwise.
610 611
      if (!array_key_exists($this->defaultLangcodeKey, $values)) {
        $values[$this->defaultLangcodeKey] = 1;
612 613 614
      }
      // If the 'default_langcode' flag is explicitly not set, we do not care
      // whether the queried values are in the original entity language or not.
615 616
      elseif ($values[$this->defaultLangcodeKey] === NULL) {
        unset($values[$this->defaultLangcodeKey]);
617 618 619
      }
    }

620
    parent::buildPropertyQuery($entity_query, $values);
621 622 623 624 625 626 627 628 629 630 631
  }

  /**
   * Builds the query to load the entity.
   *
   * This has full revision support. For entities requiring special queries,
   * the class can be extended, and the default query can be constructed by
   * calling parent::buildQuery(). This is usually necessary when the object
   * being loaded needs to be augmented with additional data from another
   * table, such as loading node type into comments or vocabulary machine name
   * into terms, however it can also support $conditions on different tables.
632
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
633 634 635
   *
   * @param array|null $ids
   *   An array of entity IDs, or NULL to load all entities.
636 637 638
   * @param array|bool $revision_ids
   *   The IDs of the revisions to load, or FALSE if this query is asking for
   *   the default revisions. Defaults to FALSE.
639
   *
640
   * @return \Drupal\Core\Database\Query\Select
641 642
   *   A SelectQuery object for loading the entity.
   */
643
  protected function buildQuery($ids, $revision_ids = FALSE) {
644
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
645

646
    $query->addTag($this->entityTypeId . '_load_multiple');
647

648 649 650 651 652
    if ($revision_ids) {
      if (!is_array($revision_ids)) {
        @trigger_error('Passing a single revision ID to "\Drupal\Core\Entity\Sql\SqlContentEntityStorage::buildQuery()" is deprecated in Drupal 8.5.x and will be removed before Drupal 9.0.0. An array of revision IDs should be given instead. See https://www.drupal.org/node/2924915.', E_USER_DEPRECATED);
      }
      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} IN (:revisionIds[])", [':revisionIds[]' => (array) $revision_ids]);
653 654 655 656 657 658
    }
    elseif ($this->revisionTable) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
    }

    // Add fields from the {entity} table.
659 660
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
661 662 663

    if ($this->revisionTable) {
      // Add all fields from the {entity_revision} table.
664
      $entity_revision_fields = $table_mapping->getAllColumns($this->revisionTable);
665
      $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields);
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
      // The ID field is provided by entity, so remove it.
      unset($entity_revision_fields[$this->idKey]);

      // Remove all fields from the base table that are also fields by the same
      // name in the revision table.
      $entity_field_keys = array_flip($entity_fields);
      foreach ($entity_revision_fields as $name) {
        if (isset($entity_field_keys[$name])) {
          unset($entity_fields[$entity_field_keys[$name]]);
        }
      }
      $query->fields('revision', $entity_revision_fields);

      // Compare revision ID of the base and revision table, if equal then this
      // is the default revision.
681
      $query->addExpression('CASE base.' . $this->revisionKey . ' WHEN revision.' . $this->revisionKey . ' THEN 1 ELSE 0 END', 'isDefaultRevision');
682 683 684 685 686 687 688 689 690 691 692 693
    }

    $query->fields('base', $entity_fields);

    if ($ids) {
      $query->condition("base.{$this->idKey}", $ids, 'IN');
    }

    return $query;
  }

  /**
694
   * {@inheritdoc}
695 696 697 698 699 700 701 702 703
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

    $transaction = $this->database->startTransaction();
    try {
704
      parent::delete($entities);
705

706 707
      // Ignore replica server temporarily.
      db_ignore_replica();
708 709
    }
    catch (\Exception $e) {
710
      $transaction->rollBack();
711
      watchdog_exception($this->entityTypeId, $e);
712 713 714 715 716 717 718
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

  /**
   * {@inheritdoc}
   */
719
  protected function doDeleteFieldItems($entities) {
720
    $ids = array_keys($entities);
721

722
    $this->database->delete($this->entityType->getBaseTable())
723
      ->condition($this->idKey, $ids, 'IN')
724
      ->execute();
725

726 727
    if ($this->revisionTable) {
      $this->database->delete($this->revisionTable)
728
        ->condition($this->idKey, $ids, 'IN')
729 730
        ->execute();
    }
731

732 733
    if ($this->dataTable) {
      $this->database->delete($this->dataTable)
734
        ->condition($this->idKey, $ids, 'IN')
735 736
        ->execute();
    }
737

738 739
    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
740
        ->condition($this->idKey, $ids, 'IN')
741 742
        ->execute();
    }
743

744
    foreach ($entities as $entity) {
745
      $this->deleteFromDedicatedTables($entity);
746 747 748 749 750 751 752 753 754 755
    }
  }

  /**
   * {@inheritdoc}
   */
  public function save(EntityInterface $entity) {
    $transaction = $this->database->startTransaction();
    try {
      $return = parent::save($entity);
756

757 758
      // Ignore replica server temporarily.
      db_ignore_replica();
759 760 761
      return $return;
    }
    catch (\Exception $e) {
762
      $transaction->rollBack();
763
      watchdog_exception($this->entityTypeId, $e);
764 765 766 767
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

768 769 770
  /**
   * {@inheritdoc}
   */
771 772 773
  protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
    $full_save = empty($names);
    $update = !$full_save || !$entity->isNew();
774

775 776 777
    if ($full_save) {
      $shared_table_fields = TRUE;
      $dedicated_table_fields = TRUE;
778 779
    }
    else {
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
      $table_mapping = $this->getTableMapping();
      $storage_definitions = $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);
      $shared_table_fields = FALSE;
      $dedicated_table_fields = [];

      // Collect the name of fields to be written in dedicated tables and check
      // whether shared table records need to be updated.
      foreach ($names as $name) {
        $storage_definition = $storage_definitions[$name];
        if ($table_mapping->allowsSharedTableStorage($storage_definition)) {
          $shared_table_fields = TRUE;
        }
        elseif ($table_mapping->requiresDedicatedTableStorage($storage_definition)) {
          $dedicated_table_fields[] = $name;
        }
795
      }
796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
    }

    // Update shared table records if necessary.
    if ($shared_table_fields) {
      $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->baseTable);
      // Create the storage record to be saved.
      if ($update) {
        $default_revision = $entity->isDefaultRevision();
        if ($default_revision) {
          $this->database
            ->update($this->baseTable)
            ->fields((array) $record)
            ->condition($this->idKey, $record->{$this->idKey})
            ->execute();
        }
        if ($this->revisionTable) {
          if ($full_save) {
            $entity->{$this->revisionKey} = $this->saveRevision($entity);
          }
          else {
            $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->revisionTable);
            $entity->preSaveRevision($this, $record);
            $this->database
              ->update($this->revisionTable)
              ->fields((array) $record)
              ->condition($this->revisionKey, $record->{$this->revisionKey})
              ->execute();
          }
        }
        if ($default_revision && $this->dataTable) {
          $this->saveToSharedTables($entity);
        }
        if ($this->revisionDataTable) {
          $new_revision = $full_save && $entity->isNewRevision();
          $this->saveToSharedTables($entity, $this->revisionDataTable, $new_revision);
        }
832
      }
833 834
      else {
        $insert_id = $this->database
835
          ->insert($this->baseTable, ['return' => Database::RETURN_INSERT_ID])
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
          ->fields((array) $record)
          ->execute();
        // Even if this is a new entity the ID key might have been set, in which
        // case we should not override the provided ID. An ID key that is not set
        // to any value is interpreted as NULL (or DEFAULT) and thus overridden.
        if (!isset($record->{$this->idKey})) {
          $record->{$this->idKey} = $insert_id;
        }
        $entity->{$this->idKey} = (string) $record->{$this->idKey};
        if ($this->revisionTable) {
          $record->{$this->revisionKey} = $this->saveRevision($entity);
        }
        if ($this->dataTable) {
          $this->saveToSharedTables($entity);
        }
        if ($this->revisionDataTable) {
          $this->saveToSharedTables($entity, $this->revisionDataTable);
        }
854 855 856
      }
    }

857 858 859 860
    // Update dedicated table records if necessary.
    if ($dedicated_table_fields) {
      $names = is_array($dedicated_table_fields) ? $dedicated_table_fields : [];
      $this->saveToDedicatedTables($entity, $update, $names);
861
    }
862 863 864 865 866 867 868 869 870
  }

  /**
   * {@inheritdoc}
   */
  protected function has($id, EntityInterface $entity) {
    return !$entity->isNew();
  }

871
  /**
872
   * Saves fields that use the shared tables.
873
   *
874
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
875
   *   The entity object.
876 877
   * @param string $table_name
   *   (optional) The table name to save to. Defaults to the data table.
878 879 880
   * @param bool $new_revision
   *   (optional) Whether we are dealing with a new revision. By default fetches
   *   the information from the entity object.
881
   */
882
  protected function saveToSharedTables(ContentEntityInterface $entity, $table_name = NULL, $new_revision = NULL) {
883 884 885
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
886 887 888
    if (!isset($new_revision)) {
      $new_revision = $entity->isNewRevision();
    }
889
    $revision = $table_name != $this->dataTable;
890

891
    if (!$revision || !$new_revision) {
892 893 894 895 896 897 898 899 900 901 902 903
      $key = $revision ? $this->revisionKey : $this->idKey;
      $value = $revision ? $entity->getRevisionId() : $entity->id();
      // Delete and insert to handle removed values.
      $this->database->delete($table_name)
        ->condition($key, $value)
        ->execute();
    }

    $query = $this->database->insert($table_name);

    foreach ($entity->getTranslationLanguages() as $langcode => $language) {
      $translation = $entity->getTranslation($langcode);
904
      $record = $this->mapToDataStorageRecord($translation, $table_name);
905 906 907 908 909 910 911 912 913 914 915 916
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

  /**
   * Maps from an entity object to the storage record.
   *
917
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
918
   *   The entity object.
919 920
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the base table.
921 922 923 924
   *
   * @return \stdClass
   *   The record to store.
   */
925 926 927 928 929
  protected function mapToStorageRecord(ContentEntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->baseTable;
    }

930
    $record = new \stdClass();
931 932
    $table_mapping = $this->getTableMapping();
    foreach ($table_mapping->getFieldNames($table_name) as $field_name) {
933

934
      if (empty($this->getFieldStorageDefinitions()[$field_name])) {
935
        throw new EntityStorageException("Table mapping contains invalid field $field_name.");
936
      }
937
      $definition = $this->getFieldStorageDefinitions()[$field_name];
938 939 940 941 942 943 944
      $columns = $table_mapping->getColumnNames($field_name);

      foreach ($columns as $column_name => $schema_name) {
        // If there is no main property and only a single column, get all
        // properties from the first field item and assume that they will be
        // stored serialized.
        // @todo Give field types more control over this behavior in
945
        //   https://www.drupal.org/node/2232427.
946
        if (!$definition->getMainPropertyName() && count($columns) == 1) {
947
          $value = ($item = $entity->$field_name->first()) ? $item->getValue() : [];
948
        }
949 950
        else {
          $value = isset($entity->$field_name->$column_name) ? $entity->$field_name->$column_name : NULL;
951
        }
952 953
        if (!empty($definition->getSchema()['columns'][$column_name]['serialize'])) {
          $value = serialize($value);
954
        }
955 956 957 958 959

        // Do not set serial fields if we do not have a value. This supports all
        // SQL database drivers.
        // @see https://www.drupal.org/node/2279395
        $value = drupal_schema_get_field_value($definition->getSchema()['columns'][$column_name], $value);
960
        if (!(empty($value) && $this->isColumnSerial($table_name, $schema_name))) {
961 962
          $record->$schema_name = $value;
        }
963 964 965 966 967 968
      }
    }

    return $record;
  }

969 970 971 972 973 974 975 976 977
  /**
   * Checks whether a field column should be treated as serial.
   *
   * @param $table_name
   *   The name of the table the field column belongs to.
   * @param $schema_name
   *   The schema name of the field column.
   *
   * @return bool
978
   *   TRUE if the column is serial, FALSE otherwise.
979
   *
980 981
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processBaseTable()
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processRevisionTable()
982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998
   */
  protected function isColumnSerial($table_name, $schema_name) {
    $result = FALSE;

    switch ($table_name) {
      case $this->baseTable:
        $result = $schema_name == $this->idKey;
        break;

      case $this->revisionTable:
        $result = $schema_name == $this->revisionKey;
        break;
    }

    return $result;
  }

999 1000 1001 1002 1003
  /**
   * Maps from an entity object to the storage record of the field data.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
1004 1005
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the data table.
1006 1007 1008 1009
   *
   * @return \stdClass
   *   The record to store.
   */
1010 1011 1012 1013 1014
  protected function mapToDataStorageRecord(EntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
    $record = $this->mapToStorageRecord($entity, $table_name);
1015 1016 1017 1018 1019 1020
    return $record;
  }

  /**
   * Saves an entity revision.
   *
1021
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
1022 1023 1024 1025 1026
   *   The entity object.
   *
   * @return int
   *   The revision id.
   */
1027
  protected function saveRevision(ContentEntityInterface $entity) {
1028
    $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->revisionTable);
1029 1030 1031 1032

    $entity->preSaveRevision($this, $record);

    if ($entity->isNewRevision()) {
1033
      $insert_id = $this->database
1034
        ->insert($this->revisionTable, ['return' => Database::RETURN_INSERT_ID])
1035 1036
        ->fields((array) $record)
        ->execute();
1037
      // Even if this is a new revision, the revision ID key might have been
1038 1039 1040 1041
      // set in which case we should not override the provided revision ID.
      if (!isset($record->{$this->revisionKey})) {
        $record->{$this->revisionKey} = $insert_id;
      }
1042
      if ($entity->isDefaultRevision()) {