TermStorageSchema::getSharedTableFieldSchema

protected TermStorageSchema::getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping)

Gets the schema for a single field definition.

Entity types may override this method in order to optimize the generated schema for given field. While all optimizations that apply to a single field have to be added here, all cross-field optimizations should be via SqlContentEntityStorageSchema::getEntitySchema() instead; e.g., an index spanning multiple fields.

Parameters

\Drupal\Core\Field\FieldStorageDefinitionInterface $storage_definition: The storage definition of the field whose schema has to be returned.

string $table_name: The name of the table columns will be added to.

string[] $column_mapping: A mapping of field column names to database column names.

Return value

array The schema definition for the table with the following keys:

• fields: The schema definition for the each field columns.
• indexes: The schema definition for the indexes.
• unique keys: The schema definition for the unique keys.
• foreign keys: The schema definition for the foreign keys.

Throws

\Drupal\Core\Field\FieldException Exception thrown if the schema contains reserved column names.

Overrides SqlContentEntityStorageSchema::getSharedTableFieldSchema

File

core/modules/taxonomy/src/TermStorageSchema.php, line 114

Class

TermStorageSchema

Defines the term schema handler.

Namespace

Drupal\taxonomy

Code

protected function getSharedTableFieldSchema(FieldStorageDefinitionInterface $storage_definition, $table_name, array $column_mapping) {
  $schema = parent::getSharedTableFieldSchema($storage_definition, $table_name, $column_mapping);
  $field_name = $storage_definition->getName();

  if ($table_name == 'taxonomy_term_field_data') {
    // Remove unneeded indexes.
    unset($schema['indexes']['taxonomy_term_field__vid__target_id']);
    unset($schema['indexes']['taxonomy_term_field__description__format']);

    switch ($field_name) {
      case 'weight':
        // Improves the performance of the taxonomy_term__tree index defined
        // in getEntitySchema().
        $schema['fields'][$field_name]['not null'] = TRUE;
        break;

      case 'name':
        $this->addSharedTableFieldIndex($storage_definition, $schema, TRUE);
        break;
    }
  }

  return $schema;
}