SqlContentEntityStorage.php 61 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\ContentEntityTypeInterface;
14
use Drupal\Core\Entity\EntityBundleListenerInterface;
15 16 17 18
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityStorageException;
use Drupal\Core\Entity\EntityTypeInterface;
19
use Drupal\Core\Entity\Query\QueryInterface;
20
use Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface;
21
use Drupal\Core\Field\FieldDefinitionInterface;
22
use Drupal\Core\Field\FieldStorageDefinitionInterface;
23
use Drupal\Core\Language\LanguageInterface;
24
use Drupal\Core\Language\LanguageManagerInterface;
25 26 27
use Symfony\Component\DependencyInjection\ContainerInterface;

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

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

  /**
   * 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;

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

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

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

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 106
  /**
   * 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;

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

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

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

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

142 143 144 145 146 147 148 149 150 151 152
  /**
   * 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);
  }

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

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

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

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

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

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

247
  /**
248
   * Gets the entity type's storage schema object.
249
   *
250
   * @return \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
251
   *   The schema object.
252
   */
253 254 255 256
  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);
257
    }
258
    return $this->storageSchema;
259
  }
260

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

305 306 307 308
  /**
   * {@inheritdoc}
   */
  public function getTableMapping(array $storage_definitions = NULL) {
309 310 311 312 313 314
    // 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 ($storage_definitions) {
      return $this->getCustomTableMapping($this->entityType, $storage_definitions);
    }
315 316

    // If we are using our internal storage definitions, which is our main use
317 318 319 320 321
    // case, we can statically cache the computed table mapping.
    if (!isset($this->tableMapping)) {
      $storage_definitions = $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);

      $this->tableMapping = $this->getCustomTableMapping($this->entityType, $storage_definitions);
322
    }
323

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
    return $this->tableMapping;
  }

  /**
   * Gets a table mapping for the specified entity type and storage definitions.
   *
   * @param \Drupal\Core\Entity\ContentEntityTypeInterface $entity_type
   *   An entity type definition.
   * @param \Drupal\Core\Field\FieldStorageDefinitionInterface[] $storage_definitions
   *   An array of field storage definitions to be used to compute the table
   *   mapping.
   *
   * @return \Drupal\Core\Entity\Sql\TableMappingInterface
   *   A table mapping object for the entity's tables.
   *
   * @internal
   */
  public function getCustomTableMapping(ContentEntityTypeInterface $entity_type, array $storage_definitions) {
    $table_mapping_class = $this->temporary ? TemporaryTableMapping::class : DefaultTableMapping::class;
    return $table_mapping_class::create($entity_type, $storage_definitions);
344 345 346 347 348
  }

  /**
   * {@inheritdoc}
   */
349
  protected function doLoadMultiple(array $ids = NULL) {
350 351 352 353 354
    // 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.
355 356 357 358
    if ($entities_from_storage = $this->getFromStorage($ids)) {
      $this->invokeStorageLoadHook($entities_from_storage);
      $this->setPersistentCache($entities_from_storage);
    }
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

    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) {
374
    $entities = [];
375

376 377 378 379 380 381
    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);
    }

382 383 384 385 386 387 388 389 390 391 392 393 394 395
    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;
  }

396
  /**
397
   * Maps from storage records to entity objects, and attaches fields.
398
   *
399
   * @param array $records
400 401
   *   Associative array of query results, keyed on the entity ID or revision
   *   ID.
402
   * @param bool $load_from_revision
403 404
   *   (optional) Flag to indicate whether revisions should be loaded or not.
   *   Defaults to FALSE.
405 406 407 408
   *
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
409
  protected function mapFromStorageRecords(array $records, $load_from_revision = FALSE) {
410
    if (!$records) {
411
      return [];
412 413
    }

414 415 416 417 418 419 420 421
    // 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)));
    }

422
    $values = [];
423
    foreach ($records as $id => $record) {
424
      $values[$id] = [];
425 426 427
      // 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.
428 429 430 431 432 433 434 435 436 437
      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});
            }
          }
438
        }
439
        // Handle field types that store only one property.
440
        else {
441 442 443 444 445
          $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});
          }
446
        }
447
      }
448 449 450 451 452 453

      // 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;
      }
454
    }
455

456
    // Initialize translations array.
457
    $translations = array_fill_keys(array_keys($values), []);
458 459

    // Load values from shared and dedicated tables.
460
    $this->loadFromSharedTables($values, $translations, $load_from_revision);
461 462
    $this->loadFromDedicatedTables($values, $load_from_revision);

463
    $entities = [];
464 465 466 467 468
    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]));
    }
469

470 471 472 473
    return $entities;
  }

  /**
474
   * Loads values for fields stored in the shared data tables.
475
   *
476
   * @param array &$values
477 478
   *   Associative array of entities values, keyed on the entity ID or the
   *   revision ID.
479 480
   * @param array &$translations
   *   List of translations, keyed on the entity ID.
481 482
   * @param bool $load_from_revision
   *   Flag to indicate whether revisions should be loaded or not.
483
   */
