1. 8.2.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  2. 8.2.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  3. 8.2.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  4. 8.2.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  5. 8.0.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  6. 8.0.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  7. 8.0.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  8. 8.0.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  9. 8.1.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  10. 8.1.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  11. 8.1.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  12. 8.1.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  13. 8.3.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  14. 8.3.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  15. 8.3.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  16. 8.3.x core/lib/Drupal/Core/Database/Query/Insert.php Insert

General class for an abstracted INSERT query.


Expanded class hierarchy of Insert

Related topics

3 files declare their use of Insert
Insert.php in core/lib/Drupal/Core/Database/Driver/mysql/Insert.php
Insert.php in core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php
Insert.php in core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php
1 string reference to 'Insert'
Connection::insert in core/lib/Drupal/Core/Database/Connection.php
Prepares and returns an INSERT query object.


core/lib/Drupal/Core/Database/Query/Insert.php, line 12


View 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 = array()) {
    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 \Drupal\Core\Database\Query\Insert
   *   The called object.
  public function from(SelectInterface $query) {
    $this->fromQuery = $query;
    return $this;

   * Executes the insert query.
   * @return
   *   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;

    // Each insert happens in its own query in the degenerate case. However,
    // we wrap it in a transaction so that it is atomic where possible. On many
    // databases, such as SQLite, this is also a notable performance boost.
    $transaction = $this->connection->startTransaction();

    try {
      $sql = (string) $this;
      foreach ($this->insertValues as $insert_values) {
        $last_insert_id = $this->connection->query($sql, $insert_values, $this->queryOptions);
    catch (\Exception $e) {
      // One of the INSERTs failed, rollback the whole batch.
      // Rethrow the exception for the calling code.
      throw $e;

    // Re-initialize the values array so that we can re-use this query.
    $this->insertValues = array();

    // 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 = array();
    $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;



Contains filters are case sensitive
Namesort descending Modifiers Type Description
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
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
Insert::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString
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
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::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.
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.