class Upsert in Drupal 8

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

Hierarchy

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

1 file declares its use of Upsert

Upsert.php in core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Upsert.php

3 string references to 'Upsert'

Connection::upsert in core/lib/Drupal/Core/Database/Connection.php

Prepares and returns an UPSERT query object.

Connection::upsert in core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php

Prepares and returns an UPSERT query object.

Connection::__construct in core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Connection.php

Constructs a Connection object.

File

core/lib/Drupal/Core/Database/Driver/pgsql/Upsert.php, line 10

Namespace

Drupal\Core\Database\Driver\pgsql

class Upsert extends QueryUpsert {

  /**
   * {@inheritdoc}
   */
  public function execute() {
    if (!$this
      ->preExecute()) {
      return NULL;
    }

    // Default options for upsert queries.
    $this->queryOptions += [
      'throw_exception' => TRUE,
    ];

    // Default fields are always placed first for consistency.
    $insert_fields = array_merge($this->defaultFields, $this->insertFields);
    $table = $this->connection
      ->escapeTable($this->table);

    // We have to execute multiple queries, therefore we wrap everything in a
    // transaction so that it is atomic where possible.
    $transaction = $this->connection
      ->startTransaction();
    try {

      // First, lock the table we're upserting into.
      $this->connection
        ->query('LOCK TABLE {' . $table . '} IN SHARE ROW EXCLUSIVE MODE', [], $this->queryOptions);

      // Second, delete all items first so we can do one insert.
      $unique_key_position = array_search($this->key, $insert_fields);
      $delete_ids = [];
      foreach ($this->insertValues as $insert_values) {
        $delete_ids[] = $insert_values[$unique_key_position];
      }

      // Delete in chunks when a large array is passed.
      foreach (array_chunk($delete_ids, 1000) as $delete_ids_chunk) {
        $this->connection
          ->delete($this->table, $this->queryOptions)
          ->condition($this->key, $delete_ids_chunk, 'IN')
          ->execute();
      }

      // Third, insert all the values.
      $insert = $this->connection
        ->insert($this->table, $this->queryOptions)
        ->fields($insert_fields);
      foreach ($this->insertValues as $insert_values) {
        $insert
          ->values($insert_values);
      }
      $insert
        ->execute();
    } catch (\Exception $e) {

      // One of the queries failed, rollback the whole batch.
      $transaction
        ->rollBack();

      // Rethrow the exception for the calling code.
      throw $e;
    }

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

    // Transaction commits here where $transaction looses scope.
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function __toString() {

    // Nothing to do.
  }

}

Members

Name	Modifiers	Type	Description	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::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	Runs the query against the database. Overrides Upsert::execute
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