class Insert
General class for an abstracted INSERT query.
Hierarchy
- class \Drupal\Core\Database\Query\Query implements \Drupal\Core\Database\Query\PlaceholderInterface- class \Drupal\Core\Database\Query\Insert implements \Drupal\Core\Database\Query\Countable uses \Drupal\Core\Database\Query\InsertTrait extends \Drupal\Core\Database\Query\Query
 
Expanded class hierarchy of Insert
Related topics
5 files declare their use of Insert
- Connection.php in core/lib/ Drupal/ Core/ Database/ Connection.php 
- Insert.php in core/modules/ sqlite/ src/ Driver/ Database/ sqlite/ Insert.php 
- Insert.php in core/modules/ mysql/ src/ Driver/ Database/ mysql/ Insert.php 
- Insert.php in core/modules/ pgsql/ src/ Driver/ Database/ pgsql/ Insert.php 
- Insert.php in core/tests/ fixtures/ database_drivers/ module/ corefake/ src/ Driver/ Database/ corefakeWithAllCustomClasses/ Insert.php 
44 string references to 'Insert'
- AfterCommand::render in core/lib/ Drupal/ Core/ Ajax/ AfterCommand.php 
- Implements Drupal\Core\Ajax\CommandInterface:render().
- AjaxCommandsTest::testAfterCommand in core/tests/ Drupal/ Tests/ Core/ Ajax/ AjaxCommandsTest.php 
- @covers \Drupal\Core\Ajax\AfterCommand[[api-linebreak]]
- AjaxCommandsTest::testAppendCommand in core/tests/ Drupal/ Tests/ Core/ Ajax/ AjaxCommandsTest.php 
- @covers \Drupal\Core\Ajax\AppendCommand[[api-linebreak]]
- AjaxCommandsTest::testBeforeCommand in core/tests/ Drupal/ Tests/ Core/ Ajax/ AjaxCommandsTest.php 
- @covers \Drupal\Core\Ajax\BeforeCommand[[api-linebreak]]
- AjaxCommandsTest::testHtmlCommand in core/tests/ Drupal/ Tests/ Core/ Ajax/ AjaxCommandsTest.php 
- @covers \Drupal\Core\Ajax\HtmlCommand[[api-linebreak]]
File
- 
              core/lib/ Drupal/ Core/ Database/ Query/ Insert.php, line 12 
Namespace
Drupal\Core\Database\QueryView source
class Insert extends Query implements \Countable {
  use InsertTrait;
  
  /**
   * A SelectQuery object to fetch the rows that should be inserted.
   *
   * @var \Drupal\Core\Database\Query\SelectInterface
   */
  protected $fromQuery;
  
  /**
   * Constructs an Insert object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   A Connection object.
   * @param string $table
   *   Name of the table to associate with this query.
   * @param array $options
   *   Array of database options.
   */
  public function __construct($connection, $table, array $options = []) {
    // @todo Remove $options['return'] in Drupal 11.
    // @see https://www.drupal.org/project/drupal/issues/3256524
    if (!isset($options['return'])) {
      $options['return'] = Database::RETURN_INSERT_ID;
    }
    parent::__construct($connection, $options);
    $this->table = $table;
  }
  
  /**
   * Sets the fromQuery on this InsertQuery object.
   *
   * @param \Drupal\Core\Database\Query\SelectInterface $query
   *   The query to fetch the rows that should be inserted.
   *
   * @return $this
   *   The called object.
   */
  public function from(SelectInterface $query) {
    $this->fromQuery = $query;
    return $this;
  }
  
  /**
   * Executes the insert query.
   *
   * @return int|null|string
   *   The last insert ID of the query, if one exists. If the query was given
   *   multiple sets of values to insert, the return value is undefined. If no
   *   fields are specified, this method will do nothing and return NULL. That
   *   That makes it safe to use in multi-insert loops.
   */
  public function execute() {
    // If validation fails, simply return NULL. Note that validation routines
    // in preExecute() may throw exceptions instead.
    if (!$this->preExecute()) {
      return NULL;
    }
    // If we're selecting from a SelectQuery, finish building the query and
    // pass it back, as any remaining options are irrelevant.
    if (!empty($this->fromQuery)) {
      $sql = (string) $this;
      // The SelectQuery may contain arguments, load and pass them through.
      return $this->connection
        ->query($sql, $this->fromQuery
        ->getArguments(), $this->queryOptions);
    }
    $last_insert_id = 0;
    $stmt = $this->connection
      ->prepareStatement((string) $this, $this->queryOptions);
    try {
      // Per https://en.wikipedia.org/wiki/Insert_%28SQL%29#Multirow_inserts,
      // not all databases implement SQL-92's standard syntax for multi-row
      // inserts. Therefore, in the degenerate case, execute a separate query
      // for each row, all within a single transaction for atomicity and
      // performance.
      $transaction = $this->connection
        ->startTransaction();
      foreach ($this->insertValues as $insert_values) {
        $stmt->execute($insert_values, $this->queryOptions);
        $last_insert_id = $this->connection
          ->lastInsertId();
      }
    } catch (\Exception $e) {
      if (isset($transaction)) {
        // One of the INSERTs failed, rollback the whole batch.
        $transaction->rollBack();
      }
      // Rethrow the exception for the calling code.
      throw $e;
    }
    // Re-initialize the values array so that we can re-use this query.
    $this->insertValues = [];
    // Transaction commits here where $transaction looses scope.
    return $last_insert_id;
  }
  
