class Insert

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

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.

Hierarchy

Expanded class hierarchy of Insert

1 file declares its use of Insert
Insert.php in core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php
46 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
AjaxCommandsTest::testAppendCommand in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php
@covers \Drupal\Core\Ajax\AppendCommand
AjaxCommandsTest::testBeforeCommand in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php
@covers \Drupal\Core\Ajax\BeforeCommand
AjaxCommandsTest::testHtmlCommand in core/tests/Drupal/Tests/Core/Ajax/AjaxCommandsTest.php
@covers \Drupal\Core\Ajax\HtmlCommand

... See full list

File

core/modules/sqlite/src/Driver/Database/sqlite/Insert.php, line 15

Namespace

Drupal\sqlite\Driver\Database\sqlite
View source
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) . ')';
    }

}

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 Insert::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 Insert::__construct
Insert::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Insert::__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::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.