class Truncate
Same name in this branch
- 9 core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate
- 9 core/modules/mysql/src/Driver/Database/mysql/Truncate.php \Drupal\mysql\Driver\Database\mysql\Truncate
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Truncate
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion\Truncate
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Truncate
- 9 core/modules/pgsql/src/Driver/Database/pgsql/Truncate.php \Drupal\pgsql\Driver\Database\pgsql\Truncate
- 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Truncate.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Truncate
- 9 core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
- 9 core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
Same name in other branches
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Truncate
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Truncate
- 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
- 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Truncate.php \Drupal\Core\Database\Driver\mysql\Truncate
- 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
- 8.9.x core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
- 10 core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate
- 10 core/modules/mysql/src/Driver/Database/mysql/Truncate.php \Drupal\mysql\Driver\Database\mysql\Truncate
- 10 core/modules/pgsql/src/Driver/Database/pgsql/Truncate.php \Drupal\pgsql\Driver\Database\pgsql\Truncate
- 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Truncate.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Truncate
- 10 core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
- 10 core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
- 10 core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
- 11.x core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate
- 11.x core/modules/mysql/src/Driver/Database/mysql/Truncate.php \Drupal\mysql\Driver\Database\mysql\Truncate
- 11.x core/modules/pgsql/src/Driver/Database/pgsql/Truncate.php \Drupal\pgsql\Driver\Database\pgsql\Truncate
- 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Truncate.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Truncate
- 11.x core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
General class for an abstracted TRUNCATE operation.
Hierarchy
- class \Drupal\Core\Database\Query\Query implements \Drupal\Core\Database\Query\PlaceholderInterface
- class \Drupal\Core\Database\Query\Truncate extends \Drupal\Core\Database\Query\Query
Expanded class hierarchy of Truncate
5 files declare their use of Truncate
- Connection.php in core/
lib/ Drupal/ Core/ Database/ Connection.php - Truncate.php in core/
modules/ sqlite/ src/ Driver/ Database/ sqlite/ Truncate.php - Truncate.php in core/
modules/ mysql/ src/ Driver/ Database/ mysql/ Truncate.php - Truncate.php in core/
modules/ pgsql/ src/ Driver/ Database/ pgsql/ Truncate.php - Truncate.php in core/
tests/ fixtures/ database_drivers/ module/ corefake/ src/ Driver/ Database/ corefakeWithAllCustomClasses/ Truncate.php
4 string references to 'Truncate'
- Connection::getDriverClass in core/
lib/ Drupal/ Core/ Database/ Connection.php - Gets the driver-specific override class if any for the specified class.
- Connection::truncate in core/
lib/ Drupal/ Core/ Database/ Connection.php - Prepares and returns a TRUNCATE query object.
- ConnectionTest::providerGetDriverClass in core/
tests/ Drupal/ Tests/ Core/ Database/ ConnectionTest.php - Data provider for testGetDriverClass().
- SearchTextProcessor::analyze in core/
modules/ search/ src/ SearchTextProcessor.php - Runs the text through character analyzers in preparation for indexing.
File
-
core/
lib/ Drupal/ Core/ Database/ Query/ Truncate.php, line 11
Namespace
Drupal\Core\Database\QueryView source
class Truncate extends Query {
/**
* The table to truncate.
*
* @var string
*/
protected $table;
/**
* Constructs a Truncate query object.
*
* @param \Drupal\Core\Database\Connection $connection
* A Connection object.
* @param string $table
* Name of the table to associate with this query.
* @param array $options
* Array of database options.
*/
public function __construct(Connection $connection, $table, array $options = []) {
// @todo Remove $options['return'] in Drupal 11.
// @see https://www.drupal.org/project/drupal/issues/3256524
$options['return'] = Database::RETURN_AFFECTED;
parent::__construct($connection, $options);
$this->table = $table;
}
/**
* Executes the TRUNCATE query.
*
* @return int|null
* Return value is dependent on whether the executed SQL statement is a
* TRUNCATE or a DELETE. TRUNCATE is DDL and no information on affected
* rows is available. DELETE is DML and will return the number of affected
* rows. In general, do not rely on the value returned by this method in
* calling code.
*
* @see https://learnsql.com/blog/difference-between-truncate-delete-and-drop-table-in-sql
*/
public function execute() {
$stmt = $this->connection
->prepareStatement((string) $this, $this->queryOptions, TRUE);
try {
$stmt->execute([], $this->queryOptions);
return $stmt->rowCount();
} catch (\Exception $e) {
$this->connection
->exceptionHandler()
->handleExecutionException($e, $stmt, [], $this->queryOptions);
}
return NULL;
}
/**
* Implements PHP magic __toString method to convert the query to a string.
*
* @return string
* The prepared statement.
*/
public function __toString() {
// Create a sanitized comment string to prepend to the query.
$comments = $this->connection
->makeComment($this->comments);
// In most cases, TRUNCATE is not a transaction safe statement as it is a
// DDL statement which results in an implicit COMMIT. When we are in a
// transaction, fallback to the slower, but transactional, DELETE.
// PostgreSQL also locks the entire table for a TRUNCATE strongly reducing
// the concurrency with other transactions.
if ($this->connection
->inTransaction()) {
return $comments . 'DELETE FROM {' . $this->connection
->escapeTable($this->table) . '}';
}
else {
return $comments . 'TRUNCATE {' . $this->connection
->escapeTable($this->table) . '} ';
}
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Query::$comments | protected | property | An array of comments that can be prepended to a query. | ||
Query::$connection | protected | property | The connection object on which to run this query. | ||
Query::$connectionKey | protected | property | The key of the connection object. | ||
Query::$connectionTarget | protected | property | The target of the connection object. | ||
Query::$nextPlaceholder | protected | property | The placeholder counter. | ||
Query::$queryOptions | protected | property | The query options to pass on to the connection object. | ||
Query::$uniqueIdentifier | protected | property | A unique identifier for this query object. | ||
Query::comment | public | function | Adds a comment to the query. | ||
Query::getComments | public | function | Returns a reference to the comments array for the query. | ||
Query::getConnection | public | function | Gets the database connection to be used for the query. | ||
Query::nextPlaceholder | public | function | Gets the next placeholder value for this query object. | Overrides PlaceholderInterface::nextPlaceholder | |
Query::uniqueIdentifier | public | function | Returns a unique identifier for this object. | Overrides PlaceholderInterface::uniqueIdentifier | |
Query::__clone | public | function | Implements the magic __clone function. | 1 | |
Query::__sleep | public | function | Implements the magic __sleep function to disconnect from the database. | ||
Query::__wakeup | public | function | Implements the magic __wakeup function to reconnect to the database. | ||
Truncate::$table | protected | property | The table to truncate. | ||
Truncate::execute | public | function | Executes the TRUNCATE query. | Overrides Query::execute | 1 |
Truncate::__construct | public | function | Constructs a Truncate query object. | Overrides Query::__construct | 3 |
Truncate::__toString | public | function | Implements PHP magic __toString method to convert the query to a string. | Overrides Query::__toString | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.