  /**
   * 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);
    // Default fields are always placed first for consistency.
    $insert_fields = array_merge($this->defaultFields, $this->insertFields);
    if (!empty($this->fromQuery)) {
      return $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') ' . $this->fromQuery;
    }
    // For simplicity, we will use the $placeholders array to inject
    // default keywords even though they are not, strictly speaking,
    // placeholders for prepared statements.
    $placeholders = [];
    $placeholders = array_pad($placeholders, count($this->defaultFields), 'default');
    $placeholders = array_pad($placeholders, count($this->insertFields), '?');
    return $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES (' . implode(', ', $placeholders) . ')';
  }
  
  /**
   * Preprocesses and validates the query.
   *
   * @return bool
   *   TRUE if the validation was successful, FALSE if not.
   *
   * @throws \Drupal\Core\Database\Query\FieldsOverlapException
   * @throws \Drupal\Core\Database\Query\NoFieldsException
   */
  protected function preExecute() {
    // Confirm that the user did not try to specify an identical
    // field and default field.
    if (array_intersect($this->insertFields, $this->defaultFields)) {
      throw new FieldsOverlapException('You may not specify the same field to have a value and a schema-default value.');
    }
    if (!empty($this->fromQuery)) {
      // We have to assume that the used aliases match the insert fields.
      // Regular fields are added to the query before expressions, maintain the
      // same order for the insert fields.
      // This behavior can be overridden by calling fields() manually as only the
      // first call to fields() does have an effect.
      $this->fields(array_merge(array_keys($this->fromQuery
        ->getFields()), array_keys($this->fromQuery
        ->getExpressions())));
    }
    else {
      // Don't execute query without fields.
      if (count($this->insertFields) + count($this->defaultFields) == 0) {
        throw new NoFieldsException('There are no fields available to insert with.');
      }
    }
    // If no values have been added, silently ignore this query. This can happen
    // if values are added conditionally, so we don't want to throw an
    // exception.
    if (!isset($this->insertValues[0]) && count($this->insertFields) > 0 && empty($this->fromQuery)) {
      return FALSE;
    }
    return TRUE;
  }
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|
| Insert::$fromQuery | protected | property | A SelectQuery object to fetch the rows that should be inserted. | ||
| Insert::execute | public | function | Executes the insert query. | Overrides Query::execute | 3 | 
| Insert::from | public | function | Sets the fromQuery on this InsertQuery object. | ||
| Insert::preExecute | protected | function | Preprocesses and validates the query. | ||
| Insert::__construct | public | function | Constructs an Insert object. | Overrides Query::__construct | 3 | 
| Insert::__toString | public | function | Implements PHP magic __toString method to convert the query to a string. | Overrides Query::__toString | 3 | 
| InsertTrait::$defaultFields | protected | property | An array of fields that should be set to their database-defined defaults. | ||
| InsertTrait::$insertFields | protected | property | An array of fields on which to insert. | ||
| InsertTrait::$insertValues | protected | property | A nested array of values to insert. | ||
| InsertTrait::$table | protected | property | The table on which to insert. | ||
| InsertTrait::count | public | function | #[\ReturnTypeWillChange] | ||
| InsertTrait::fields | public | function | Adds a set of field->value pairs to be inserted. | ||
| InsertTrait::getInsertPlaceholderFragment | protected | function | Returns the query placeholders for values that will be inserted. | ||
| InsertTrait::useDefaults | public | function | Specifies fields for which the database defaults should be used. | ||
| InsertTrait::values | public | function | Adds another set of values to the query to be inserted. | ||
| 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. | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
