Error message

You are browsing documentation for drupal 7.x, which is not supported anymore. Read the updated version of this page for drupal 11.x (the latest version).

function DatabaseSchema_mysql::addIndex

Add an index.

Parameters

$table: The table to be altered.

$name: The name of the index.

$fields: An array of field names.

Overrides DatabaseSchema::addIndex

File

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

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) . ')');
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.