public function DatabaseSchema_mysql::addIndex

public DatabaseSchema_mysql::addIndex($table, $name, $fields)

Add an index.

Parameters

$table: The table to be altered.

$name: The name of the index.

$fields: An array of field names.

Throws

DatabaseSchemaObjectDoesNotExistException If the specified table doesn't exist.

DatabaseSchemaObjectExistsException If the specified table already has an index by that name.

Overrides DatabaseSchema::addIndex

File

includes/database/mysql/schema.inc, line 440

Database schema code for MySQL database servers.

Class

DatabaseSchema_mysql

Code

public function addIndex($table, $name, $fields) {
  if (!$this->tableExists($table)) {
    throw new DatabaseSchemaObjectDoesNotExistException(t("Cannot add index @name to table @table: table doesn't exist.", array('@table' => $table, '@name' => $name)));
  }
  if ($this->indexExists($table, $name)) {
    throw new DatabaseSchemaObjectExistsException(t("Cannot add index @name to table @table: index already exists.", array('@table' => $table, '@name' => $name)));
  }

  $this->connection->query('ALTER TABLE {' . $table . '} ADD INDEX `' . $name . '` (' . $this->createKeySql($fields) . ')');
}