function DatabaseStorage::schemaDefinition

Defines the schema for the key_value table.

File

core/lib/Drupal/Core/KeyValueStore/DatabaseStorage.php, line 293

Class

DatabaseStorage

Defines a default key/value store implementation.

Namespace

Code

public static function schemaDefinition() {
    return [
        'description' => 'Generic key-value storage table. See the state system for an example.',
        'fields' => [
            'collection' => [
                'description' => 'A named collection of key and value pairs.',
                'type' => 'varchar_ascii',
                'length' => 128,
                'not null' => TRUE,
                'default' => '',
            ],
            'name' => [
                'description' => 'The key of the key-value pair. As KEY is a SQL reserved keyword, name was chosen instead.',
                'type' => 'varchar_ascii',
                'length' => 128,
                'not null' => TRUE,
                'default' => '',
            ],
            'value' => [
                'description' => 'The value.',
                'type' => 'blob',
                'not null' => TRUE,
                'size' => 'big',
            ],
        ],
        'primary key' => [
            'collection',
            'name',
        ],
    ];
}