W3cubDocs

/Drupal 8

function db_drop_index

db_drop_index($table, $name)

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. For example, $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 952
Core systems for the database layer.

Code

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

© 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/core!includes!database.inc/function/db_drop_index/8.1.x