function Truncate::__toString

Same name in this branch
  1. 10 core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate::__toString()
Same name in other branches
  1. 9 core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate::__toString()
  2. 9 core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate::__toString()
  3. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate::__toString()
  4. 8.9.x core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate::__toString()
  5. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate::__toString()
  6. 11.x core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate::__toString()

Implements PHP magic __toString method to convert the query to a string.

Return value

string The prepared statement.

Overrides Query::__toString

1 method overrides Truncate::__toString()
Truncate::__toString in core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php
Implements PHP magic __toString method to convert the query to a string.

File

core/lib/Drupal/Core/Database/Query/Truncate.php, line 69

Class

Truncate
General class for an abstracted TRUNCATE operation.

Namespace

Drupal\Core\Database\Query

Code

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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.