SqlContentEntityStorage.php 61.5 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\Core\Entity\Sql\SqlContentEntityStorage.
6 7
 */

8
namespace Drupal\Core\Entity\Sql;
9

10
use Drupal\Core\Cache\CacheBackendInterface;
11
use Drupal\Core\Database\Connection;
12
use Drupal\Core\Database\Database;
13 14
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\SchemaException;
15 16
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\ContentEntityStorageBase;
17
use Drupal\Core\Entity\EntityBundleListenerInterface;
18 19 20 21
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityStorageException;
use Drupal\Core\Entity\EntityTypeInterface;
22
use Drupal\Core\Entity\Query\QueryInterface;
23
use Drupal\Core\Entity\Schema\DynamicallyFieldableEntityStorageSchemaInterface;
24
use Drupal\Core\Field\FieldDefinitionInterface;
25
use Drupal\Core\Field\FieldStorageDefinitionInterface;
26
use Drupal\Core\Language\LanguageInterface;
27
use Drupal\field\FieldStorageConfigInterface;
28
use Drupal\Core\Language\LanguageManagerInterface;
29 30 31
use Symfony\Component\DependencyInjection\ContainerInterface;

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

  /**
   * The mapping of field columns to SQL tables.
   *
   * @var \Drupal\Core\Entity\Sql\TableMappingInterface
   */
  protected $tableMapping;
52 53 54 55 56 57 58 59 60 61

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

62 63 64 65 66 67 68
  /**
   * The entity langcode key.
   *
   * @var string|bool
   */
  protected $langcodeKey = FALSE;

69 70 71 72 73 74 75
  /**
   * The default language entity key.
   *
   * @var string
   */
  protected $defaultLangcodeKey = FALSE;

76 77 78 79 80 81 82
  /**
   * The base table of the entity.
   *
   * @var string
   */
  protected $baseTable;

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
  /**
   * 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;

111
  /**
112
   * The entity type's storage schema object.
113
   *
114
   * @var \Drupal\Core\Entity\Schema\EntityStorageSchemaInterface
115
   */
116
  protected $storageSchema;
117

118 119 120 121 122 123 124
  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

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

138 139 140 141 142 143 144 145 146 147 148
  /**
   * 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);
  }

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

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

  /**
202
   * Gets the base table name.
203 204 205 206 207 208 209 210 211
   *
   * @return string
   *   The table name.
   */
  public function getBaseTable() {
    return $this->baseTable;
  }

  /**
212
   * Gets the revision table name.
213 214 215 216 217 218 219 220 221
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionTable() {
    return $this->revisionTable;
  }

  /**
222
   * Gets the data table name.
223 224 225 226 227 228 229 230 231
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getDataTable() {
    return $this->dataTable;
  }

  /**
232
   * Gets the revision data table name.
233 234 235 236 237 238 239
   *
   * @return string|false
   *   The table name or FALSE if it is not available.
   */
  public function getRevisionDataTable() {
    return $this->revisionDataTable;
  }
240

241
  /**
242
   * Gets the entity type's storage schema object.
243
   *
244
   * @return \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema
245
   *   The schema object.
246
   */
247 248 249 250
  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);
251
    }
252
    return $this->storageSchema;
253
  }
254

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

