1. 8.5.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  2. 8.5.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  3. 8.5.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  4. 8.5.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  5. 8.0.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  6. 8.0.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  7. 8.0.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  8. 8.0.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  9. 8.1.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  10. 8.1.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  11. 8.1.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  12. 8.1.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  13. 8.2.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  14. 8.2.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  15. 8.2.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  16. 8.2.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  17. 8.3.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  18. 8.3.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  19. 8.3.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  20. 8.3.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  21. 8.4.x core/lib/Drupal/Core/Database/Query/Insert.php Insert
  22. 8.4.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  23. 8.4.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  24. 8.4.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  25. 8.6.x core/lib/Drupal/Core/Database/Driver/sqlite/Insert.php Insert
  26. 8.6.x core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php Insert
  27. 8.6.x core/lib/Drupal/Core/Database/Driver/mysql/Insert.php Insert
  28. 8.6.x core/lib/Drupal/Core/Database/Query/Insert.php Insert

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


Expanded class hierarchy of Insert

Related topics

1 string reference to 'Insert'
Connection::insert in core/lib/Drupal/Core/Database/Connection.php
Prepares and returns an INSERT query object.


core/lib/Drupal/Core/Database/Driver/pgsql/Insert.php, line 16


View source
class Insert extends QueryInsert {
  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
    $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]);
            ->bindParam(':db_insert_placeholder_' . $max_placeholder++, $blobs[$blob_count], \PDO::PARAM_LOB);

          // Pre-increment is faster in PHP than increment.
        else {
            ->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];

            // Force $last_insert_id to the specified value. This is only done
            // if $index is 0.
            if ($index == 0) {
              $last_insert_id = $serial_value;

            // 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.
              ->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
      foreach ($arguments as $key => $value) {
          ->bindParam($key, $arguments[$key]);

    // PostgreSQL requires the table name to be specified explicitly
    // when requesting the last insert ID, so we pass that in via
    // the options array.
    $options = $this->queryOptions;
    if (!empty($table_information->sequences)) {
      $options['sequence_name'] = $table_information->sequences[0];
    elseif ($options['return'] == Database::RETURN_INSERT_ID) {
      $options['return'] = Database::RETURN_NULL;

    // 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.
    try {

      // Only use the returned last_insert_id if it is not already set.
      if (!empty($last_insert_id)) {
          ->query($stmt, [], $options);
      else {
        $last_insert_id = $this->connection
          ->query($stmt, [], $options);
    } catch (\Exception $e) {
      throw $e;

    // Re-initialize the values array so that we can re-use this query.
    $this->insertValues = [];
    return $last_insert_id;
  public function __toString() {

    // Create a sanitized comment string to prepend to the query.
    $comments = $this->connection

    // 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
    }, $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) . ') ' : ' ';
      return $comments . 'INSERT INTO {' . $this->table . '}' . $insert_fields_string . $this->fromQuery;
    $query = $comments . 'INSERT INTO {' . $this->table . '} (' . implode(', ', $insert_fields) . ') VALUES ';
    $values = $this
      ->getInsertPlaceholderFragment($this->insertValues, $this->defaultFields);
    $query .= implode(', ', $values);
    return $query;



Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
Insert::$fromQuery protected property A SelectQuery object to fetch the rows that should be inserted.
Insert::execute public function Executes the insert query. Overrides Insert::execute
Insert::from public function Sets the fromQuery on this InsertQuery object.
Insert::preExecute protected function Preprocesses and validates the query.
Insert::__construct public function Constructs an Insert object. Overrides Query::__construct
Insert::__toString public function Implements PHP magic __toString method to convert the query to a string. Overrides Insert::__toString
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.
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.