You are here

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

function db_drop_index in Zircon Profile 8

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

Drops an index.

Parameters

$table: The table to be altered.

$name: The name of the index.

Return value

bool TRUE if the index was successfully dropped, FALSE if there was no index by that name to begin with.

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 dropIndex() on it. E.g. $injected_database->schema()->dropIndex($table, $name);

See also

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

Related topics

Schema API
API to handle database schemas.

File

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

Code

function db_drop_index($table, $name) {
  return Database::getConnection()
    ->schema()
    ->dropIndex($table, $name);
}