function db_truncate in Drupal 8

Same name and namespace in other branches

1. 7 includes/database/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.

See also

https://www.drupal.org/node/2993033

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

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

Related topics

1 call to db_truncate()

DatabaseLegacyTest::testDbTruncate in core/tests/Drupal/KernelTests/Core/Database/DatabaseLegacyTest.php

Tests deprecation of the db_truncate() function.

File

core/includes/database.inc, line 252

Core systems for the database layer.

Code

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);
}