484 485
  protected function loadFromSharedTables(array &$values, array &$translations, $load_from_revision) {
    $record_key = !$load_from_revision ? $this->idKey : $this->revisionKey;
486 487 488 489
    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;
490
      $alias = $this->revisionDataTable ? 'revision' : 'data';
491
      $query = $this->database->select($table, $alias, ['fetch' => \PDO::FETCH_ASSOC])
492
        ->fields($alias)
493 494
        ->condition($alias . '.' . $record_key, array_keys($values), 'IN')
        ->orderBy($alias . '.' . $record_key);
495

496
      $table_mapping = $this->getTableMapping();
497
      if ($this->revisionDataTable) {
498 499
        // Find revisioned fields that are not entity keys. Exclude the langcode
        // key as the base table holds only the default language.
500
        $base_fields = array_diff($table_mapping->getFieldNames($this->baseTable), [$this->langcodeKey]);
501
        $revisioned_fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $base_fields);
502 503 504

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
505 506 507 508 509
        $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;
510
        if ($data_fields) {
511
          $all_fields = array_merge($revisioned_fields, $data_fields);
512
          $query->leftJoin($this->dataTable, 'data', "(revision.$this->idKey = data.$this->idKey and revision.$this->langcodeKey = data.$this->langcodeKey)");
513 514 515 516 517 518 519 520 521 522 523
          $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);
524 525
        }

526
        // Get the revision IDs.
527
        $revision_ids = [];
528 529
        foreach ($values as $entity_values) {
          $revision_ids[] = $entity_values[$this->revisionKey][LanguageInterface::LANGCODE_DEFAULT];
530
        }
531
        $query->condition('revision.' . $this->revisionKey, $revision_ids, 'IN');
532 533
      }
      else {
534
        $all_fields = $table_mapping->getFieldNames($this->dataTable);
535 536
      }

537 538
      $result = $query->execute();
      foreach ($result as $row) {
539
        $id = $row[$record_key];
540 541

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

545 546
        $translations[$id][$langcode] = TRUE;

547
        foreach ($all_fields as $field_name) {
548 549 550
          $columns = $table_mapping->getColumnNames($field_name);
          // Do not key single-column fields by property name.
          if (count($columns) == 1) {
551
            $values[$id][$field_name][$langcode] = $row[reset($columns)];
552 553
          }
          else {
554
            foreach ($columns as $property_name => $column_name) {
555
              $values[$id][$field_name][$langcode][$property_name] = $row[$column_name];
556
            }
557 558 559 560 561 562 563
          }
        }
      }
    }
  }

  /**
564
   * {@inheritdoc}
565
   */
566
  protected function doLoadRevisionFieldItems($revision_id) {
567
    @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);
568

569 570 571 572 573 574 575 576 577 578
    $revisions = $this->doLoadMultipleRevisionsFieldItems([$revision_id]);

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

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

580 581 582 583 584 585 586 587 588 589 590 591 592
    // 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);
      }
593
    }
594

595
    return $revisions;
596 597 598
  }

  /**
599
   * {@inheritdoc}
600
   */
