Insert.php
Same filename in this branch
- 10 core/modules/sqlite/src/Driver/Database/sqlite/Insert.php
- 10 core/modules/mysql/src/Driver/Database/mysql/Insert.php
- 10 core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Insert.php
- 10 core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php
- 10 core/lib/Drupal/Core/Database/Driver/mysql/Insert.php
- 10 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php
- 10 core/lib/Drupal/Core/Database/Query/Insert.php
Same filename in other branches
- 9 core/modules/sqlite/src/Driver/Database/sqlite/Insert.php
- 9 core/modules/mysql/src/Driver/Database/mysql/Insert.php
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Insert.php
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Insert.php
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Insert.php
- 9 core/modules/pgsql/src/Driver/Database/pgsql/Insert.php
- 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Insert.php
- 9 core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php
- 9 core/lib/Drupal/Core/Database/Driver/mysql/Insert.php
- 9 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php
- 9 core/lib/Drupal/Core/Database/Query/Insert.php
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Insert.php
- 8.9.x core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Insert.php
- 8.9.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php
- 8.9.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php
- 8.9.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php
- 8.9.x core/lib/Drupal/Core/Database/Query/Insert.php
- 11.x core/modules/sqlite/src/Driver/Database/sqlite/Insert.php
- 11.x core/modules/mysql/src/Driver/Database/mysql/Insert.php
- 11.x core/modules/pgsql/src/Driver/Database/pgsql/Insert.php
- 11.x core/tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFakeWithAllCustomClasses/Insert.php
- 11.x core/lib/Drupal/Core/Database/Query/Insert.php
Namespace
Drupal\pgsql\Driver\Database\pgsqlFile
-
core/
modules/ pgsql/ src/ Driver/ Database/ pgsql/ Insert.php
View source
<?php
namespace Drupal\pgsql\Driver\Database\pgsql;
use Drupal\Core\Database\DatabaseExceptionWrapper;
use Drupal\Core\Database\Query\Insert as QueryInsert;
// cSpell:ignore nextval setval
/**
* @ingroup database
* @{
*/
/**
* PostgreSQL implementation of \Drupal\Core\Database\Query\Insert.
*/
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;
}
$stmt = $this->connection
->prepareStatement((string) $this, $this->queryOptions);
// 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]) && $insert_values[$idx] !== NULL) {
$blobs[$blob_count] = fopen('php://memory', 'a');
fwrite($blobs[$blob_count], $insert_values[$idx]);
rewind($blobs[$blob_count]);
$stmt->getClientStatement()
->bindParam(':db_insert_placeholder_' . $max_placeholder++, $blobs[$blob_count], \PDO::PARAM_LOB);
// Pre-increment is faster in PHP than increment.
++$blob_count;
}
else {
$stmt->getClientStatement()
->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,
]);
}
}
}
}
if (!empty($this->fromQuery)) {
// bindParam stores only a reference to the variable that is followed when
// the statement is executed. We pass $arguments[$key] instead of $value
// because the second argument to bindParam is passed by reference and
// the foreach statement assigns the element to the existing reference.
$arguments = $this->fromQuery
->getArguments();
foreach ($arguments as $key => $value) {
$stmt->getClientStatement()
->bindParam($key, $arguments[$key]);
}
}
// 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 {
$stmt->execute(NULL, $this->queryOptions);
if (isset($table_information->serial_fields[0])) {
$last_insert_id = $stmt->fetchField();
}
$this->connection
->releaseSavepoint();
} catch (\Exception $e) {
$this->connection
->rollbackSavepoint();
$this->connection
->exceptionHandler()
->handleExecutionException($e, $stmt, [], $this->queryOptions);
}
// Re-initialize the values array so that we can re-use this query.
$this->insertValues = [];
return $last_insert_id ?? NULL;
}
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);
// 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) . ') ' : ' ';
$query = $comments . 'INSERT INTO {' . $this->table . '}' . $insert_fields_string . $this->fromQuery;
}
else {
$query = $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES ';
$values = $this->getInsertPlaceholderFragment($this->insertValues, $this->defaultFields);
$query .= implode(', ', $values);
}
try {
// Fetch the list of blobs and sequences used on that table.
$table_information = $this->connection
->schema()
->queryTableInformation($this->table);
if (isset($table_information->serial_fields[0])) {
// Use RETURNING syntax to get the last insert ID in the same INSERT
// query, see https://www.postgresql.org/docs/12/dml-returning.html.
$query .= ' RETURNING ' . $table_information->serial_fields[0];
}
} catch (DatabaseExceptionWrapper $e) {
// If we fail to get the table information it is probably because the
// table does not exist yet so adding the returning statement is pointless
// because the query will fail. This happens for tables created on demand,
// for example, cache tables.
}
return $query;
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
Insert | PostgreSQL implementation of \Drupal\Core\Database\Query\Insert. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.