class Insert in Drupal 10

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

• class \Drupal\Core\Database\Query\Query implements PlaceholderInterface
  • class \Drupal\Core\Database\Query\Insert implements \Drupal\Core\Database\Query\Countable uses InsertTrait
    • class \Drupal\sqlite\Driver\Database\sqlite\Insert

1 file declares its use of Insert

Insert.php in core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php

1 string reference to 'Insert'

ConnectionTest::providerGetDriverClass in core/tests/Drupal/Tests/Core/Database/ConnectionTest.php

Data provider for testGetDriverClass().

File

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

Namespace

Drupal\sqlite\Driver\Database\sqlite

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']);
  }
  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);
    }

    // We wrap the insert in a transaction so that it is atomic where possible.
    // In SQLite, this is also a notable performance boost.
    $transaction = $this->connection
      ->startTransaction();
    if (count($this->insertFields)) {

      // Each insert happens in its own query.
      $stmt = $this->connection
        ->prepareStatement((string) $this, $this->queryOptions);
      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) {
        $transaction
          ->rollBack();
        $this->connection
          ->exceptionHandler()
          ->handleExecutionException($e, $stmt, [], $this->queryOptions);
      }
    }

    // Transaction commits here when $transaction looses scope.
    return $this->connection
      ->lastInsertId();
  }
  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

Name	Modifiers	Type	Description	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.
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.