274 275 276 277 278 279 280 281 282 283 284 285 286 287
  /**
   * {@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.
    // @todo Clean-up this in https://www.drupal.org/node/2274017 so we can
    //   easily instantiate a new table mapping whenever needed.
    if (!isset($this->tableMapping) || $storage_definitions) {
      $definitions = $storage_definitions ?: $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);
288
      $table_mapping = new DefaultTableMapping($this->entityType, $definitions);
289 290 291

      $definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) {
        return $table_mapping->allowsSharedTableStorage($definition);
292 293 294 295 296 297 298 299 300 301 302 303 304
      });

      $key_fields = array_values(array_filter(array($this->idKey, $this->revisionKey, $this->bundleKey, $this->uuidKey, $this->langcodeKey)));
      $all_fields = array_keys($definitions);
      $revisionable_fields = array_keys(array_filter($definitions, function (FieldStorageDefinitionInterface $definition) {
        return $definition->isRevisionable();
      }));
      // Make sure the key fields come first in the list of fields.
      $all_fields = array_merge($key_fields, array_diff($all_fields, $key_fields));

      // Nodes have all three of these fields, while custom blocks only have
      // log.
      // @todo Provide automatic definitions for revision metadata fields in
305
      //   https://www.drupal.org/node/2248983.
306 307 308 309 310
      $revision_metadata_fields = array_intersect(array(
        'revision_timestamp',
        'revision_uid',
        'revision_log',
      ), $all_fields);
311 312

      $revisionable = $this->entityType->isRevisionable();
313
      $translatable = $this->entityType->isTranslatable();
314 315
      if (!$revisionable && !$translatable) {
        // The base layout stores all the base field values in the base table.
316
        $table_mapping->setFieldNames($this->baseTable, $all_fields);
317 318 319 320 321 322
      }
      elseif ($revisionable && !$translatable) {
        // The revisionable layout stores all the base field values in the base
        // table, except for revision metadata fields. Revisionable fields
        // denormalized in the base table but also stored in the revision table
        // together with the entity ID and the revision ID as identifiers.
323
        $table_mapping->setFieldNames($this->baseTable, array_diff($all_fields, $revision_metadata_fields));
324
        $revision_key_fields = array($this->idKey, $this->revisionKey);
325
        $table_mapping->setFieldNames($this->revisionTable, array_merge($revision_key_fields, $revisionable_fields));
326 327 328 329 330 331 332 333
      }
      elseif (!$revisionable && $translatable) {
        // Multilingual layouts store key field values in the base table. The
        // other base field values are stored in the data table, no matter
        // whether they are translatable or not. The data table holds also a
        // denormalized copy of the bundle field value to allow for more
        // performant queries. This means that only the UUID is not stored on
        // the data table.
334
        $table_mapping
335
          ->setFieldNames($this->baseTable, $key_fields)
336
          ->setFieldNames($this->dataTable, array_values(array_diff($all_fields, array($this->uuidKey))));
337 338 339 340 341 342 343 344 345
      }
      elseif ($revisionable && $translatable) {
        // The revisionable multilingual layout stores key field values in the
        // base table, except for language, which is stored in the revision
        // table along with revision metadata. The revision data table holds
        // data field values for all the revisionable fields and the data table
        // holds the data field values for all non-revisionable fields. The data
        // field values of revisionable fields are denormalized in the data
        // table, as well.
346
        $table_mapping->setFieldNames($this->baseTable, array_values($key_fields));
347 348 349 350 351

        // Like in the multilingual, non-revisionable case the UUID is not
        // in the data table. Additionally, do not store revision metadata
        // fields in the data table.
        $data_fields = array_values(array_diff($all_fields, array($this->uuidKey), $revision_metadata_fields));
352
        $table_mapping->setFieldNames($this->dataTable, $data_fields);
353 354

        $revision_base_fields = array_merge(array($this->idKey, $this->revisionKey, $this->langcodeKey), $revision_metadata_fields);
355
        $table_mapping->setFieldNames($this->revisionTable, $revision_base_fields);
356 357

        $revision_data_key_fields = array($this->idKey, $this->revisionKey, $this->langcodeKey);
358
        $revision_data_fields = array_diff($revisionable_fields, $revision_metadata_fields, array($this->langcodeKey));
359
        $table_mapping->setFieldNames($this->revisionDataTable, array_merge($revision_data_key_fields, $revision_data_fields));
360
      }
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385

      // Add dedicated tables.
      $definitions = array_filter($definitions, function (FieldStorageDefinitionInterface $definition) use ($table_mapping) {
        return $table_mapping->requiresDedicatedTableStorage($definition);
      });
      $extra_columns = array(
        'bundle',
        'deleted',
        'entity_id',
        'revision_id',
        'langcode',
        'delta',
      );
      foreach ($definitions as $field_name => $definition) {
        foreach (array($table_mapping->getDedicatedDataTableName($definition), $table_mapping->getDedicatedRevisionTableName($definition)) as $table_name) {
          $table_mapping->setFieldNames($table_name, array($field_name));
          $table_mapping->setExtraColumns($table_name, $extra_columns);
        }
      }

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

388
    return $table_mapping;
389 390 391 392 393
  }

  /**
   * {@inheritdoc}
   */
394
  protected function doLoadMultiple(array $ids = NULL) {
395 396 397 398 399
    // 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.
400 401 402 403
    if ($entities_from_storage = $this->getFromStorage($ids)) {
      $this->invokeStorageLoadHook($entities_from_storage);
      $this->setPersistentCache($entities_from_storage);
    }
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

    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) {
    $entities = array();

421 422 423 424 425 426
    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);
    }

