You are here

public function Schema::addUniqueKey in Drupal 9

Same name in this branch
  1. 9 core/lib/Drupal/Core/Database/Schema.php \Drupal\Core\Database\Schema::addUniqueKey()
  2. 9 core/lib/Drupal/Core/Database/Driver/sqlite/Schema.php \Drupal\Core\Database\Driver\sqlite\Schema::addUniqueKey()
  3. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Schema.php \Drupal\Core\Database\Driver\pgsql\Schema::addUniqueKey()
  4. 9 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::addUniqueKey()
  5. 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Schema.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Schema::addUniqueKey()
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Driver/mysql/Schema.php \Drupal\Core\Database\Driver\mysql\Schema::addUniqueKey()

Add a unique key.

Parameters

$table: The table to be altered.

$name: The name of the key.

$fields: An array of field names.

Throws

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

\Drupal\Core\Database\SchemaObjectExistsException If the specified table already has a key by that name.

Overrides Schema::addUniqueKey

File

core/lib/Drupal/Core/Database/Driver/mysql/Schema.php, line 536

Class

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

Namespace

Drupal\Core\Database\Driver\mysql

Code

public function addUniqueKey($table, $name, $fields) {
  if (!$this
    ->tableExists($table)) {
    throw new SchemaObjectDoesNotExistException("Cannot add unique key '{$name}' to table '{$table}': table doesn't exist.");
  }
  if ($this
    ->indexExists($table, $name)) {
    throw new SchemaObjectExistsException("Cannot add unique key '{$name}' to table '{$table}': unique key already exists.");
  }
  $this->connection
    ->query('ALTER TABLE {' . $table . '} ADD UNIQUE KEY `' . $name . '` (' . $this
    ->createKeySql($fields) . ')');
}