You are here

function db_drop_unique_key in Drupal 8

Same name and namespace in other branches
  1. 6 includes/database.mysql-common.inc \db_drop_unique_key()
  2. 6 includes/database.pgsql.inc \db_drop_unique_key()
  3. 7 includes/database/database.inc \db_drop_unique_key()

Drops a unique key.

Parameters

$table: The table to be altered.

$name: The name of the key.

Return value

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

Deprecated

in drupal:8.0.0 and is removed from drupal:9.0.0. Instead, get a database connection injected into your service from the container, get its schema driver, and call dropUniqueKey() on it. For example, $injected_database->schema()->dropUniqueKey($table, $name);

See also

https://www.drupal.org/node/2993033

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

Related topics

1 call to db_drop_unique_key()
DatabaseLegacyTest::testDbDropUniqueKey in core/tests/Drupal/KernelTests/Core/Database/DatabaseLegacyTest.php
Tests deprecation of the db_drop_unique_key() function.

File

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

Code

function db_drop_unique_key($table, $name) {
  @trigger_error('db_drop_unique_key() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Instead, get a database connection injected into your service from the container, get its schema driver, and call dropUniqueKey() on it. For example, $injected_database->schema()->dropUniqueKey($table, $name). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
  return Database::getConnection()
    ->schema()
    ->dropUniqueKey($table, $name);
}