General class for an abstracted TRUNCATE operation.
Hierarchy
- Query implements QueryPlaceholderInterface
- DeleteQuery implements QueryConditionInterface
- InsertQuery
- MergeQuery implements QueryConditionInterface
- SelectQuery implements SelectQueryInterface
- TruncateQuery
- UpdateQuery implements QueryConditionInterface
Properties
| Name | Description |
|---|---|
| Query::$comments | An array of comments that can be prepended to a query. |
| Query::$connection | The connection object on which to run this query. |
| Query::$connectionKey | The key of the connection object. |
| Query::$connectionTarget | The target of the connection object. |
| Query::$nextPlaceholder | The placeholder counter. |
| Query::$queryOptions | The query options to pass on to the connection object. |
| Query::$uniqueIdentifier | A unique identifier for this query object. |
| TruncateQuery::$table | The table to truncate. |
Functions & methods
| Name | Description |
|---|---|
| Query::comment | Adds a comment to the query. |
| Query::getComments | Returns a reference to the comments array for the query. |
| Query::nextPlaceholder | Gets the next placeholder value for this query object. Overrides QueryPlaceholderInterface::nextPlaceholder |
| Query::uniqueIdentifier | Returns a unique identifier for this object. Overrides QueryPlaceholderInterface::uniqueIdentifier |
| Query::__clone | Implements the magic __clone function. |
| Query::__sleep | Implements the magic __sleep function to disconnect from the database. |
| Query::__wakeup | Implements the magic __wakeup function to reconnect to the database. |
| TruncateQuery::compile | Implements QueryConditionInterface::compile(). |
| TruncateQuery::compiled | Implements QueryConditionInterface::compiled(). |
| TruncateQuery::execute | Executes the TRUNCATE query. Overrides Query::execute |
| TruncateQuery::__construct | Constructs a TruncateQuery object. Overrides Query::__construct |
| TruncateQuery::__toString | Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString |
File
- includes/
database/ query.inc, line 886 - Non-specific Database query code. Used by all engines.
View source
class TruncateQuery extends Query {
/**
* The table to truncate.
*
* @var string
*/
protected $table;
/**
* Constructs a TruncateQuery object.
*
* @param DatabaseConnection $connection
* A DatabaseConnection object.
* @param string $table
* Name of the table to associate with this query.
* @param array $options
* Array of database options.
*/
public function __construct(DatabaseConnection $connection, $table, array $options = array()) {
$options['return'] = Database::RETURN_AFFECTED;
parent::__construct($connection, $options);
$this->table = $table;
}
/**
* Implements QueryConditionInterface::compile().
*/
public function compile(DatabaseConnection $connection, QueryPlaceholderInterface $queryPlaceholder) {
return $this->condition->compile($connection, $queryPlaceholder);
}
/**
* Implements QueryConditionInterface::compiled().
*/
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, array(), $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);
return $comments . 'TRUNCATE {' . $this->connection->escapeTable($this->table) . '} ';
}
}