8.5.x database.inc db_truncate($table, array $options = [])
8.0.x database.inc db_truncate($table, array $options = array())
8.1.x database.inc db_truncate($table, array $options = array())
8.2.x database.inc db_truncate($table, array $options = array())
8.3.x database.inc db_truncate($table, array $options = [])
8.4.x database.inc db_truncate($table, array $options = [])
8.6.x database.inc db_truncate($table, array $options = [])
7.x database.inc db_truncate($table, array $options = array())

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. For example, $injected_database->truncate($table, $options);

See also

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

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

Related topics

1 call to db_truncate()
StatisticsLoggingTest::setUp in core/modules/statistics/tests/src/Functional/StatisticsLoggingTest.php

File

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

Code

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