You are here

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

function db_truncate in Zircon Profile 8

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

Returns a new TruncateQuery object for the active database.

Parameters

string $table: The table from which to truncate.

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

Return value

\Drupal\Core\Database\Query\Truncate A new Truncate object for this connection.

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 and call truncate() on it. E.g. $injected_database->truncate($table, $options);

See also

\Drupal\Core\Database\Connection::truncate()

\Drupal\Core\Database\Connection::defaultOptions()

Related topics

Database abstraction layer
Allow the use of different database servers using the same code base.
1 call to db_truncate()
StatisticsLoggingTest::setUp in core/modules/statistics/src/Tests/StatisticsLoggingTest.php
Sets up a Drupal site for running functional and integration tests.

File

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

Code

function db_truncate($table, array $options = array()) {
  if (empty($options['target']) || $options['target'] == 'replica') {
    $options['target'] = 'default';
  }
  return Database::getConnection($options['target'])
    ->truncate($table, $options);
}