Prepares and returns a TRUNCATE query object.

@todo in drupal:11.0.0, return a new Query\Truncate instance directly.

Parameters

string $table: The table to use for the truncate statement.

array $options: (optional) An array of options on the query.

Return value

\Drupal\Core\Database\Query\Truncate A new Truncate query object.

See also

\Drupal\Core\Database\Query\Truncate

5 methods override Connection::truncate()

Connection::truncate in core/modules/sqlite/src/Driver/Database/sqlite/Connection.php

Prepares and returns a TRUNCATE query object.

Connection::truncate in core/modules/mysql/src/Driver/Database/mysql/Connection.php

Prepares and returns a TRUNCATE query object.

Connection::truncate in core/modules/pgsql/src/Driver/Database/pgsql/Connection.php

Prepares and returns a TRUNCATE query object.

Connection::truncate in core/tests/fixtures/database_drivers/custom/fake/Connection.php

Prepares and returns a TRUNCATE query object.

StubConnection::truncate in core/tests/Drupal/Tests/Core/Database/Stub/StubConnection.php

Prepares and returns a TRUNCATE query object.

File

core/lib/Drupal/Core/Database/Connection.php, line 1232

Class

Connection

Base Database API class.

Namespace

Drupal\Core\Database

Code

public function truncate($table, array $options = []) {
  $class = $this->getDriverClass('Truncate');
  return new $class($this, $table, $options);
}

---