427 428 429 430 431 432 433 434 435 436 437 438 439 440
    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;
  }

441
  /**
442
   * Maps from storage records to entity objects, and attaches fields.
443
   *
444 445
   * @param array $records
   *   Associative array of query results, keyed on the entity ID.
446 447
   * @param bool $load_from_revision
   *   Flag to indicate whether revisions should be loaded or not.
448 449 450 451
   *
   * @return array
   *   An array of entity objects implementing the EntityInterface.
   */
452
  protected function mapFromStorageRecords(array $records, $load_from_revision = FALSE) {
453 454 455 456
    if (!$records) {
      return array();
    }

457
    $values = array();
458
    foreach ($records as $id => $record) {
459
      $values[$id] = array();
460 461 462
      // 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.
463
      foreach ($record as $name => $value) {
464 465 466 467
        // Handle columns named [field_name]__[column_name] (e.g for field types
        // that store several properties).
        if ($field_name = strstr($name, '__', TRUE)) {
          $property_name = substr($name, strpos($name, '__') + 2);
468
          $values[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT][$property_name] = $value;
469 470 471 472
        }
        else {
          // Handle columns named directly after the field (e.g if the field
          // type only stores one property).
473
          $values[$id][$name][LanguageInterface::LANGCODE_DEFAULT] = $value;
474
        }
475 476
      }
    }
477

478 479 480 481 482 483 484 485 486 487 488 489 490
    // Initialize translations array.
    $translations = array_fill_keys(array_keys($values), array());

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

    $entities = array();
    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]));
    }
491

492 493 494 495
    return $entities;
  }

  /**
496
   * Loads values for fields stored in the shared data tables.
497
   *
498 499 500 501
   * @param array &$values
   *   Associative array of entities values, keyed on the entity ID.
   * @param array &$translations
   *   List of translations, keyed on the entity ID.
502
   */
