database.inc
Same filename in other branches
Core systems for the database layer.
Classes required for basic functioning of the database system should be placed in this file. All utility functions should also be placed in this file only, as they cannot auto-load the way classes can.
File
-
core/
includes/ database.inc
View source
<?php
/**
* @file
* Core systems for the database layer.
*
* Classes required for basic functioning of the database system should be
* placed in this file. All utility functions should also be placed in this
* file only, as they cannot auto-load the way classes can.
*/
use Drupal\Core\Database\Database;
use Drupal\Core\Database\Query\Condition;
/**
* @addtogroup database
* @{
*/
/**
* Executes an arbitrary query string against the active database.
*
* Use this function for SELECT queries if it is just a simple query string.
* If the caller or other modules need to change the query, use
* \Drupal::database()->select() instead.
*
* Do not use this function for INSERT, UPDATE, or DELETE queries. Those should
* be handled via \Drupal::database()->insert(), \Drupal::database()->update(),
* \Drupal::database()->merge()and \Drupal::database()->delete().
*
* @param string|\Drupal\Core\Database\StatementInterface $query
* The prepared statement query to run. Although it will accept both named and
* unnamed placeholders, named placeholders are strongly preferred as they are
* more self-documenting. If the argument corresponding to a placeholder is
* an array of values to be expanded (for example, with an IN query), the
* placeholder should be named with a trailing bracket like :example[].
* @param array $args
* An array of values to substitute into the query. If the query uses named
* placeholders, this is an associative array in any order. If the query uses
* unnamed placeholders (?), this is an indexed array and the order must match
* the order of placeholders in the query string.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement object, already executed.
*
* @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
* and call query() on it. For example,
* $injected_database->query($query, $args, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::query()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_query($query, array $args = [], array $options = []) {
@trigger_error('db_query() is deprecated in drupal:8.0.0. It will be removed before drupal:9.0.0. Instead, get a database connection injected into your service from the container and call query() on it. For example, $injected_database->query($query, $args, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options))->query($query, $args, $options);
}
/**
* Executes a query against the active database, restricted to a range.
*
* @param string $query
* The prepared statement query to run. Although it will accept both named and
* unnamed placeholders, named placeholders are strongly preferred as they are
* more self-documenting.
* @param $from
* The first record from the result set to return.
* @param $count
* The number of records to return from the result set.
* @param array $args
* An array of values to substitute into the query. If the query uses named
* placeholders, this is an associative array in any order. If the query uses
* unnamed placeholders (?), this is an indexed array and the order must match
* the order of placeholders in the query string.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\StatementInterface
* A prepared statement object, already executed.
*
* @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
* and call queryRange() on it. For example,
* $injected_database->queryRange($query, $from, $count, $args, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::queryRange()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_query_range($query, $from, $count, array $args = [], array $options = []) {
@trigger_error('db_query_range() 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 and call queryRange() on it. For example, $injected_database->queryRange($query, $from, $count, $args, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options))->queryRange($query, $from, $count, $args, $options);
}
/**
* Executes a SELECT query string and saves the result set to a temporary table.
*
* The execution of the query string happens against the active database.
*
* @param string $query
* The prepared SELECT statement query to run. Although it will accept both
* named and unnamed placeholders, named placeholders are strongly preferred
* as they are more self-documenting.
* @param array $args
* An array of values to substitute into the query. If the query uses named
* placeholders, this is an associative array in any order. If the query uses
* unnamed placeholders (?), this is an indexed array and the order must match
* the order of placeholders in the query string.
* @param array $options
* An array of options to control how the query operates.
*
* @return string
* The name of the temporary table.
*
* @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
* and call queryTemporary() on it. For example,
* $injected_database->queryTemporary($query, $args, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::queryTemporary()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_query_temporary($query, array $args = [], array $options = []) {
@trigger_error('db_query_temporary() 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 and call queryTemporary() on it. For example, $injected_database->queryTemporary($query, $args, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options))->queryTemporary($query, $args, $options);
}
/**
* Returns a new InsertQuery object for the active database.
*
* @param string $table
* The table into which to insert.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\Query\Insert
* A new Insert object for this connection.
*
* @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 and
* call insert() on it. For example,
* $injected_database->insert($table, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::insert()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_insert($table, array $options = []) {
@trigger_error('db_insert() 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 and call insert() on it. For example, $injected_database->insert($table, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options, FALSE))->insert($table, $options);
}
/**
* Returns a new MergeQuery object for the active database.
*
* @param string $table
* Name of the table to associate with this query.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\Query\Merge
* A new Merge object for this connection.
*
* @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 and
* call merge() on it. For example,
* $injected_database->merge($table, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::merge()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_merge($table, array $options = []) {
@trigger_error('db_merge() 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 and call merge() on it. For example, $injected_database->merge($table, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options, FALSE))->merge($table, $options);
}
/**
* Returns a new UpdateQuery object for the active database.
*
* @param string $table
* The table to update.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\Query\Update
* A new Update object for this connection.
*
* @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 and
* call update() on it. For example,
* $injected_database->update($table, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::update()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_update($table, array $options = []) {
@trigger_error('db_update() 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 and call call update() on it. For example, $injected_database->update($table, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options, FALSE))->update($table, $options);
}
/**
* Returns a new DeleteQuery object for the active database.
*
* @param string $table
* The table from which to delete.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\Query\Delete
* A new Delete object for this connection.
*
* @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 and
* call delete() on it. For example,
* $injected_database->delete($table, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::delete()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_delete($table, array $options = []) {
@trigger_error('db_delete 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 and call delete() on it. For example, $injected_database->delete($table, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options, FALSE))->delete($table, $options);
}
/**
* Returns a new TruncateQuery object for the active database.
*
* @param string $table
* The table from which to truncate.
* @param array $options
* An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\Query\Truncate
* A new Truncate object for this connection.
*
* @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 and
* call truncate() on it. For example,
* $injected_database->truncate($table, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::truncate()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_truncate($table, array $options = []) {
@trigger_error('db_truncate() 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 and call truncate() on it. For example, $injected_database->truncate($table, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options, FALSE))->truncate($table, $options);
}
/**
* Returns a new SelectQuery object for the active database.
*
* @param string|\Drupal\Core\Database\Query\SelectInterface $table
* The base table for this query. May be a string or another SelectInterface
* object. If a SelectInterface object is passed, it will be used as a
* subselect.
* @param string $alias
* (optional) The alias for the base table of this query.
* @param array $options
* (optional) An array of options to control how the query operates.
*
* @return \Drupal\Core\Database\Query\Select
* A new Select object for this connection.
*
* @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 and
* call select() on it. For example,
* $injected_database->select($table, $alias, $options);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::select()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_select($table, $alias = NULL, array $options = []) {
@trigger_error('db_select() 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 and call select() on it. For example, $injected_database->db_select($table, $alias, $options). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options))->select($table, $alias, $options);
}
/**
* Returns a new transaction object for the active database.
*
* @param string $name
* Optional name of the transaction.
* @param array $options
* An array of options to control how the transaction operates:
* - target: The database target name.
*
* @return \Drupal\Core\Database\Transaction
* A new Transaction object for this connection.
*
* @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 and
* call startTransaction() on it. For example,
* $injected_database->startTransaction($name);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::startTransaction()
* @see \Drupal\Core\Database\Connection::defaultOptions()
*/
function db_transaction($name = NULL, array $options = []) {
@trigger_error('db_transaction 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 and call startTransaction() on it. For example, $injected_database->startTransaction($name). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection(_db_get_target($options))->startTransaction($name);
}
/**
* Sets a new active database.
*
* @param $key
* The key in the $databases array to set as the default database.
*
* @return string|null
* The key of the formerly active database.
*
* @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Use
* \Drupal\Core\Database\Database::setActiveConnection().
*
* @see https://www.drupal.org/node/2993033
*/
function db_set_active($key = 'default') {
@trigger_error('db_set_active() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Use \\Drupal\\Core\\Database\\Database::setActiveConnection() instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::setActiveConnection($key);
}
/**
* Restricts a dynamic table name to safe characters.
*
* Only keeps alphanumeric and underscores.
*
* @param $table
* The table name to escape.
*
* @return string
* The escaped table name as a string.
*
* @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
* and call escapeTable() on it. For example,
* $injected_database->escapeTable($table);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::escapeTable()
*/
function db_escape_table($table) {
@trigger_error('db_escape_table() 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 and call escapeTable() on it. For example, $injected_database->escapeTable($table). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->escapeTable($table);
}
/**
* Restricts a dynamic column or constraint name to safe characters.
*
* Only keeps alphanumeric and underscores.
*
* @param string $field
* The field name to escape.
*
* @return string
* The escaped field name as a string.
*
* @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
* and call escapeField() on it. For example,
* $injected_database->escapeField($field);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::escapeField()
*/
function db_escape_field($field) {
@trigger_error('db_escape_field() 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 and call escapeField() on it. For example, $injected_database->escapeField($field). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->escapeField($field);
}
/**
* Escapes characters that work as wildcard characters in a LIKE pattern.
*
* The wildcard characters "%" and "_" as well as backslash are prefixed with
* a backslash. Use this to do a search for a verbatim string without any
* wildcard behavior.
*
* You must use a query builder like \Drupal::database()->select() in order to
* use \Drupal::database()->escapeLike() on all supported database systems. Using
* \Drupal::database()->escapeLike() with \Drupal::database()->query() or
* \Drupal::database()->queryRange() is not supported.
*
* For example, the following does a case-insensitive query for all rows whose
* name starts with $prefix:
* @code
* $result = \Drupal::database()->select('person', 'p')
* ->fields('p')
* ->condition('name', db_like($prefix) . '%', 'LIKE')
* ->execute()
* ->fetchAll();
* @endcode
*
* Backslash is defined as escape character for LIKE patterns in
* DatabaseCondition::mapConditionOperator().
*
* @param string $string
* The string to escape.
*
* @return string
* The escaped string.
*
* @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
* and call escapeLike() on it. For example,
* $injected_database->escapeLike($string);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::escapeLike()
*/
function db_like($string) {
@trigger_error('db_like() 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 and call escapeLike() on it. For example, $injected_database->escapeLike($string). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->escapeLike($string);
}
/**
* Retrieves the name of the currently active database driver.
*
* @return string
* The name of the currently active database driver.
*
* @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
* and call driver() on it. For example, $injected_database->driver($string);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::driver()
*/
function db_driver() {
@trigger_error('db_driver() 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 and call driver() on it. For example, $injected_database->driver($string). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->driver();
}
/**
* Closes the active database connection.
*
* @param array $options
* An array of options to control which connection is closed. Only the target
* key has any meaning in this case.
*
* @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Use
* \Drupal\Core\Database\Database::closeConnection($target).
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Database::closeConnection()
*/
function db_close(array $options = []) {
@trigger_error('db_close() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Use \\Drupal\\Core\\Database\\Database::closeConnection() instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
Database::closeConnection(_db_get_target($options));
}
/**
* Get target helper.
*
* Helps get "target" database from the query options.
*
* @param array $options
* An array of options to control how the query operates. The array is passed
* by reference, and its 'target' key is removed from it during the process,
* so that it will not leak in calls to methods in the Database class.
* @param bool $allow_replica
* (Optional) When false, 'replica' connection will be redirected to the
* 'default' one. Defaults to TRUE.
*
* @return string
* The target database key for the database connection.
*
* @internal
*
* @deprecated in drupal:8.8.0 and is removed from drupal:9.0.0. There is
* no replacement, this function should not be used. It was introduced in
* Drupal 8.8.0 only as a byproduct of the deprecation of the db_* procedural
* functions.
*
* @see https://www.drupal.org/node/2993033
*/
function _db_get_target(array &$options, $allow_replica = TRUE) {
@trigger_error('_db_get_target() is deprecated in drupal:8.8.0. Will be removed before drupal:9.0.0. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
if (empty($options['target']) || $options['target'] === 'replica' && !$allow_replica) {
$options['target'] = 'default';
}
$target = $options['target'];
unset($options['target']);
return $target;
}
/**
* Retrieves a unique id.
*
* Use this function if for some reason you can't use a serial field. Using a
* serial field is preferred, and InsertQuery::execute() returns the value of
* the last ID inserted.
*
* @param int $existing_id
* After a database import, it might be that the sequences table is behind, so
* by passing in a minimum ID, it can be assured that we never issue the same
* ID.
*
* @return int
* An integer number larger than any number returned before for this sequence.
*
* @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
* and call nextId() on it.
* For example, $injected_database->nextId($existing_id);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Connection::nextId()
*/
function db_next_id($existing_id = 0) {
@trigger_error('db_next_id() 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 and call nextId() on it. For example, $injected_database->nextId($existing_id). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->nextId($existing_id);
}
/**
* Returns a new DatabaseCondition, set to "OR" all conditions together.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition object, set to "OR" all conditions together.
*
* @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Create
* a \Drupal\Core\Database\Query\Condition object, specifying an OR
* conjunction: new Condition('OR');
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Query\Condition
*/
function db_or() {
@trigger_error('db_or() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Create a \\Drupal\\Core\\Database\\Query\\Condition object, specifying an OR conjunction: new Condition(\'OR\'), instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return new Condition('OR');
}
/**
* Returns a new DatabaseCondition, set to "AND" all conditions together.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition object, set to "AND" all conditions together.
*
* @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Create
* a \Drupal\Core\Database\Query\Condition object, specifying an AND
* conjunction: new Condition('AND');
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Query\Condition
*/
function db_and() {
@trigger_error('db_and() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Create a \\Drupal\\Core\\Database\\Query\\Condition object, specifying an AND conjunction: new Condition(\'AND\'), instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return new Condition('AND');
}
/**
* Returns a new DatabaseCondition, set to "XOR" all conditions together.
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition object, set to "XOR" all conditions together.
*
* @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Create
* a \Drupal\Core\Database\Query\Condition object, specifying a XOR
* conjunction: new Condition('XOR');
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Query\Condition
*/
function db_xor() {
@trigger_error('db_xor() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Create a \\Drupal\\Core\\Database\\Query\\Condition object, specifying a XOR conjunction: new Condition(\'XOR\'), instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return new Condition('XOR');
}
/**
* Returns a new DatabaseCondition, set to the specified conjunction.
*
* Internal API function call. Creating a
* \Drupal\Core\Database\Query\Condition object, specifying the desired
* conjunction ('AND', 'OR' or 'XOR'), is preferred.
*
* @param string $conjunction
* The conjunction to use for query conditions (AND, OR or XOR).
*
* @return \Drupal\Core\Database\Query\Condition
* A new Condition object, set to the specified conjunction.
*
* @deprecated in drupal:8.0.0 and is removed from drupal:9.0.0. Create
* a \Drupal\Core\Database\Query\Condition object, specifying the desired
* conjunction: new Condition($conjunction);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Query\Condition
*/
function db_condition($conjunction) {
@trigger_error('db_condition() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Create a \\Drupal\\Core\\Database\\Query\\Condition object, specifying the desired conjunction: new Condition($conjunction), instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return new Condition($conjunction);
}
/**
* @} End of "addtogroup database".
*/
/**
* @addtogroup schemaapi
* @{
*/
/**
* Creates a new table from a Drupal table definition.
*
* @param string $name
* The name of the table to create.
* @param array $table
* A Schema API table definition array.
*
* @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 createTable() on it. For example,
* $injected_database->schema()->createTable($name, $table);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::createTable()
*/
function db_create_table($name, $table) {
@trigger_error('db_create_table() 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 createTable() on it. For example, $injected_database->schema()->createTable($name, $table). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->createTable($name, $table);
}
/**
* Returns an array of field names from an array of key/index column specifiers.
*
* This is usually an identity function but if a key/index uses a column prefix
* specification, this function extracts just the name.
*
* @param array $fields
* An array of key/index column specifiers.
*
* @return array
* An array of field names.
*
* @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 fieldNames() on it. For example,
* $injected_database->schema()->fieldNames($fields);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::fieldNames()
*/
function db_field_names($fields) {
@trigger_error('db_field_names() 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 fieldNames() on it. For example, $injected_database->schema()->fieldNames($fields). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->fieldNames($fields);
}
/**
* Checks if an index exists in the given table.
*
* @param string $table
* The name of the table in drupal (no prefixing).
* @param string $name
* The name of the index in drupal (no prefixing).
*
* @return bool
* TRUE if the given index exists, otherwise FALSE.
*
* @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 indexExists() on it. For example,
* $injected_database->schema()->indexExists($table, $name);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::indexExists()
*/
function db_index_exists($table, $name) {
@trigger_error('db_index_exists() 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 indexExists() on it. For example, $injected_database->schema()->indexExists($table, $name). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->indexExists($table, $name);
}
/**
* Checks if a table exists.
*
* @param string $table
* The name of the table in drupal (no prefixing).
*
* @return bool
* TRUE if the given table exists, otherwise FALSE.
*
* @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 tableExists() on it. For example,
* $injected_database->schema()->tableExists($table);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::tableExists()
*/
function db_table_exists($table) {
@trigger_error('db_table_exists() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Use $injected_database->schema()->tableExists($table) instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->tableExists($table);
}
/**
* Checks if a column exists in the given table.
*
* @param $table
* The name of the table in drupal (no prefixing).
* @param $field
* The name of the field.
*
* @return bool
* TRUE if the given column exists, otherwise FALSE.
*
* @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 fieldExists() on it. For example,
* $injected_database->schema()->fieldExists($table, $field);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::fieldExists()
*/
function db_field_exists($table, $field) {
@trigger_error('db_field_exists() 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 fieldExists() on it. For example, $injected_database->schema()->fieldExists($table, $field). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->fieldExists($table, $field);
}
/**
* Finds all tables that are like the specified base table name.
*
* @param string $table_expression
* An SQL expression, for example "simpletest%" (without the quotes).
*
* @return array
* Array, both the keys and the values are the matching tables.
*
* @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 findTables() on it. For example,
* $injected_database->schema()->findTables($table_expression);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::findTables()
*/
function db_find_tables($table_expression) {
@trigger_error('db_find_tables() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Use $injected_database->schema()->findTables($table_expression) instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->findTables($table_expression);
}
/**
* Renames a table.
*
* @param $table
* The current name of the table to be renamed.
* @param $new_name
* The new name for the table.
*
* @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 renameTable() on it. For example,
* $injected_database->schema()->renameTable($table, $new_name);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::renameTable()
*/
function db_rename_table($table, $new_name) {
@trigger_error('db_rename_table() 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 renameTable() on it. For example, $injected_database->schema()->renameTable($table, $new_name). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->renameTable($table, $new_name);
}
/**
* Drops a table.
*
* @param $table
* The table to be dropped.
*
* @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 dropTable() on it. For example,
* $injected_database->schema()->dropTable($table);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::dropTable()
*/
function db_drop_table($table) {
@trigger_error('db_drop_table() is deprecated in drupal:8.0.0. It will be removed from drupal:9.0.0. Use \\Drupal\\Core\\Database\\Database::getConnection()->schema()->dropTable() instead. See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->dropTable($table);
}
/**
* Adds a new field to a table.
*
* @param $table
* Name of the table to be altered.
* @param $field
* Name of the field to be added.
* @param array $spec
* The field specification array, as taken from a schema definition. The
* specification may also contain the key 'initial'; the newly-created field
* will be set to the value of the key in all rows. This is most useful for
* creating NOT NULL columns with no default value in existing tables.
* @param array $keys_new
* (optional) Keys and indexes specification to be created on the table along
* with adding the field. The format is the same as a table specification, but
* without the 'fields' element. If you are adding a type 'serial' field, you
* MUST specify at least one key or index including it in this array. See
* \Drupal\Core\Database\Schema::changeField() for more explanation why.
*
* @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 addField() on it. For example,
* $injected_database->schema()->addField($table, $field, $spec, $keys_new);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::addField()
* @see \Drupal\Core\Database\Schema::changeField()
*/
function db_add_field($table, $field, $spec, $keys_new = []) {
@trigger_error('db_add_field() 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 addField() on it. For example, $injected_database->schema()->addField($table, $field, $spec, $keys_new). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->addField($table, $field, $spec, $keys_new);
}
/**
* Drops a field.
*
* @param $table
* The table to be altered.
* @param $field
* The field to be dropped.
*
* @return bool
* TRUE if the field was successfully dropped, FALSE if there was no field 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 dropField() on it. For example,
* $injected_database->schema()->dropField($table, $field);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::dropField()
*/
function db_drop_field($table, $field) {
@trigger_error('db_drop_field() 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 dropField() on it. For example, $injected_database->schema()->dropField($table, $field). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->dropField($table, $field);
}
/**
* Sets the default value for a field.
*
* @param $table
* The table to be altered.
* @param $field
* The field to be altered.
* @param $default
* Default value to be set. NULL for 'default NULL'.
*
* @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 changeField() on it, passing a full field
* specification. For example,
* $injected_database->schema()
* ->changeField($table, $field, $field_new, $spec, $keys_new);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::changeField()
*/
function db_field_set_default($table, $field, $default) {
@trigger_error('db_field_set_default() 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 changeField() on it, passing a full field specification. For example, $injected_database->schema()->changeField($table, $field, $field_new, $spec, $keys_new). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->fieldSetDefault($table, $field, $default);
}
/**
* Sets a field to have no default value.
*
* @param $table
* The table to be altered.
* @param $field
* The field to be altered.
*
* @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 changeField() on it, passing a full field
* specification. For example,
* $injected_database->schema()
* ->changeField($table, $field, $field_new, $spec, $keys_new);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::changeField()
*/
function db_field_set_no_default($table, $field) {
@trigger_error('db_field_set_no_default() 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 changeField() on it, passing a full field specification. For example, $injected_database->schema()->changeField($table, $field, $field_new, $spec, $keys_new). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->fieldSetNoDefault($table, $field);
}
/**
* Adds a primary key to a database table.
*
* @param $table
* Name of the table to be altered.
* @param $fields
* Array of fields for the primary key.
*
* @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 addPrimaryKey() on it. For example,
* $injected_database->schema()->addPrimaryKey($table, $fields);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::addPrimaryKey()
*/
function db_add_primary_key($table, $fields) {
@trigger_error('db_add_primary_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 addPrimaryKey() on it. For example, $injected_database->schema()->addPrimaryKey($table, $fields). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->addPrimaryKey($table, $fields);
}
/**
* Drops the primary key of a database table.
*
* @param $table
* Name of the table to be altered.
*
* @return bool
* TRUE if the primary key was successfully dropped, FALSE if there was no
* primary key on this table 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 dropPrimaryKey() on it. For example,
* $injected_database->schema()->dropPrimaryKey($table);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::dropPrimaryKey()
*/
function db_drop_primary_key($table) {
@trigger_error('db_drop_primary_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 dropPrimaryKey() on it. For example, $injected_database->schema()->dropPrimaryKey($table). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->dropPrimaryKey($table);
}
/**
* Adds a unique key.
*
* @param $table
* The table to be altered.
* @param $name
* The name of the key.
* @param array $fields
* An array of field names.
*
* @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 addUniqueKey() on it. For example,
* $injected_database->schema()->addUniqueKey($table, $name, $fields);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::addUniqueKey()
*/
function db_add_unique_key($table, $name, $fields) {
@trigger_error('db_add_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 addUniqueKey() on it. For example, $injected_database->schema()->addUniqueKey($table, $name, $fields). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->addUniqueKey($table, $name, $fields);
}
/**
* Drops a unique key.
*
* @param $table
* The table to be altered.
* @param $name
* The name of the key.
*
* @return 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 https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::dropUniqueKey()
*/
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);
}
/**
* Adds an index.
*
* @param $table
* The table to be altered.
* @param $name
* The name of the index.
* @param array $fields
* An array of field names.
* @param 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 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 addIndex() on it. For example,
* $injected_database->schema()->addIndex($table, $name, $fields, $spec);
*
* @see https://www.drupal.org/node/2993033
* @see hook_schema()
* @see schemaapi
* @see \Drupal\Core\Database\Schema::addIndex()
*/
function db_add_index($table, $name, $fields, array $spec) {
@trigger_error('db_add_index() is deprecated in drupal:8.0.x and 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. For example, $injected_database->schema()->addIndex($table, $name, $fields, $spec). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
Database::getConnection()->schema()
->addIndex($table, $name, $fields, $spec);
}
/**
* Drops an index.
*
* @param $table
* The table to be altered.
* @param $name
* The name of the index.
*
* @return bool
* TRUE if the index was successfully dropped, FALSE if there was no index
* 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 dropIndex() on it. For example,
* $injected_database->schema()->dropIndex($table, $name);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::dropIndex()
*/
function db_drop_index($table, $name) {
@trigger_error('db_drop_index() 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 dropIndex() on it. For example, $injected_database->schema()->dropIndex($table, $name). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->dropIndex($table, $name);
}
/**
* Changes a field definition.
*
* IMPORTANT NOTE: To maintain database portability, you have to explicitly
* recreate all indices and primary keys that are using the changed field.
*
* That means that you have to drop all affected keys and indexes with
* \Drupal::database()->schema()->drop{PrimaryKey,UniqueKey,Index}() before
* calling \Drupal\Core\Database\Schema::changeField().
* To recreate the keys and indices, pass the key definitions as the optional
* $keys_new argument directly to \Drupal\Core\Database\Schema::changeField().
*
* For example, suppose you have:
* @code
* $schema['foo'] = array(
* 'fields' => array(
* 'bar' => array('type' => 'int', 'not null' => TRUE)
* ),
* 'primary key' => array('bar')
* );
* @endcode
* and you want to change foo.bar to be type serial, leaving it as the primary
* key. The correct sequence is:
* @code
* $schema = \Drupal::database()->schema();
* $schema->dropPrimaryKey('foo');
* $schema->changeField('foo', 'bar', 'bar',
* array('type' => 'serial', 'not null' => TRUE),
* array('primary key' => array('bar')));
* @endcode
*
* The reasons for this are due to the different database engines:
*
* On PostgreSQL, changing a field definition involves adding a new field and
* dropping an old one which causes any indices, primary keys and sequences
* (from serial-type fields) that use the changed field to be dropped.
*
* On MySQL, all type 'serial' fields must be part of at least one key or index
* as soon as they are created. You cannot use
* \Drupal::database()->schema()->add{PrimaryKey,UniqueKey,Index}() for this
* purpose because the ALTER TABLE command will fail to add the column without
* a key or index specification. The solution is to use the optional $keys_new
* argument to create the key or index at the same time as field.
*
* You could use
* \Drupal::database()->schema()->add{PrimaryKey,UniqueKey,Index}() in all
* cases unless you are converting a field to be type serial. You can use the
* $keys_new argument in all cases.
*
* @param $table
* Name of the table.
* @param $field
* Name of the field to change.
* @param $field_new
* New name for the field (set to the same as $field if you don't want to
* change the name).
* @param $spec
* The field specification for the new field.
* @param array $keys_new
* (optional) Keys and indexes specification to be created on the table along
* with changing the field. The format is the same as a table specification
* but without the 'fields' element.
*
* @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 changeField() on it. For example,
* $injected_database->schema()
* ->changeField($table, $field, $field_new, $spec, $keys_new);
*
* @see https://www.drupal.org/node/2993033
* @see \Drupal\Core\Database\Schema::changeField()
*/
function db_change_field($table, $field, $field_new, $spec, $keys_new = []) {
@trigger_error('db_change_field() 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 changeField() on it. For example, $injected_database->schema()->changeField($table, $field, $field_new, $spec, $keys_new). See https://www.drupal.org/node/2993033', E_USER_DEPRECATED);
return Database::getConnection()->schema()
->changeField($table, $field, $field_new, $spec, $keys_new);
}
/**
* @} End of "addtogroup schemaapi".
*/
/**
* Sets a session variable specifying the lag time for ignoring a replica
* server (A replica server is traditionally referred to as
* a "slave" in database server documentation).
*
* @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Use
* \Drupal::service('database.replica_kill_switch')->trigger() instead.
*
* @see https://www.drupal.org/node/2997500
* @see https://www.drupal.org/node/2275877
*/
function db_ignore_replica() {
@trigger_error('db_ignore_replica() is deprecated in drupal:8.7.0. It will be removed from drupal:9.0.0. Use \\Drupal\\Core\\Database\\ReplicaKillSwitch::trigger() instead. See https://www.drupal.org/node/2997500', E_USER_DEPRECATED);
\Drupal::service('database.replica_kill_switch')->trigger();
}
Functions
Title | Deprecated | Summary |
---|---|---|
db_add_field | 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 addField() on it. For example, $injected_database->schema()->addField($table, $field, $spec, $keys_new); |
Adds a new field to a table. |
db_add_index | 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 addIndex() on it. For example, $injected_database->schema()->addIndex($table, $name, $fields, $spec); |
Adds an index. |
db_add_primary_key | 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 addPrimaryKey() on it. For example, $injected_database->schema()->addPrimaryKey($table, $fields); |
Adds a primary key to a database table. |
db_add_unique_key | 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 addUniqueKey() on it. For example, $injected_database->schema()->addUniqueKey($table, $name, $fields); |
Adds a unique key. |
db_and | in drupal:8.0.0 and is removed from drupal:9.0.0. Create a \Drupal\Core\Database\Query\Condition object, specifying an AND conjunction: new Condition('AND'); |
Returns a new DatabaseCondition, set to "AND" all conditions together. |
db_change_field | 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 changeField() on it. For example, $injected_database->schema() ->changeField($table, $field, $field_new, $spec, $keys_new); |
Changes a field definition. |
db_close | in drupal:8.0.0 and is removed from drupal:9.0.0. Use \Drupal\Core\Database\Database::closeConnection($target). |
Closes the active database connection. |
db_condition | in drupal:8.0.0 and is removed from drupal:9.0.0. Create a \Drupal\Core\Database\Query\Condition object, specifying the desired conjunction: new Condition($conjunction); |
Returns a new DatabaseCondition, set to the specified conjunction. |
db_create_table | 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 createTable() on it. For example, $injected_database->schema()->createTable($name, $table); |
Creates a new table from a Drupal table definition. |
db_delete | 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 and call delete() on it. For example, $injected_database->delete($table, $options); |
Returns a new DeleteQuery object for the active database. |
db_driver | 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 and call driver() on it. For example, $injected_database->driver($string); |
Retrieves the name of the currently active database driver. |
db_drop_field | 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 dropField() on it. For example, $injected_database->schema()->dropField($table, $field); |
Drops a field. |
db_drop_index | 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 dropIndex() on it. For example, $injected_database->schema()->dropIndex($table, $name); |
Drops an index. |
db_drop_primary_key | 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 dropPrimaryKey() on it. For example, $injected_database->schema()->dropPrimaryKey($table); |
Drops the primary key of a database table. |
db_drop_table | 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 dropTable() on it. For example, $injected_database->schema()->dropTable($table); |
Drops a table. |
db_drop_unique_key | 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); |
Drops a unique key. |
db_escape_field | 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 and call escapeField() on it. For example, $injected_database->escapeField($field); |
Restricts a dynamic column or constraint name to safe characters. |
db_escape_table | 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 and call escapeTable() on it. For example, $injected_database->escapeTable($table); |
Restricts a dynamic table name to safe characters. |
db_field_exists | 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 fieldExists() on it. For example, $injected_database->schema()->fieldExists($table, $field); |
Checks if a column exists in the given table. |
db_field_names | 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 fieldNames() on it. For example, $injected_database->schema()->fieldNames($fields); |
Returns an array of field names from an array of key/index column specifiers. |
db_field_set_default | 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 changeField() on it, passing a full field specification. For example, $injected_database->schema() ->changeField($table, $field, $field_new, $spec, $keys_new); |
Sets the default value for a field. |
db_field_set_no_default | 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 changeField() on it, passing a full field specification. For example, $injected_database->schema() ->changeField($table, $field, $field_new, $spec, $keys_new); |
Sets a field to have no default value. |
db_find_tables | 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 findTables() on it. For example, $injected_database->schema()->findTables($table_expression); |
Finds all tables that are like the specified base table name. |
db_ignore_replica | in drupal:8.7.0 and is removed from drupal:9.0.0. Use \Drupal::service('database.replica_kill_switch')->trigger() instead. |
Sets a session variable specifying the lag time for ignoring a replica server (A replica server is traditionally referred to as a "slave" in database server documentation). |
db_index_exists | 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 indexExists() on it. For example, $injected_database->schema()->indexExists($table, $name); |
Checks if an index exists in the given table. |
db_insert | 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 and call insert() on it. For example, $injected_database->insert($table, $options); |
Returns a new InsertQuery object for the active database. |
db_like | 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 and call escapeLike() on it. For example, $injected_database->escapeLike($string); |
Escapes characters that work as wildcard characters in a LIKE pattern. |
db_merge | 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 and call merge() on it. For example, $injected_database->merge($table, $options); |
Returns a new MergeQuery object for the active database. |
db_next_id | 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 and call nextId() on it. For example, $injected_database->nextId($existing_id); |
Retrieves a unique id. |
db_or | in drupal:8.0.0 and is removed from drupal:9.0.0. Create a \Drupal\Core\Database\Query\Condition object, specifying an OR conjunction: new Condition('OR'); |
Returns a new DatabaseCondition, set to "OR" all conditions together. |
db_query | 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 and call query() on it. For example, $injected_database->query($query, $args, $options); |
Executes an arbitrary query string against the active database. |
db_query_range | 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 and call queryRange() on it. For example, $injected_database->queryRange($query, $from, $count, $args, $options); |
Executes a query against the active database, restricted to a range. |
db_query_temporary | 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 and call queryTemporary() on it. For example, $injected_database->queryTemporary($query, $args, $options); |
Executes a SELECT query string and saves the result set to a temporary table. |
db_rename_table | 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 renameTable() on it. For example, $injected_database->schema()->renameTable($table, $new_name); |
Renames a table. |
db_select | 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 and call select() on it. For example, $injected_database->select($table, $alias, $options); |
Returns a new SelectQuery object for the active database. |
db_set_active | in drupal:8.0.0 and is removed from drupal:9.0.0. Use \Drupal\Core\Database\Database::setActiveConnection(). |
Sets a new active database. |
db_table_exists | 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 tableExists() on it. For example, $injected_database->schema()->tableExists($table); |
Checks if a table exists. |
db_transaction | 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 and call startTransaction() on it. For example, $injected_database->startTransaction($name); |
Returns a new transaction object for the active database. |
db_truncate | 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 and call truncate() on it. For example, $injected_database->truncate($table, $options); |
Returns a new TruncateQuery object for the active database. |
db_update | 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 and call update() on it. For example, $injected_database->update($table, $options); |
Returns a new UpdateQuery object for the active database. |
db_xor | in drupal:8.0.0 and is removed from drupal:9.0.0. Create a \Drupal\Core\Database\Query\Condition object, specifying a XOR conjunction: new Condition('XOR'); |
Returns a new DatabaseCondition, set to "XOR" all conditions together. |
_db_get_target | in drupal:8.8.0 and is removed from drupal:9.0.0. There is no replacement, this function should not be used. It was introduced in Drupal 8.8.0 only as a byproduct of the deprecation of the db_* procedural functions. |
Get target helper. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.