function Insert::__toString

Overrides Insert::__toString

File

core/modules/pgsql/src/Driver/Database/pgsql/Insert.php, line 105

Class

Insert

PostgreSQL implementation of <a href="/api/drupal/core%21lib%21Drupal%21Core%21Database%21Query%21Insert.php/class/Insert/11.x" title="General class for an abstracted INSERT query." class="local">\Drupal\Core\Database\Query\Insert</a>.

Namespace

Code

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;
}