function help_topics_schema in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/help_topics/help_topics.install \help_topics_schema()

Implements hook_schema().

File

core/modules/help_topics/help_topics.install, line 11

Install and uninstall functions for help_topics module.

Code

function help_topics_schema() {
  $schema['help_search_items'] = [
    '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',
      ],
    ],
  ];
  return $schema;
}