class Truncate

Same name in this branch
  1. 9 core/modules/mysql/src/Driver/Database/mysql/Truncate.php \Drupal\mysql\Driver\Database\mysql\Truncate
  2. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Truncate
  3. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion\Truncate
  4. 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Truncate
  5. 9 core/modules/pgsql/src/Driver/Database/pgsql/Truncate.php \Drupal\pgsql\Driver\Database\pgsql\Truncate
  6. 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Truncate.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Truncate
  7. 9 core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
  8. 9 core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
  9. 9 core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
Same name in other branches
  1. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Truncate
  2. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Truncate.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Truncate
  3. 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
  4. 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Truncate.php \Drupal\Core\Database\Driver\mysql\Truncate
  5. 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
  6. 8.9.x core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
  7. 10 core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate
  8. 10 core/modules/mysql/src/Driver/Database/mysql/Truncate.php \Drupal\mysql\Driver\Database\mysql\Truncate
  9. 10 core/modules/pgsql/src/Driver/Database/pgsql/Truncate.php \Drupal\pgsql\Driver\Database\pgsql\Truncate
  10. 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Truncate.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Truncate
  11. 10 core/lib/Drupal/Core/Database/Driver/sqlite/Truncate.php \Drupal\Core\Database\Driver\sqlite\Truncate
  12. 10 core/lib/Drupal/Core/Database/Driver/pgsql/Truncate.php \Drupal\Core\Database\Driver\pgsql\Truncate
  13. 10 core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate
  14. 11.x core/modules/sqlite/src/Driver/Database/sqlite/Truncate.php \Drupal\sqlite\Driver\Database\sqlite\Truncate
  15. 11.x core/modules/mysql/src/Driver/Database/mysql/Truncate.php \Drupal\mysql\Driver\Database\mysql\Truncate
  16. 11.x core/modules/pgsql/src/Driver/Database/pgsql/Truncate.php \Drupal\pgsql\Driver\Database\pgsql\Truncate
  17. 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Truncate.php \Drupal\core_fake\Driver\Database\CoreFakeWithAllCustomClasses\Truncate
  18. 11.x core/lib/Drupal/Core/Database/Query/Truncate.php \Drupal\Core\Database\Query\Truncate

SQLite implementation of \Drupal\Core\Database\Query\Truncate.

SQLite doesn't support TRUNCATE, but a DELETE query with no condition has exactly the effect (it is implemented by DROPing the table).

Hierarchy

Expanded class hierarchy of Truncate

1 file declares its use of Truncate
Truncate.php in core/lib/Drupal/Core/Database/Driver/sqlite/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/modules/sqlite/src/Driver/Database/sqlite/Truncate.php, line 13

Namespace

Drupal\sqlite\Driver\Database\sqlite
View source 
class Truncate extends QueryTruncate {
    
    /**
     * {@inheritdoc}
     */
    public function __construct(Connection $connection, string $table, array $options = []) {
        // @todo Remove the __construct in Drupal 11.
        // @see https://www.drupal.org/project/drupal/issues/3256524
        parent::__construct($connection, $table, $options);
        unset($this->queryOptions['return']);
    }
    public function __toString() {
        // Create a sanitized comment string to prepend to the query.
        $comments = $this->connection
            ->makeComment($this->comments);
        return $comments . 'DELETE FROM {' . $this->connection
            ->escapeTable($this->table) . '} ';
    }

}

Members

Title 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 Truncate::__construct
Truncate::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Truncate::__toString

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