601 602 603 604
  protected function doDeleteRevisionFieldItems(ContentEntityInterface $revision) {
    $this->database->delete($this->revisionTable)
      ->condition($this->revisionKey, $revision->getRevisionId())
      ->execute();
605 606 607 608 609 610 611

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

612
    $this->deleteRevisionFromDedicatedTables($revision);
613 614 615
  }

  /**
616
   * {@inheritdoc}
617 618 619 620
   */
  protected function buildPropertyQuery(QueryInterface $entity_query, array $values) {
    if ($this->dataTable) {
      // @todo We should not be using a condition to specify whether conditions
621 622
      //   apply to the default language. See
      //   https://www.drupal.org/node/1866330.
623 624
      // Default to the original entity language if not explicitly specified
      // otherwise.
625 626
      if (!array_key_exists($this->defaultLangcodeKey, $values)) {
        $values[$this->defaultLangcodeKey] = 1;
627 628 629
      }
      // 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.
630 631
      elseif ($values[$this->defaultLangcodeKey] === NULL) {
        unset($values[$this->defaultLangcodeKey]);
632 633 634
      }
    }

635
    parent::buildPropertyQuery($entity_query, $values);
636 637 638 639 640 641 642 643 644 645 646
  }

  /**
   * 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.
647
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
648 649 650
   *
   * @param array|null $ids
   *   An array of entity IDs, or NULL to load all entities.
651 652 653
   * @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.
654
   *
655
   * @return \Drupal\Core\Database\Query\Select
656 657
   *   A SelectQuery object for loading the entity.
   */
658
  protected function buildQuery($ids, $revision_ids = FALSE) {
659
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
660

661
    $query->addTag($this->entityTypeId . '_load_multiple');
662

663 664 665 666 667
    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]);
668 669 670 671 672 673
    }
    elseif ($this->revisionTable) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
    }

    // Add fields from the {entity} table.
674 675
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
676 677 678

    if ($this->revisionTable) {
      // Add all fields from the {entity_revision} table.
679
      $entity_revision_fields = $table_mapping->getAllColumns($this->revisionTable);
680
      $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields);
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
      // 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.
696
      $query->addExpression('CASE base.' . $this->revisionKey . ' WHEN revision.' . $this->revisionKey . ' THEN 1 ELSE 0 END', 'isDefaultRevision');
697 698 699 700 701 702 703 704 705 706 707 708
    }

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

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

    return $query;
  }

  /**
709
   * {@inheritdoc}
710 711 712 713 714 715 716 717 718
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

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

721 722
      // Ignore replica server temporarily.
      db_ignore_replica();
723 724
    }
    catch (\Exception $e) {
725
      $transaction->rollBack();
726
      watchdog_exception($this->entityTypeId, $e);
727 728 729 730 731 732 733
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

  /**
   * {@inheritdoc}
   */
734
  protected function doDeleteFieldItems($entities) {
735
    $ids = array_keys($entities);
736

737
    $this->database->delete($this->entityType->getBaseTable())
738
      ->condition($this->idKey, $ids, 'IN')
739
      ->execute();
740

741 742
    if ($this->revisionTable) {
      $this->database->delete($this->revisionTable)
743
        ->condition($this->idKey, $ids, 'IN')
744 745
        ->execute();
    }
746

747 748
    if ($this->dataTable) {
      $this->database->delete($this->dataTable)
749
        ->condition($this->idKey, $ids, 'IN')
750 751
        ->execute();
    }
752

753 754
    if ($this->revisionDataTable) {
      $this->database->delete($this->revisionDataTable)
755
        ->condition($this->idKey, $ids, 'IN')
756 757
        ->execute();
    }
758

759
    foreach ($entities as $entity) {
760
      $this->deleteFromDedicatedTables($entity);
761 762 763 764 765 766 767 768 769 770
    }
  }

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

772 773
      // Ignore replica server temporarily.
      db_ignore_replica();
774 775 776
      return $return;
    }
    catch (\Exception $e) {
777
      $transaction->rollBack();
778
      watchdog_exception($this->entityTypeId, $e);
779 780 781 782
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

783 784 785
  /**
   * {@inheritdoc}
   */
786 787 788
  protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
    $full_save = empty($names);
    $update = !$full_save || !$entity->isNew();
789

790 791 792
    if ($full_save) {
      $shared_table_fields = TRUE;
      $dedicated_table_fields = TRUE;
793 794
    }
    else {
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
      $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;
        }
810
      }
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
    }

    // 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);
        }
847
      }
848 849
      else {
        $insert_id = $this->database
850
          ->insert($this->baseTable, ['return' => Database::RETURN_INSERT_ID])
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
          ->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);
        }
869 870 871
      }
    }

