You are here

Home » API reference » Zircon Profile 8 » database.inc

function db_add_index in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/includes/database.inc \db_add_index()

Adds an index.

Parameters

$table: The table to be altered.

$name: The name of the index.

array $fields: An array of field names.

array $spec: The table specification of the table to be altered, as taken from a schema definition. See \Drupal\Core\Database\Schema::addIndex() for how to obtain this specification.

Deprecated

as of Drupal 8.0.x, will be removed in Drupal 9.0.0. Instead, get a database connection injected into your service from the container, get its schema driver, and call addIndex() on it. E.g. $injected_database->schema()->addIndex($table, $name, $fields, $spec);

See also

hook_schema()

Schema API

\Drupal\Core\Database\Schema::addIndex()

Related topics

Schema API
API to handle database schemas.
2 calls to db_add_index()
SchemaTest::testSchema in core/modules/system/src/Tests/Database/SchemaTest.php
Tests database interactions.
update_test_schema.install in core/modules/system/tests/modules/update_test_schema/update_test_schema.install
Update hooks and schema definition for the update_test_schema module.

File

core/includes/database.inc, line 921
Core systems for the database layer.

Code

function db_add_index($table, $name, $fields, array $spec) {
  return Database::getConnection()
    ->schema()
    ->addIndex($table, $name, $fields, $spec);
}