function db_truncate

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

Returns a new TruncateQuery object for the active database.

Parameters

$table: The table from which to delete.

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

Return value

TruncateQuery A new TruncateQuery object for this connection.

Related topics

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

File

includes/database/database.inc, line 2615

Code

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

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