class NativeUpsert

Same name in this branch
  1. 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/NativeUpsert.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\NativeUpsert

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

Hierarchy

Expanded class hierarchy of NativeUpsert

See also

http://www.postgresql.org/docs/9.5/static/sql-insert.html#SQL-ON-CONFLIā€¦

1 file declares its use of NativeUpsert
NativeUpsert.php in core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/NativeUpsert.php
1 string reference to 'NativeUpsert'
Connection::upsert in core/lib/Drupal/Core/Database/Driver/pgsql/Connection.php
Prepares and returns an UPSERT query object.

File

core/lib/Drupal/Core/Database/Driver/pgsql/NativeUpsert.php, line 12

Namespace

Drupal\Core\Database\Driver\pgsql
View source
class NativeUpsert extends QueryUpsert {
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        if (!$this->preExecute()) {
            return NULL;
        }
        $stmt = $this->connection
            ->prepareQuery((string) $this);
        // Fetch the list of blobs and sequences used on that table.
        $table_information = $this->connection
            ->schema()
            ->queryTableInformation($this->table);
        $max_placeholder = 0;
        $blobs = [];
        $blob_count = 0;
        foreach ($this->insertValues as $insert_values) {
            foreach ($this->insertFields as $idx => $field) {
                if (isset($table_information->blob_fields[$field])) {
                    $blobs[$blob_count] = fopen('php://memory', 'a');
                    fwrite($blobs[$blob_count], $insert_values[$idx]);
                    rewind($blobs[$blob_count]);
                    $stmt->bindParam(':db_insert_placeholder_' . $max_placeholder++, $blobs[$blob_count], \PDO::PARAM_LOB);
                    // Pre-increment is faster in PHP than increment.
                    ++$blob_count;
                }
                else {
                    $stmt->bindParam(':db_insert_placeholder_' . $max_placeholder++, $insert_values[$idx]);
                }
            }
            // Check if values for a serial field has been passed.
            if (!empty($table_information->serial_fields)) {
                foreach ($table_information->serial_fields as $index => $serial_field) {
                    $serial_key = array_search($serial_field, $this->insertFields);
                    if ($serial_key !== FALSE) {
                        $serial_value = $insert_values[$serial_key];
                        // Sequences must be greater than or equal to 1.
                        if ($serial_value === NULL || !$serial_value) {
                            $serial_value = 1;
                        }
                        // Set the sequence to the bigger value of either the passed
                        // value or the max value of the column. It can happen that another
                        // thread calls nextval() which could lead to a serial number being
                        // used twice. However, trying to insert a value into a serial
                        // column should only be done in very rare cases and is not thread
                        // safe by definition.
                        $this->connection
                            ->query("SELECT setval('" . $table_information->sequences[$index] . "', GREATEST(MAX(" . $serial_field . "), :serial_value)) FROM {" . $this->table . "}", [
                            ':serial_value' => (int) $serial_value,
                        ]);
                    }
                }
            }
        }
        $options = $this->queryOptions;
        if (!empty($table_information->sequences)) {
            $options['sequence_name'] = $table_information->sequences[0];
        }
        // Re-initialize the values array so that we can re-use this query.
        $this->insertValues = [];
        // Create a savepoint so we can rollback a failed query. This is so we can
        // mimic MySQL and SQLite transactions which don't fail if a single query
        // fails. This is important for tables that are created on demand. For
        // example, \Drupal\Core\Cache\DatabaseBackend.
        $this->connection
            ->addSavepoint();
        try {
            $this->connection
                ->query($stmt, [], $options);
            $this->connection
                ->releaseSavepoint();
        } catch (\Exception $e) {
            $this->connection
                ->rollbackSavepoint();
            throw $e;
        }
        return TRUE;
    }
    
    /**
     * {@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 ($f) {
            return $this->connection
                ->escapeField($f);
        }, $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) {
            $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.
NativeUpsert::execute public function Runs the query against the database. Overrides Upsert::execute
NativeUpsert::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Query::__toString
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::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

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