Defines a schema handler that supports revisionable, translatable entities.
Entity types may extend this class and optimize the generated schema for all entity base tables by overriding getEntitySchema() for cross-field optimizations and getSharedTableFieldSchema() for optimizations applying to a single field.
Hierarchy
- class \Drupal\Core\Entity\Sql\SqlContentEntityStorageSchema implements DynamicallyFieldableEntityStorageSchemaInterface uses DependencySerializationTrait
File
- core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorageSchema.php, line 26
Namespace
Drupal\Core\Entity\Sql
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| SqlContentEntityStorageSchema::$database | protected | property | The database connection to be used. |
| SqlContentEntityStorageSchema::$entityManager | protected | property | The entity manager. |
| SqlContentEntityStorageSchema::$entityType | protected | property | The entity type this schema builder is responsible for. |
| SqlContentEntityStorageSchema::$fieldStorageDefinitions | protected | property | The storage field definitions for this entity type. |
| SqlContentEntityStorageSchema::$installedStorageSchema | protected | property | The key-value collection for tracking installed storage schema. |
| SqlContentEntityStorageSchema::$originalDefinitions | protected | property | The original storage field definitions for this entity type. Used during field schema updates. |
| SqlContentEntityStorageSchema::$schema | protected | property | A static cache of the generated schema array. |
| SqlContentEntityStorageSchema::$storage | protected | property | The storage object for the given entity type. |
| SqlContentEntityStorageSchema::addIndex | protected | function | Creates an index, dropping it if already existing. |
| SqlContentEntityStorageSchema::addSharedTableFieldForeignKey | protected | function | Adds a foreign key for the specified field to the given schema definition. |
| SqlContentEntityStorageSchema::addSharedTableFieldIndex | protected | function | Adds an index for the specified field to the given schema definition. |
| SqlContentEntityStorageSchema::addSharedTableFieldUniqueKey | protected | function | Adds a unique key for the specified field to the given schema definition. |
| SqlContentEntityStorageSchema::addTableDefaults | protected | function | Adds defaults to a table schema definition. |
| SqlContentEntityStorageSchema::addUniqueKey | protected | function | Creates a unique key, dropping it if already existing. |
| SqlContentEntityStorageSchema::checkEntityType | protected | function | Checks that we are dealing with the correct entity type. |
| SqlContentEntityStorageSchema::createDedicatedTableSchema | protected | function | Creates the schema for a field stored in a dedicated table. |
| SqlContentEntityStorageSchema::createEntitySchemaIndexes | protected | function | Creates the specified entity schema indexes and keys. |
| SqlContentEntityStorageSchema::createSharedTableSchema | protected | function | Creates the schema for a field stored in a shared table. |
| SqlContentEntityStorageSchema::deleteDedicatedTableSchema | protected | function | Deletes the schema for a field stored in a dedicated table. |
| SqlContentEntityStorageSchema::deleteEntitySchemaData | protected | function | Deletes schema data for the given entity type definition. |
| SqlContentEntityStorageSchema::deleteEntitySchemaIndexes | protected | function | Deletes the specified entity schema indexes and keys. |
| SqlContentEntityStorageSchema::deleteFieldSchemaData | protected | function | Deletes schema data for the given field storage definition. |
| SqlContentEntityStorageSchema::deleteSharedTableSchema | protected | function | Deletes the schema for a field stored in a shared table. |
| SqlContentEntityStorageSchema::finalizePurge | public | function | Performs final cleanup after all data of a field has been purged. Overrides DynamicallyFieldableEntityStorageSchemaInterface::finalizePurge |
| SqlContentEntityStorageSchema::getColumnSchemaRelevantKeys | protected | function | Returns a list of column schema keys affecting data storage. |
| SqlContentEntityStorageSchema::getDedicatedTableSchema | protected | function | Gets the SQL schema for a dedicated table. |
| SqlContentEntityStorageSchema::getEntityIndexName | protected | function | Gets the name to be used for the given entity index. |
| SqlContentEntityStorageSchema::getEntitySchema | protected | function | Gets the entity schema for the specified entity type. |
| SqlContentEntityStorageSchema::getEntitySchemaData | protected | function | Gets entity schema definitions for index and key definitions. |
| SqlContentEntityStorageSchema::getEntitySchemaTables | protected | function | Gets a list of entity type tables. |
| SqlContentEntityStorageSchema::getFieldForeignKeys | protected | function | Gets field foreign keys. |
| SqlContentEntityStorageSchema::getFieldIndexes | protected | function | Gets an index schema array for a given field. |
| SqlContentEntityStorageSchema::getFieldIndexName | protected | function | Generates an index name for a field data table. |
| SqlContentEntityStorageSchema::getFieldSchemaData | protected | function | Gets field schema data for the given key. |
| SqlContentEntityStorageSchema::getFieldSchemaIdentifierName | protected | function | Generates a safe schema identifier (name of an index, column name etc.). |
| SqlContentEntityStorageSchema::getFieldUniqueKeys | protected | function | Gets a unique key schema array for a given field. |
| SqlContentEntityStorageSchema::getSchemaFromStorageDefinition | protected | function | Gets the schema data for the given field storage definition. |
| SqlContentEntityStorageSchema::getSharedTableFieldSchema | protected | function | Gets the schema for a single field definition. |
| SqlContentEntityStorageSchema::hasColumnChanges | protected | function | Compares schemas to check for changes in the column definitions. |
| SqlContentEntityStorageSchema::hasNullFieldPropertyData | protected | function | Checks whether a field property has NULL values. |
| SqlContentEntityStorageSchema::hasSharedTableNameChanges | protected | function | Detects whether any table name got renamed in an entity type update. |
| SqlContentEntityStorageSchema::hasSharedTableStructureChange | protected | function | Detects whether there is a change in the shared table structure. |
| SqlContentEntityStorageSchema::initializeBaseTable | protected | function | Initializes common information for a base table. |
| SqlContentEntityStorageSchema::initializeDataTable | protected | function | Initializes common information for a data table. |
| SqlContentEntityStorageSchema::initializeRevisionDataTable | protected | function | Initializes common information for a revision data table. |
| SqlContentEntityStorageSchema::initializeRevisionTable | protected | function | Initializes common information for a revision table. |
| SqlContentEntityStorageSchema::installedStorageSchema | protected | function | Gets the keyvalue collection for tracking the installed schema. |
| SqlContentEntityStorageSchema::isTableEmpty | protected | function | Checks whether a database table is non-existent or empty. |
| SqlContentEntityStorageSchema::loadEntitySchemaData | protected | function | Loads stored schema data for the given entity type definition. |
| SqlContentEntityStorageSchema::loadFieldSchemaData | protected | function | Loads stored schema data for the given field storage definition. |
| SqlContentEntityStorageSchema::onEntityTypeCreate | public | function | Reacts to the creation of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeCreate |
| SqlContentEntityStorageSchema::onEntityTypeDelete | public | function | Reacts to the deletion of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeDelete |
| SqlContentEntityStorageSchema::onEntityTypeUpdate | public | function | Reacts to the update of the entity type. Overrides EntityTypeListenerInterface::onEntityTypeUpdate |
| SqlContentEntityStorageSchema::onFieldStorageDefinitionCreate | public | function | Reacts to the creation of a field storage definition. Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionCreate |
| SqlContentEntityStorageSchema::onFieldStorageDefinitionDelete | public | function | Reacts to the deletion of a field storage definition. Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionDelete |
| SqlContentEntityStorageSchema::onFieldStorageDefinitionUpdate | public | function | Reacts to the update of a field storage definition. Overrides FieldStorageDefinitionListenerInterface::onFieldStorageDefinitionUpdate |
| SqlContentEntityStorageSchema::performFieldSchemaOperation | protected | function | Performs the specified operation on a field. |
| SqlContentEntityStorageSchema::processBaseTable | protected | function | Processes the gathered schema for a base table. |
| SqlContentEntityStorageSchema::processDataTable | protected | function | Processes the gathered schema for a base table. |
| SqlContentEntityStorageSchema::processIdentifierSchema | protected | function | Processes the specified entity key. |
| SqlContentEntityStorageSchema::processRevisionDataTable | protected | function | Processes the gathered schema for a base table. |
| SqlContentEntityStorageSchema::processRevisionTable | protected | function | Processes the gathered schema for a base table. |
| SqlContentEntityStorageSchema::requiresEntityDataMigration | public | function | Checks if existing data would be lost if the schema changes were applied. Overrides EntityStorageSchemaInterface::requiresEntityDataMigration |
| SqlContentEntityStorageSchema::requiresEntityStorageSchemaChanges | public | function | Checks if the changes to the entity type requires storage schema changes. Overrides EntityStorageSchemaInterface::requiresEntityStorageSchemaChanges |
| SqlContentEntityStorageSchema::requiresFieldDataMigration | public | function | Checks if existing data would be lost if the schema changes were applied. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldDataMigration |
| SqlContentEntityStorageSchema::requiresFieldStorageSchemaChanges | public | function | Checks if the changes to the storage definition requires schema changes. Overrides DynamicallyFieldableEntityStorageSchemaInterface::requiresFieldStorageSchemaChanges |
| SqlContentEntityStorageSchema::saveEntitySchemaData | protected | function | Stores schema data for the given entity type definition. |
| SqlContentEntityStorageSchema::saveFieldSchemaData | protected | function | Stores schema data for the given field storage definition. |
| SqlContentEntityStorageSchema::updateDedicatedTableSchema | protected | function | Updates the schema for a field stored in a shared table. |
| SqlContentEntityStorageSchema::updateSharedTableSchema | protected | function | Updates the schema for a field stored in a shared table. |
| SqlContentEntityStorageSchema::__construct | public | function | Constructs a SqlContentEntityStorageSchema. |
Please login to continue.