W3cubDocs

/Drupal 8

public function Schema::addPrimaryKey

public Schema::addPrimaryKey($table, $fields)

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/lib/Drupal/Core/Database/Driver/mysql/Schema.php, line 452

Class

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

Namespace

Drupal\Core\Database\Driver\mysql

Code

public function addPrimaryKey($table, $fields) {
  if (!$this->tableExists($table)) {
    throw new SchemaObjectDoesNotExistException(t("Cannot add primary key to table @table: table doesn't exist.", array('@table' => $table)));
  }
  if ($this->indexExists($table, 'PRIMARY')) {
    throw new SchemaObjectExistsException(t("Cannot add primary key to table @table: primary key already exists.", array('@table' => $table)));
  }

  $this->connection->query('ALTER TABLE {' . $table . '} ADD PRIMARY KEY (' . $this->createKeySql($fields) . ')');
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Database!Driver!mysql!Schema.php/function/Schema::addPrimaryKey/8.1.x