class Insert in Drupal 9
Same name in this branch
- 9 core/lib/Drupal/Core/Database/Query/Insert.php \Drupal\Core\Database\Query\Insert
- 9 core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php \Drupal\Core\Database\Driver\sqlite\Insert
- 9 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php \Drupal\Core\Database\Driver\pgsql\Insert
- 9 core/lib/Drupal/Core/Database/Driver/mysql/Insert.php \Drupal\Core\Database\Driver\mysql\Insert
- 9 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/Insert.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\Insert
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysql/Insert.php \Drupal\driver_test\Driver\Database\DrivertestMysql\Insert
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestPgsql/Insert.php \Drupal\driver_test\Driver\Database\DrivertestPgsql\Insert
- 9 core/modules/system/tests/modules/driver_test/src/Driver/Database/DrivertestMysqlDeprecatedVersion/Insert.php \Drupal\driver_test\Driver\Database\DrivertestMysqlDeprecatedVersion\Insert
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php \Drupal\Core\Database\Driver\pgsql\Insert
- 10 core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php \Drupal\Core\Database\Driver\pgsql\Insert
PostgreSQL implementation of \Drupal\Core\Database\Query\Insert.
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\Core\Database\Driver\pgsql\Insert
- class \Drupal\Core\Database\Query\Insert implements \Drupal\Core\Database\Query\Countable uses InsertTrait
Expanded class hierarchy of Insert
Related topics
1 file declares its use of Insert
- Insert.php in core/
modules/ system/ tests/ modules/ driver_test/ src/ Driver/ Database/ DrivertestPgsql/ Insert.php
3 string references to 'Insert'
- Connection::getDriverClass in core/
lib/ Drupal/ Core/ Database/ Connection.php - Gets the driver-specific override class if any for the specified class.
- Connection::insert in core/
lib/ Drupal/ Core/ Database/ Connection.php - Prepares and returns an INSERT query object.
- ConnectionTest::providerGetDriverClass in core/
tests/ Drupal/ Tests/ Core/ Database/ ConnectionTest.php - Data provider for testGetDriverClass().
File
- core/
lib/ Drupal/ Core/ Database/ Driver/ pgsql/ Insert.php, line 19
Namespace
Drupal\Core\Database\Driver\pgsqlView source
class Insert extends QueryInsert {
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 (\PDOException $e) {
$this->connection
->rollbackSavepoint();
$message = $e
->getMessage() . ": " . $stmt
->getQueryString();
// Match all SQLSTATE 23xxx errors.
if (substr($e
->getCode(), -6, -3) == '23') {
throw new IntegrityConstraintViolationException($message, $e
->getCode(), $e);
}
else {
throw new DatabaseExceptionWrapper($message, 0, $e
->getCode());
}
} catch (\Exception $e) {
$this->connection
->rollbackSavepoint();
throw $e;
}
// 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/10/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;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Insert:: |
protected | property | A SelectQuery object to fetch the rows that should be inserted. | |
Insert:: |
public | function |
Executes the insert query. Overrides Insert:: |
|
Insert:: |
public | function | Sets the fromQuery on this InsertQuery object. | |
Insert:: |
protected | function | Preprocesses and validates the query. | |
Insert:: |
public | function |
Constructs an Insert object. Overrides Query:: |
|
Insert:: |
public | function |
Implements PHP magic __toString method to convert the query to a string. Overrides Insert:: |
|
InsertTrait:: |
protected | property | An array of fields that should be set to their database-defined defaults. | |
InsertTrait:: |
protected | property | An array of fields on which to insert. | |
InsertTrait:: |
protected | property | A nested array of values to insert. | |
InsertTrait:: |
protected | property | The table on which to insert. | |
InsertTrait:: |
public | function | ||
InsertTrait:: |
public | function | Adds a set of field->value pairs to be inserted. | |
InsertTrait:: |
protected | function | Returns the query placeholders for values that will be inserted. | |
InsertTrait:: |
public | function | Specifies fields for which the database defaults should be used. | |
InsertTrait:: |
public | function | Adds another set of values to the query to be inserted. | |
Query:: |
protected | property | An array of comments that can be prepended to a query. | |
Query:: |
protected | property | The connection object on which to run this query. | |
Query:: |
protected | property | The key of the connection object. | |
Query:: |
protected | property | The target of the connection object. | |
Query:: |
protected | property | The placeholder counter. | |
Query:: |
protected | property | The query options to pass on to the connection object. | |
Query:: |
protected | property | A unique identifier for this query object. | |
Query:: |
public | function | Adds a comment to the query. | |
Query:: |
public | function | Returns a reference to the comments array for the query. | |
Query:: |
public | function | Gets the database connection to be used for the query. | |
Query:: |
public | function |
Gets the next placeholder value for this query object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function |
Returns a unique identifier for this object. Overrides PlaceholderInterface:: |
|
Query:: |
public | function | Implements the magic __clone function. | 1 |
Query:: |
public | function | Implements the magic __sleep function to disconnect from the database. | |
Query:: |
public | function | Implements the magic __wakeup function to reconnect to the database. |