Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Upsert.php

class Upsert

Same name in this branch
  1. 11.1.x core/lib/Drupal/Core/Database/Query/Upsert.php \Drupal\Core\Database\Query\Upsert
  2. 11.1.x core/modules/pgsql/src/Driver/Database/pgsql/Upsert.php \Drupal\pgsql\Driver\Database\pgsql\Upsert
  3. 11.1.x core/modules/mysql/src/Driver/Database/mysql/Upsert.php \Drupal\mysql\Driver\Database\mysql\Upsert

SQLite implementation of \Drupal\Core\Database\Query\Upsert.

Hierarchy

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

Expanded class hierarchy of Upsert

See also

https://www.sqlite.org/lang_UPSERT.html

File

core/modules/sqlite/src/Driver/Database/sqlite/Upsert.php, line 12

Namespace

Drupal\sqlite\Driver\Database\sqlite
View source
class Upsert extends QueryUpsert {
    
    /**
     * {@inheritdoc}
     */
    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);
        $insert_fields = array_map(function ($field) {
            return $this->connection
                ->escapeField($field);
        }, $insert_fields);
        $query = $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES ';
        $values = $this->getInsertPlaceholderFragment($this->insertValues, $this->defaultFields);
        $query .= implode(', ', $values);
        // Updating the unique / primary key is not necessary.
        unset($insert_fields[$this->key]);
        $update = [];
        foreach ($insert_fields as $field) {
            // The "excluded." prefix causes the field to refer to the value for field
            // that would have been inserted had there been no conflict.
            $update[] = "{$field} = EXCLUDED.{$field}";
        }
        $query .= ' ON CONFLICT (' . $this->connection
            ->escapeField($this->key) . ') DO UPDATE SET ' . implode(', ', $update);
        return $query;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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.
Upsert::$key protected property The unique or primary key of the table.
Upsert::execute public function Executes the UPSERT operation. Overrides Query::execute 1
Upsert::key public function Sets the unique / primary key field to be used as condition for this query.
Upsert::preExecute protected function Preprocesses and validates the query.
Upsert::__construct public function Constructs an Upsert object. Overrides Query::__construct
Upsert::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString
RSS feed
Powered by Drupal