function SearchHelpSearch::schemaDefinition

Provides the schema definition for the help_search_items table.

File

core/modules/search/modules/search_help/src/Plugin/Search/SearchHelpSearch.php, line 500

Class

SearchHelpSearch

Handles searching for help using the Search module index.

Namespace

Code

protected function schemaDefinition() : array {
  return [
    'description' => 'Stores information about indexed help search items',
    'fields' => [
      'sid' => [
        'description' => 'Numeric index of this item in the search index',
        'type' => 'serial',
        'unsigned' => TRUE,
        'not null' => TRUE,
      ],
      'section_plugin_id' => [
        'description' => 'The help section the item comes from',
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ],
      'permission' => [
        'description' => 'The permission needed to view this item',
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ],
      'topic_id' => [
        'description' => 'The topic ID of the item',
        'type' => 'varchar_ascii',
        'length' => 255,
        'not null' => TRUE,
        'default' => '',
      ],
    ],
    'primary key' => [
      'sid',
    ],
    'indexes' => [
      'section_plugin_id' => [
        'section_plugin_id',
      ],
      'topic_id' => [
        'topic_id',
      ],
    ],
  ];
}