872 873 874 875
    // Update dedicated table records if necessary.
    if ($dedicated_table_fields) {
      $names = is_array($dedicated_table_fields) ? $dedicated_table_fields : [];
      $this->saveToDedicatedTables($entity, $update, $names);
876
    }
877 878 879 880 881 882 883 884 885
  }

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

886
  /**
887
   * Saves fields that use the shared tables.
888
   *
889
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
890
   *   The entity object.
891 892
   * @param string $table_name
   *   (optional) The table name to save to. Defaults to the data table.
893 894 895
   * @param bool $new_revision
   *   (optional) Whether we are dealing with a new revision. By default fetches
   *   the information from the entity object.
896
   */
897
  protected function saveToSharedTables(ContentEntityInterface $entity, $table_name = NULL, $new_revision = NULL) {
898 899 900
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
901 902 903
    if (!isset($new_revision)) {
      $new_revision = $entity->isNewRevision();
    }
904
    $revision = $table_name != $this->dataTable;
905

906
    if (!$revision || !$new_revision) {
907 908 909 910 911 912 913 914 915 916 917 918
      $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);
919
      $record = $this->mapToDataStorageRecord($translation, $table_name);
920 921 922 923 924 925 926 927 928 929 930 931
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

  /**
   * Maps from an entity object to the storage record.
   *
932
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
933
   *   The entity object.
934 935
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the base table.
936 937 938 939
   *
   * @return \stdClass
   *   The record to store.
   */
940 941 942 943 944
  protected function mapToStorageRecord(ContentEntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->baseTable;
    }

945
    $record = new \stdClass();
946 947
    $table_mapping = $this->getTableMapping();
    foreach ($table_mapping->getFieldNames($table_name) as $field_name) {
948

949
      if (empty($this->getFieldStorageDefinitions()[$field_name])) {
950
        throw new EntityStorageException("Table mapping contains invalid field $field_name.");
951
      }
952
      $definition = $this->getFieldStorageDefinitions()[$field_name];
953 954 955 956 957 958 959
      $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
960
        //   https://www.drupal.org/node/2232427.
961
        if (!$definition->getMainPropertyName() && count($columns) == 1) {
962
          $value = ($item = $entity->$field_name->first()) ? $item->getValue() : [];
963
        }
964 965
        else {
          $value = isset($entity->$field_name->$column_name) ? $entity->$field_name->$column_name : NULL;
966
        }
967 968
        if (!empty($definition->getSchema()['columns'][$column_name]['serialize'])) {
          $value = serialize($value);
969
        }
970 971 972 973 974

        // 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);
975
        if (!(empty($value) && $this->isColumnSerial($table_name, $schema_name))) {
976 977
          $record->$schema_name = $value;
        }
978 979 980 981 982 983
      }
    }

    return $record;
  }

984 985 986 987 988 989 990 991 992
  /**
   * 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
993
   *   TRUE if the column is serial, FALSE otherwise.
994
   *
995 996
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processBaseTable()
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processRevisionTable()
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
   */
  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;
  }

1014 1015 1016 1017 1018
  /**
   * Maps from an entity object to the storage record of the field data.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity object.
1019 1020
   * @param string $table_name
   *   (optional) The table name to map records to. Defaults to the data table.
1021 1022 1023 1024
   *
   * @return \stdClass
   *   The record to store.
   */
1025 1026 1027 1028 1029
  protected function mapToDataStorageRecord(EntityInterface $entity, $table_name = NULL) {
    if (!isset($table_name)) {
      $table_name = $this->dataTable;
    }
    $record = $this->mapToStorageRecord($entity, $table_name);
1030 1031 1032 1033 1034 1035
    return $record;
  }

  /**
   * Saves an entity revision.
   *
1036
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
1037 1038 1039 1040 1041
   *   The entity object.
   *
   * @return int
   *   The revision id.
   */
1042
  protected function saveRevision(ContentEntityInterface $entity) {
1043
    $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->revisionTable);
1044 1045 1046 1047

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

    if ($entity->isNewRevision()) {
1048
      $insert_id = $this->database
1049
        ->insert($this->revisionTable, ['return' => Database::RETURN_INSERT_ID])
1050 1051
        ->fields((array) $record)
        ->execute();
1052
      // Even if this is a new revision, the revision ID key might have been