503
  protected function loadFromSharedTables(array &$values, array &$translations) {
504 505 506 507
    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;
508 509 510
      $alias = $this->revisionDataTable ? 'revision' : 'data';
      $query = $this->database->select($table, $alias, array('fetch' => \PDO::FETCH_ASSOC))
        ->fields($alias)
511
        ->condition($alias . '.' . $this->idKey, array_keys($values), 'IN')
512
        ->orderBy($alias . '.' . $this->idKey);
513

514
      $table_mapping = $this->getTableMapping();
515
      if ($this->revisionDataTable) {
516 517 518 519
        // Find revisioned fields that are not entity keys. Exclude the langcode
        // key as the base table holds only the default language.
        $base_fields = array_diff($table_mapping->getFieldNames($this->baseTable), array($this->langcodeKey));
        $fields = array_diff($table_mapping->getFieldNames($this->revisionDataTable), $base_fields);
520 521 522

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
523
        $data_fields = array_diff($table_mapping->getFieldNames($this->dataTable), $fields, $base_fields);
524 525 526 527 528 529
        if ($data_fields) {
          $fields = array_merge($fields, $data_fields);
          $query->leftJoin($this->dataTable, 'data', "(revision.$this->idKey = data.$this->idKey)");
          $query->fields('data', $data_fields);
        }

530 531
        // Get the revision IDs.
        $revision_ids = array();
532 533
        foreach ($values as $entity_values) {
          $revision_ids[] = $entity_values[$this->revisionKey][LanguageInterface::LANGCODE_DEFAULT];
534
        }
535
        $query->condition('revision.' . $this->revisionKey, $revision_ids, 'IN');
536 537
      }
      else {
538
        $fields = $table_mapping->getFieldNames($this->dataTable);
539 540
      }

541 542 543
      $result = $query->execute();
      foreach ($result as $row) {
        $id = $row[$this->idKey];
544 545

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

549 550
        $translations[$id][$langcode] = TRUE;

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

  /**
568
   * {@inheritdoc}
569
   */
570 571 572
  protected function doLoadRevisionFieldItems($revision_id) {
    $revision = NULL;

573 574
    // Build and execute the query.
    $query_result = $this->buildQuery(array(), $revision_id)->execute();
575
    $records = $query_result->fetchAllAssoc($this->idKey);
576

577 578
    if (!empty($records)) {
      // Convert the raw records to entity objects.
579
      $entities = $this->mapFromStorageRecords($records, TRUE);
580
      $revision = reset($entities) ?: NULL;
581
    }
582 583

    return $revision;
584 585 586
  }

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

  /**
597
   * {@inheritdoc}
598 599 600 601
   */
  protected function buildPropertyQuery(QueryInterface $entity_query, array $values) {
    if ($this->dataTable) {
      // @todo We should not be using a condition to specify whether conditions
602 603
      //   apply to the default language. See
      //   https://www.drupal.org/node/1866330.
604 605
      // Default to the original entity language if not explicitly specified
      // otherwise.
606 607
      if (!array_key_exists($this->defaultLangcodeKey, $values)) {
        $values[$this->defaultLangcodeKey] = 1;
608 609 610
      }
      // 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.
611 612
      elseif ($values[$this->defaultLangcodeKey] === NULL) {
        unset($values[$this->defaultLangcodeKey]);
613 614 615
      }
    }

616
    parent::buildPropertyQuery($entity_query, $values);
617 618 619 620 621 622 623 624 625 626 627
  }

  /**
   * 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.
628
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
629 630 631 632 633 634 635
   *
   * @param array|null $ids
   *   An array of entity IDs, or NULL to load all entities.
   * @param $revision_id
   *   The ID of the revision to load, or FALSE if this query is asking for the
   *   most current revision(s).
   *
636
   * @return \Drupal\Core\Database\Query\Select
637 638 639
   *   A SelectQuery object for loading the entity.
   */
  protected function buildQuery($ids, $revision_id = FALSE) {
640
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
641

642
    $query->addTag($this->entityTypeId . '_load_multiple');
643 644 645 646 647 648 649 650 651

    if ($revision_id) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} = :revisionId", array(':revisionId' => $revision_id));
    }
    elseif ($this->revisionTable) {
      $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
    }

    // Add fields from the {entity} table.
652 653
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
654 655 656

    if ($this->revisionTable) {
      // Add all fields from the {entity_revision} table.
657
      $entity_revision_fields = $table_mapping->getAllColumns($this->revisionTable);
658
      $entity_revision_fields = array_combine($entity_revision_fields, $entity_revision_fields);
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
      // 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.
674
      $query->addExpression('CASE base.' . $this->revisionKey . ' WHEN revision.' . $this->revisionKey . ' THEN 1 ELSE 0 END', 'isDefaultRevision');
675 676 677 678 679 680 681 682 683 684 685 686
    }

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

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

    return $query;
  }

  /**
687
   * Implements \Drupal\Core\Entity\EntityStorageInterface::delete().
688 689 690 691 692 693 694 695 696
   */
  public function delete(array $entities) {
    if (!$entities) {
      // If no IDs or invalid IDs were passed, do nothing.
      return;
    }

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

699 700
      // Ignore replica server temporarily.
      db_ignore_replica();
701 702 703
    }
    catch (\Exception $e) {
      $transaction->rollback();
704
      watchdog_exception($this->entityTypeId, $e);
705 706 707 708 709 710 711
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

  /**
   * {@inheritdoc}
   */
712
  protected function doDeleteFieldItems($entities) {
713
    $ids = array_keys($entities);
714

715
    $this->database->delete($this->entityType->getBaseTable())
716
      ->condition($this->idKey, $ids, 'IN')
717
      ->execute();
718

719 720
    if ($this->revisionTable) {
      $this->database->delete($this->revisionTable)
721
        ->condition($this->idKey, $ids, 'IN')
722 723
        ->execute();
    }
724

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

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

737
    foreach ($entities as $entity) {
738
      $this->deleteFromDedicatedTables($entity);
739 740 741 742 743 744 745 746 747 748
    }
  }

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

750 751
      // Ignore replica server temporarily.
      db_ignore_replica();
752 753 754 755
      return $return;
    }
    catch (\Exception $e) {
      $transaction->rollback();
756
      watchdog_exception($this->entityTypeId, $e);
757 758 759 760
      throw new EntityStorageException($e->getMessage(), $e->getCode(), $e);
    }
  }

761 762 763
  /**
   * {@inheritdoc}
   */
764 765 766
  protected function doSaveFieldItems(ContentEntityInterface $entity, array $names = []) {
    $full_save = empty($names);
    $update = !$full_save || !$entity->isNew();
767

768 769 770
    if ($full_save) {
      $shared_table_fields = TRUE;
      $dedicated_table_fields = TRUE;
771 772
    }
    else {
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
      $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;
        }
788
      }
