You are here

public function Schema::addPrimaryKey in Drupal 10

Same name in this branch
  1. 10 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::addPrimaryKey()
  2. 10 core/modules/sqlite/src/Driver/Database/sqlite/Schema.php \Drupal\sqlite\Driver\Database\sqlite\Schema::addPrimaryKey()
  3. 10 core/modules/pgsql/src/Driver/Database/pgsql/Schema.php \Drupal\pgsql\Driver\Database\pgsql\Schema::addPrimaryKey()
  4. 10 core/modules/mysql/src/Driver/Database/mysql/Schema.php \Drupal\mysql\Driver\Database\mysql\Schema::addPrimaryKey()
  5. 10 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Schema.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Schema::addPrimaryKey()

Add a primary key.

Parameters

$table: The table to be altered.

$fields: Fields for the primary key.

Throws

\Drupal\Core\Database\SchemaObjectDoesNotExistException If the specified table doesn't exist.

\Drupal\Core\Database\SchemaObjectExistsException If the specified table already has a primary key.

Overrides Schema::addPrimaryKey

File

core/modules/sqlite/src/Driver/Database/sqlite/Schema.php, line 756

Class

Schema
SQLite implementation of \Drupal\Core\Database\Schema.

Namespace

Drupal\sqlite\Driver\Database\sqlite

Code

public function addPrimaryKey($table, $fields) {
  if (!$this
    ->tableExists($table)) {
    throw new SchemaObjectDoesNotExistException("Cannot add primary key to table '{$table}': table doesn't exist.");
  }
  $old_schema = $this
    ->introspectSchema($table);
  $new_schema = $old_schema;
  if (!empty($new_schema['primary key'])) {
    throw new SchemaObjectExistsException("Cannot add primary key to table '{$table}': primary key already exists.");
  }
  $new_schema['primary key'] = $fields;
  $this
    ->ensureNotNullPrimaryKey($new_schema['primary key'], $new_schema['fields']);
  $this
    ->alterTable($table, $old_schema, $new_schema);
}