Insert.php

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

Namespace

Drupal\sqlite\Driver\Database\sqlite

File

core/modules/sqlite/src/Driver/Database/sqlite/Insert.php

View source
<?php

namespace Drupal\sqlite\Driver\Database\sqlite;

use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\Query\Insert as QueryInsert;

/**
 * SQLite implementation of \Drupal\Core\Database\Query\Insert.
 *
 * We ignore all the default fields and use the clever SQLite syntax:
 *   INSERT INTO table DEFAULT VALUES
 * for degenerated "default only" queries.
 */
class Insert extends QueryInsert {
    
    /**
     * {@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']);
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        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)) {
            // The SelectQuery may contain arguments, load and pass them through.
            return $this->connection
                ->query((string) $this, $this->fromQuery
                ->getArguments(), $this->queryOptions);
        }
        // If there are any fields in the query, execute normal INSERT statements.
        if (count($this->insertFields)) {
            $stmt = $this->connection
                ->prepareStatement((string) $this, $this->queryOptions);
            if (count($this->insertValues) === 1) {
                // Inserting a single row does not require a transaction to be atomic,
                // and executes faster without a transaction wrapper.
                $insert_values = $this->insertValues[0];
                try {
                    $stmt->execute($insert_values, $this->queryOptions);
                } catch (\Exception $e) {
                    $this->connection
                        ->exceptionHandler()
                        ->handleExecutionException($e, $stmt, $insert_values, $this->queryOptions);
                }
            }
            else {
                // Inserting multiple rows requires a transaction to be atomic, and
                // executes faster as a single transaction.
                try {
                    $transaction = $this->connection
                        ->startTransaction();
                } catch (\PDOException $e) {
                    // $this->connection->exceptionHandler()->handleExecutionException()
                    // requires a $statement argument, so we cannot use that.
                    throw new DatabaseExceptionWrapper($e->getMessage(), 0, $e);
                }
                foreach ($this->insertValues as $insert_values) {
                    try {
                        $stmt->execute($insert_values, $this->queryOptions);
                    } catch (\Exception $e) {
                        // One of the INSERTs failed, rollback the whole batch.
                        $transaction->rollBack();
                        $this->connection
                            ->exceptionHandler()
                            ->handleExecutionException($e, $stmt, $insert_values, $this->queryOptions);
                    }
                }
            }
            // Re-initialize the values array so that we can re-use this query.
            $this->insertValues = [];
        }
        else {
            $stmt = $this->connection
                ->prepareStatement("INSERT INTO {{$this->table}} DEFAULT VALUES", $this->queryOptions);
            try {
                $stmt->execute(NULL, $this->queryOptions);
            } catch (\Exception $e) {
                $this->connection
                    ->exceptionHandler()
                    ->handleExecutionException($e, $stmt, [], $this->queryOptions);
            }
        }
        return $this->connection
            ->lastInsertId();
    }
    
    /**
     * {@inheritdoc}
     */
    public function __toString() {
        // Create a sanitized comment string to prepend to the query.
        $comments = $this->connection
            ->makeComment($this->comments);
        // Produce as many generic placeholders as necessary.
        $placeholders = [];
        if (!empty($this->insertFields)) {
            $placeholders = array_fill(0, count($this->insertFields), '?');
        }
        $insert_fields = array_map(function ($field) {
            return $this->connection
                ->escapeField($field);
        }, $this->insertFields);
        // 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)) {
            $insert_fields_string = $insert_fields ? ' (' . implode(', ', $insert_fields) . ') ' : ' ';
            return $comments . 'INSERT INTO {' . $this->table . '}' . $insert_fields_string . $this->fromQuery;
        }
        return $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES (' . implode(', ', $placeholders) . ')';
    }

}

Classes

Title Deprecated Summary
Insert SQLite implementation of \Drupal\Core\Database\Query\Insert.

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