789 790 791 792 793 794 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
    }

    // 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);
        }
825
      }
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
      else {
        $insert_id = $this->database
          ->insert($this->baseTable, array('return' => Database::RETURN_INSERT_ID))
          ->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);
        }
847 848 849
      }
    }

850 851 852 853
    // Update dedicated table records if necessary.
    if ($dedicated_table_fields) {
      $names = is_array($dedicated_table_fields) ? $dedicated_table_fields : [];
      $this->saveToDedicatedTables($entity, $update, $names);
854
    }
855 856 857 858 859 860 861 862 863
  }

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

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

884
    if (!$revision || !$new_revision) {
885 886 887 888 889 890 891 892 893 894 895 896
      $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);
897
      $record = $this->mapToDataStorageRecord($translation, $table_name);
898 899 900 901 902 903 904 905 906 907 908 909
      $values = (array) $record;
      $query
        ->fields(array_keys($values))
        ->values($values);
    }

    $query->execute();
  }

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

923
    $record = new \stdClass();
924 925
    $table_mapping = $this->getTableMapping();
    foreach ($table_mapping->getFieldNames($table_name) as $field_name) {
926

927
      if (empty($this->getFieldStorageDefinitions()[$field_name])) {
928
        throw new EntityStorageException("Table mapping contains invalid field $field_name.");
929
      }
930
      $definition = $this->getFieldStorageDefinitions()[$field_name];
931 932 933 934 935 936 937
      $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
938
        //   https://www.drupal.org/node/2232427.
939
        if (!$definition->getMainPropertyName() && count($columns) == 1) {
940
          $value = ($item = $entity->$field_name->first()) ? $item->getValue() : array();
941
        }
942 943
        else {
          $value = isset($entity->$field_name->$column_name) ? $entity->$field_name->$column_name : NULL;
944
        }
945 946
        if (!empty($definition->getSchema()['columns'][$column_name]['serialize'])) {
          $value = serialize($value);
947
        }
948 949 950 951 952

        // 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);
953
        if (!(empty($value) && $this->isColumnSerial($table_name, $schema_name))) {
954 955
          $record->$schema_name = $value;
        }
956 957 958 959 960 961
      }
    }

    return $record;
  }

962 963 964 965 966 967 968 969 970
  /**
   * 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
971
   *   TRUE if the column is serial, FALSE otherwise.
972
   *
973 974
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processBaseTable()
   * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema::processRevisionTable()
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
   */
  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;
  }

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

  /**
   * Saves an entity revision.
   *
1014
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
1015 1016 1017 1018 1019
   *   The entity object.
   *
   * @return int
   *   The revision id.
   */
1020
  protected function saveRevision(ContentEntityInterface $entity) {
1021
    $record = $this->mapToStorageRecord($entity->getUntranslated(), $this->revisionTable);
1022 1023 1024 1025

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

    if ($entity->isNewRevision()) {
1026 1027 1028 1029
      $insert_id = $this->database
        ->insert($this->revisionTable, array('return' => Database::RETURN_INSERT_ID))
        ->fields((array) $record)
        ->execute();
1030
      // Even if this is a new revision, the revision ID key might have been
1031 1032 1033 1034
      // set in which case we should not override the provided revision ID.
      if (!isset($record->{$this->revisionKey})) {
        $record->{$this->revisionKey} = $insert_id;
      }
1035
      if ($entity->isDefaultRevision()) {
1036
        $this->database->update($this->entityType->getBaseTable())
1037 1038 1039 1040 1041 1042
          ->fields(array($this->revisionKey => $record->{$this->revisionKey}))
          ->condition($this->idKey, $record->{$this->idKey})
          ->execute();
      }
    }
    else {
1043 1044 1045 1046 1047
      $this->database
        ->update($this->revisionTable)
        ->fields((array) $record)
        ->condition($this->revisionKey, $record->{$this->revisionKey})
        ->execute();
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
    }

    // Make sure to update the new revision key for the entity.
    $entity->{$this->revisionKey}->value = $record->{$this->revisionKey};

    return $record->{$this->revisionKey};
  }

  /**
   * {@inheritdoc}
   */
1059
  protected function getQueryServiceName() {
1060 1061 1062 1063
    return 'entity.query.sql';
  }

  /**
1064
   * Loads values of fields stored in dedicated tables for a group of entities.
1065
   *