TruncateQuery

  1. drupal
    1. 8
    2. 7

General class for an abstracted TRUNCATE operation.

Hierarchy

Properties

NameDescription
Query::$commentsAn array of comments that can be prepended to a query.
Query::$connectionThe connection object on which to run this query.
Query::$connectionKeyThe key of the connection object.
Query::$connectionTargetThe target of the connection object.
Query::$queryOptionsThe query options to pass on to the connection object.
TruncateQuery::$tableThe table to truncate.

Functions & methods

NameDescription
Query::commentAdds a comment to the query.
Query::getCommentsReturns a reference to the comments array for the query.
Query::nextPlaceholderGets the next placeholder value for this query object. Overrides QueryPlaceholderInterface::nextPlaceholder
Query::uniqueIdentifierReturns a unique identifier for this object. Overrides QueryPlaceholderInterface::uniqueIdentifier
Query::__cloneImplements the magic __clone function.
Query::__sleepImplements the magic __sleep function to disconnect from the database.
Query::__wakeupImplements the magic __wakeup function to reconnect to the database.
TruncateQuery::compileImplements QueryConditionInterface::compile().
TruncateQuery::compiledImplements QueryConditionInterface::compiled().
TruncateQuery::executeExecutes the TRUNCATE query. Overrides Query::execute
TruncateQuery::__constructConstructs a TruncateQuery object. Overrides Query::__construct
TruncateQuery::__toStringImplements PHP magic __toString method to convert the query to a string. Overrides Query::__toString

includes/database/query.inc, line 880

View source
<?php
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) . '} ';
  }
}
?>

Related topics