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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.
   *
   * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
   *   See https://www.drupal.org/node/2274017.
261
   */
262 263 264 265 266 267
  public function setEntityType(EntityTypeInterface $entity_type) {
    if ($this->entityType->id() == $entity_type->id()) {
      $this->entityType = $entity_type;
      $this->initTableLayout();
    }
    else {
268
      throw new EntityStorageException("Unsupported entity type {$entity_type->id()}");
269 270
    }
  }
271

272 273 274 275 276 277 278 279 280 281 282 283 284 285
  /**
   * {@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);
286
      $table_mapping = new DefaultTableMapping($this->entityType, $definitions);
287 288 289

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

      $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
303
      //   https://www.drupal.org/node/2248983.
304 305 306 307 308
      $revision_metadata_fields = array_intersect(array(
        'revision_timestamp',
        'revision_uid',
        'revision_log',
      ), $all_fields);
309 310

      $revisionable = $this->entityType->isRevisionable();
311
      $translatable = $this->entityType->isTranslatable();
312 313
      if (!$revisionable && !$translatable) {
        // The base layout stores all the base field values in the base table.
314
        $table_mapping->setFieldNames($this->baseTable, $all_fields);
315 316 317 318 319 320
      }
      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.
321
        $table_mapping->setFieldNames($this->baseTable, array_diff($all_fields, $revision_metadata_fields));
322
        $revision_key_fields = array($this->idKey, $this->revisionKey);
323
        $table_mapping->setFieldNames($this->revisionTable, array_merge($revision_key_fields, $revisionable_fields));
324 325 326 327 328 329 330 331
      }
      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.
332
        $table_mapping
333
          ->setFieldNames($this->baseTable, $key_fields)
334
          ->setFieldNames($this->dataTable, array_values(array_diff($all_fields, array($this->uuidKey))));
335 336 337 338 339 340 341 342 343
      }
      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.
344
        $table_mapping->setFieldNames($this->baseTable, array_values($key_fields));
345 346 347 348 349

        // 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));
350
        $table_mapping->setFieldNames($this->dataTable, $data_fields);
351 352

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

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

      // 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;
      }
384
    }
385

386
    return $table_mapping;
387 388 389 390 391
  }

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

    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();

419 420 421 422 423 424
    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);
    }

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

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

455
    $values = array();
456
    foreach ($records as $id => $record) {
457
      $values[$id] = array();
458 459 460
      // 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.
461
      foreach ($record as $name => $value) {
462 463 464 465
        // 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);
466
          $values[$id][$field_name][LanguageInterface::LANGCODE_DEFAULT][$property_name] = $value;
467 468 469 470
        }
        else {
          // Handle columns named directly after the field (e.g if the field
          // type only stores one property).
471
          $values[$id][$name][LanguageInterface::LANGCODE_DEFAULT] = $value;
472
        }
473 474
      }
    }
475

476 477 478 479 480 481 482 483 484 485 486 487 488
    // 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]));
    }
489

490 491 492 493
    return $entities;
  }

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

512
      $table_mapping = $this->getTableMapping();
513
      if ($this->revisionDataTable) {
514 515 516 517
        // 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);
518 519 520

        // Find fields that are not revisioned or entity keys. Data fields have
        // the same value regardless of entity revision.
521
        $data_fields = array_diff($table_mapping->getFieldNames($this->dataTable), $fields, $base_fields);
522 523 524 525 526 527
        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);
        }

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

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

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

547 548
        $translations[$id][$langcode] = TRUE;

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

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

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

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

    return $revision;
582 583 584
  }

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

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

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

  /**
   * 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.
626
   * See Drupal\comment\CommentStorage::buildQuery() for an example.
627 628 629 630 631 632 633
   *
   * @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).
   *
634
   * @return \Drupal\Core\Database\Query\Select
635 636 637
   *   A SelectQuery object for loading the entity.
   */
  protected function buildQuery($ids, $revision_id = FALSE) {
638
    $query = $this->database->select($this->entityType->getBaseTable(), 'base');
639

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

    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.
650 651
    $table_mapping = $this->getTableMapping();
    $entity_fields = $table_mapping->getAllColumns($this->baseTable);
652 653 654

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

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

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

    return $query;
  }

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

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

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

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

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

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

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

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

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

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

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

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

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

    // 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);
        }
823
      }
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
      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);
        }
845 846 847
      }
    }

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

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

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

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

    $query->execute();
  }

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

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

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

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

    return $record;
  }

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

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

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

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

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

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

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

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

  /**
1062
   * Loads values of fields stored in dedicated tables for a group of entities.
1063
   *
1064 1065 1066 1067 1068
   * @param array &$values
   *   An array of values keyed by entity ID.
   * @param bool $load_from_revision
   *   (optional) Flag to indicate whether revisions should be loaded or not,
   *   defaults to FALSE.
1069
   */