function BatchStorage::schemaDefinition

Defines the schema for the batch table.

@internal

File

core/lib/Drupal/Core/Batch/BatchStorage.php, line 212

Class

BatchStorage

Defines the storage handler class for batches.

Namespace

Code

public function schemaDefinition() : Schema {
  $tables[] = new Table(name: static::TABLE_NAME, description: 'Stores details about batches (processes that run in multiple HTTP requests).', columns: [
    Column::serial(name: 'bid', description: 'Primary Key: Unique batch ID.'),
    Column::varcharAscii(name: 'token', description: "A string token generated against the current user's session id and the batch id, used to ensure that only the user who submitted the batch can effectively access it.", length: 64, notNull: TRUE),
    Column::int(name: 'timestamp', description: 'A Unix timestamp indicating when this batch was submitted for processing. Stale batches are purged at cron time.', notNull: TRUE),
    Column::blob(name: 'batch', description: 'A serialized array containing the processing data for the batch.', size: ColumnSize::Big, notNull: FALSE),
  ], primaryKey: new PrimaryKey([
    'bid',
  ]), indexes: [
    new Index(name: 'token', columns: [
      'token',
    ]),
  ]);
  return new Schema(type: SchemaDefinitionType::Storage, name: 'batch', tables: $tables);
}