function DatabaseLockBackend::schemaDefinition

Defines the schema for the semaphore table.

@internal

File

core/lib/Drupal/Core/Lock/DatabaseLockBackend.php, line 245

Class

DatabaseLockBackend

Defines the database lock backend. This is the default backend in Drupal.

Namespace

Code

public function schemaDefinition() {
    return [
        'description' => 'Table for holding semaphores, locks, flags, etc. that cannot be stored as state since they must not be cached.',
        'fields' => [
            'name' => [
                'description' => 'Primary Key: Unique name.',
                'type' => 'varchar_ascii',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
            ],
            'value' => [
                'description' => 'A value for the semaphore.',
                'type' => 'varchar_ascii',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
            ],
            'expire' => [
                'description' => 'A Unix timestamp with microseconds indicating when the semaphore should expire.',
                'type' => 'float',
                'size' => 'big',
                'not null' => TRUE,
            ],
        ],
        'indexes' => [
            'value' => [
                'value',
            ],
            'expire' => [
                'expire',
            ],
        ],
        'primary key' => [
            'name',
        ],
    ];
}