function TermStorageSchema::getEntitySchema

Same name in other branches
  1. 8.9.x core/modules/taxonomy/src/TermStorageSchema.php \Drupal\taxonomy\TermStorageSchema::getEntitySchema()
  2. 10 core/modules/taxonomy/src/TermStorageSchema.php \Drupal\taxonomy\TermStorageSchema::getEntitySchema()
  3. 11.x core/modules/taxonomy/src/TermStorageSchema.php \Drupal\taxonomy\TermStorageSchema::getEntitySchema()

Overrides SqlContentEntityStorageSchema::getEntitySchema

File

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

Class

TermStorageSchema
Defines the term schema handler.

Namespace

Drupal\taxonomy

Code

protected function getEntitySchema(ContentEntityTypeInterface $entity_type, $reset = FALSE) {
    $schema = parent::getEntitySchema($entity_type, $reset);
    if ($data_table = $this->storage
        ->getDataTable()) {
        $schema[$data_table]['indexes'] += [
            'taxonomy_term__tree' => [
                'vid',
                'weight',
                'name',
            ],
            'taxonomy_term__vid_name' => [
                'vid',
                'name',
            ],
        ];
    }
    $schema['taxonomy_index'] = [
        'description' => 'Maintains denormalized information about node/term relationships.',
        'fields' => [
            'nid' => [
                'description' => 'The {node}.nid this record tracks.',
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'default' => 0,
            ],
            'tid' => [
                'description' => 'The term ID.',
                'type' => 'int',
                'unsigned' => TRUE,
                'not null' => TRUE,
                'default' => 0,
            ],
            'status' => [
                'description' => 'Boolean indicating whether the node is published (visible to non-administrators).',
                'type' => 'int',
                'not null' => TRUE,
                'default' => 1,
            ],
            'sticky' => [
                'description' => 'Boolean indicating whether the node is sticky.',
                'type' => 'int',
                'not null' => FALSE,
                'default' => 0,
                'size' => 'tiny',
            ],
            'created' => [
                'description' => 'The Unix timestamp when the node was created.',
                'type' => 'int',
                'not null' => TRUE,
                'default' => 0,
            ],
        ],
        'primary key' => [
            'nid',
            'tid',
        ],
        'indexes' => [
            'term_node' => [
                'tid',
                'status',
                'sticky',
                'created',
            ],
        ],
        'foreign keys' => [
            'tracked_node' => [
                'table' => 'node',
                'columns' => [
                    'nid' => 'nid',
                ],
            ],
            'term' => [
                'table' => 'taxonomy_term_data',
                'columns' => [
                    'tid' => 'tid',
                ],
            ],
        ],
    ];
    return $schema;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.