class Truncate

Same name in this branch
  1. 9.x drupal/core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
  2. 9.x drupal/core/lib/Drupal/Core/Database/Driver/mysql/Truncate.php \Drupal\Core\Database\Driver\mysql\Truncate
  3. 9.x drupal/core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
  4. 9.x drupal/core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate

Hierarchy

Expanded class hierarchy of Truncate

1 string reference to 'Truncate'
Connection::truncate in drupal/core/lib/Drupal/Core/Database/Connection.php
Prepares and returns a TRUNCATE query object.

File

drupal/core/lib/Drupal/Core/Database/Driver/mysql/Truncate.php, line 12
Definition of Drupal\Core\Database\Driver\mysql\Truncate

Namespace

Drupal\Core\Database\Driver\mysql
View source
class Truncate extends QueryTruncate {
  public function __toString() {

    // TRUNCATE is actually a DDL statement on MySQL, and DDL statements are
    // not transactional, and result in an implicit COMMIT. When we are in a
    // transaction, fallback to the slower, but transactional, DELETE.
    if ($this->connection
      ->inTransaction()) {

      // Create a comment string to prepend to the query.
      $comments = $this->connection
        ->makeComment($this->comments);
      return $comments . 'DELETE FROM {' . $this->connection
        ->escapeTable($this->table) . '}';
    }
    else {
      return parent::__toString();
    }
  }

}

Members

Namesort descending Modifiers Type Description 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::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::compile public function Implements Drupal\Core\Database\Query\ConditionInterface::compile().
Truncate::compiled public function Implements Drupal\Core\Database\Query\ConditionInterface::compiled().
Truncate::execute public function Executes the TRUNCATE query. Overrides Query::execute
Truncate::__construct public function Constructs a Truncate query object. Overrides Query::__construct
Truncate::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Truncate::__toString