function db_query

Same name in other branches
  1. 8.9.x core/includes/database.inc \db_query()

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 db_select() instead.

Do not use this function for INSERT, UPDATE, or DELETE queries. Those should be handled via db_insert(), db_update() and db_delete() respectively.

Parameters

$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.

$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.

$options: An array of options to control how the query operates.

Return value

DatabaseStatementInterface A prepared statement object, already executed.

See also

DatabaseConnection::defaultOptions()

Related topics

133 calls to db_query()
ActionLoopTestCase::triggerActions in modules/simpletest/tests/actions.test
Create an infinite loop by causing a watchdog message to be set, which causes the actions to be triggered again, up to actions_max_stack times.
AggregatorTestCase::getCategories in modules/aggregator/aggregator.test
Pulls categories from {aggregator_category} table.
AggregatorTestCase::getFeedCategories in modules/aggregator/aggregator.test
Pulls feed categories from {aggregator_category_feed} table.
AggregatorTestCase::updateFeedItems in modules/aggregator/aggregator.test
Updates the feed items.
aggregator_block_info in modules/aggregator/aggregator.module
Implements hook_block_info().

... See full list

2 string references to 'db_query'
drupal_get_filename in includes/bootstrap.inc
Returns and optionally sets the filename for a system resource.
_drupal_decode_exception in includes/errors.inc
Decodes an exception and retrieves the correct caller.

File

includes/database/database.inc, line 2462

Code

function db_query($query, array $args = array(), array $options = array()) {
    if (empty($options['target'])) {
        $options['target'] = 'default';
    }
    return Database::getConnection($options['target'])->query($query, $args, $options);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.