class Truncate in Drupal 8
Same name in this branch
- 8 core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
- 8 core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
- 8 core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
- 8 core/lib/Drupal/Core/Database/Driver/mysql/Truncate.php \Drupal\Core\Database\Driver\mysql\Truncate
- 8 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Truncate
- 8 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Truncate
Same name and namespace in other branches
- 9 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 PlaceholderInterface
- class \Drupal\Core\Database\Query\Truncate
Expanded class hierarchy of Truncate
4 files declare their use of Truncate
- DatabaseLegacyTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Database/ DatabaseLegacyTest.php - Truncate.php in core/
lib/ Drupal/ Core/ Database/ Driver/ sqlite/ Truncate.php - Truncate.php in core/
lib/ Drupal/ Core/ Database/ Driver/ pgsql/ Truncate.php - Truncate.php in core/
lib/ Drupal/ Core/ Database/ Driver/ mysql/ Truncate.php
1 string reference to 'Truncate'
- Connection::truncate in core/
lib/ Drupal/ Core/ Database/ Connection.php - Prepares and returns a TRUNCATE query object.
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 = []) {
$options['return'] = Database::RETURN_AFFECTED;
parent::__construct($connection, $options);
$this->table = $table;
}
/**
* {@inheritdoc}
*/
public function compile(Connection $connection, PlaceholderInterface $queryPlaceholder) {
return $this->condition
->compile($connection, $queryPlaceholder);
}
/**
* {@inheritdoc}
*/
public function compiled() {
return $this->condition
->compiled();
}
/**
* Executes the TRUNCATE query.
*
* @return
* Return value is dependent on the database type.
*/
public function execute() {
return $this->connection
->query((string) $this, [], $this->queryOptions);
}
/**
* 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Query:: |
protected | property | An array of comments that can be prepended to a query. | |
Query:: |
protected | property | The connection object on which to run this query. | |
Query:: |
protected | property | The key of the connection object. | |
Query:: |
protected | property | The target of the connection object. | |
Query:: |
protected | property | The placeholder counter. | |
Query:: |
protected | property | The query options to pass on to the connection object. | |
Query:: |
protected | property | A unique identifier for this query object. | |
Query:: |
public | function | Adds a comment to the query. | |
Query:: |
public | function | Returns a reference to the comments array for the query. | |
Query:: |
public | function |
Gets the next placeholder value for this query object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function |
Returns a unique identifier for this object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function | Implements the magic __clone function. | 1 |
Query:: |
public | function | Implements the magic __sleep function to disconnect from the database. | |
Query:: |
public | function | Implements the magic __wakeup function to reconnect to the database. | |
Truncate:: |
protected | property | The table to truncate. | |
Truncate:: |
public | function | ||
Truncate:: |
public | function | ||
Truncate:: |
public | function |
Executes the TRUNCATE query. Overrides Query:: |
1 |
Truncate:: |
public | function |
Constructs a Truncate query object. Overrides Query:: |
|
Truncate:: |
public | function |
Implements PHP magic __toString method to convert the query to a string. Overrides Query:: |
1 |