public function DatabaseSchema_mysql::addPrimaryKey

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

Add a primary key.

Parameters

$table: The table to be altered.

$fields: Fields for the primary key.

Throws

DatabaseSchemaObjectDoesNotExistException If the specified table doesn't exist.

DatabaseSchemaObjectExistsException If the specified table already has a primary key.

Overrides DatabaseSchema::addPrimaryKey

File

includes/database/mysql/schema.inc, line 400
Database schema code for MySQL database servers.

Class

DatabaseSchema_mysql

Code

public function addPrimaryKey($table, $fields) {
  if (!$this->tableExists($table)) {
    throw new DatabaseSchemaObjectDoesNotExistException(t("Cannot add primary key to table @table: table doesn't exist.", array('@table' => $table)));
  }
  if ($this->indexExists($table, 'PRIMARY')) {
    throw new DatabaseSchemaObjectExistsException(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/includes!database!mysql!schema.inc/function/DatabaseSchema_mysql::addPrimaryKey/7.x