The Pdo\Pgsql class

(PHP 8 >= 8.4.0)

Introduction

A PDO subclass representing a connection using the PostgreSQL PDO driver.

This driver supports a dedicated SQL query parser for the PostgreSQL dialect. It can handle the following:

Single and double-quoted literals, with doubling as escaping mechanism
C-style "escape" string literals
Dollar-quoted string literals
Two-dashes and C-style comments (non-nested).
Support for ?? as escape sequence for the ? operator.

Class synopsis

namespace Pdo;

class Pgsql extends PDO {

/* Inherited constants */

public const int PDO::PARAM_NULL ;

public const int PDO::PARAM_BOOL = 5;

public const int PDO::PARAM_INT = 1;

public const int PDO::PARAM_STR = 2;

public const int PDO::PARAM_LOB = 3;

public const int PDO::PARAM_STMT = 4;

public const int PDO::PARAM_INPUT_OUTPUT ;

public const int PDO::PARAM_STR_NATL ;

public const int PDO::PARAM_STR_CHAR ;

public const int PDO::PARAM_EVT_ALLOC ;

public const int PDO::PARAM_EVT_FREE ;

public const int PDO::PARAM_EVT_EXEC_PRE ;

public const int PDO::PARAM_EVT_EXEC_POST ;

public const int PDO::PARAM_EVT_FETCH_PRE ;

public const int PDO::PARAM_EVT_FETCH_POST ;

public const int PDO::PARAM_EVT_NORMALIZE ;

public const int PDO::FETCH_DEFAULT ;

public const int PDO::FETCH_LAZY ;

public const int PDO::FETCH_ASSOC ;

public const int PDO::FETCH_NUM ;

public const int PDO::FETCH_BOTH ;

public const int PDO::FETCH_OBJ ;

public const int PDO::FETCH_BOUND ;

public const int PDO::FETCH_COLUMN ;

public const int PDO::FETCH_CLASS ;

public const int PDO::FETCH_INTO ;

public const int PDO::FETCH_FUNC ;

public const int PDO::FETCH_GROUP ;

public const int PDO::FETCH_UNIQUE ;

public const int PDO::FETCH_KEY_PAIR ;

public const int PDO::FETCH_CLASSTYPE ;

public const int PDO::FETCH_SERIALIZE ;

public const int PDO::FETCH_PROPS_LATE ;

public const int PDO::FETCH_NAMED ;

public const int PDO::ATTR_AUTOCOMMIT ;

public const int PDO::ATTR_PREFETCH ;

public const int PDO::ATTR_TIMEOUT ;

public const int PDO::ATTR_ERRMODE ;

public const int PDO::ATTR_SERVER_VERSION ;

public const int PDO::ATTR_CLIENT_VERSION ;

public const int PDO::ATTR_SERVER_INFO ;

public const int PDO::ATTR_CONNECTION_STATUS ;

public const int PDO::ATTR_CASE ;

public const int PDO::ATTR_CURSOR_NAME ;

public const int PDO::ATTR_CURSOR ;

public const int PDO::ATTR_ORACLE_NULLS ;

public const int PDO::ATTR_PERSISTENT ;

public const int PDO::ATTR_STATEMENT_CLASS ;

public const int PDO::ATTR_FETCH_TABLE_NAMES ;

public const int PDO::ATTR_FETCH_CATALOG_NAMES ;

public const int PDO::ATTR_DRIVER_NAME ;

public const int PDO::ATTR_STRINGIFY_FETCHES ;

public const int PDO::ATTR_MAX_COLUMN_LEN ;

public const int PDO::ATTR_EMULATE_PREPARES ;

public const int PDO::ATTR_DEFAULT_FETCH_MODE ;

public const int PDO::ATTR_DEFAULT_STR_PARAM ;

public const int PDO::ERRMODE_SILENT ;

public const int PDO::ERRMODE_WARNING ;

public const int PDO::ERRMODE_EXCEPTION ;

public const int PDO::CASE_NATURAL ;

public const int PDO::CASE_LOWER ;

public const int PDO::CASE_UPPER ;

public const int PDO::NULL_NATURAL ;

public const int PDO::NULL_EMPTY_STRING ;

public const int PDO::NULL_TO_STRING ;

public const string PDO::ERR_NONE ;

public const int PDO::FETCH_ORI_NEXT ;

public const int PDO::FETCH_ORI_PRIOR ;

public const int PDO::FETCH_ORI_FIRST ;

public const int PDO::FETCH_ORI_LAST ;

public const int PDO::FETCH_ORI_ABS ;

public const int PDO::FETCH_ORI_REL ;

public const int PDO::CURSOR_FWDONLY ;

public const int PDO::CURSOR_SCROLL ;

/* Constants */

public const int ATTR_DISABLE_PREPARES ;

public const int ATTR_RESULT_MEMORY_SIZE ;

public const int TRANSACTION_IDLE ;

public const int TRANSACTION_ACTIVE ;

public const int TRANSACTION_INTRANS ;

public const int TRANSACTION_INERROR ;

public const int TRANSACTION_UNKNOWN ;

/* Methods */

public function copyFromArray (
string $tableName,
array $rows,
string $separator = "\t",
string $nullAs = "\\\\N",
? string $fields = null
): bool

public function copyFromFile (
string $tableName,
string $filename,
string $separator = "\t",
string $nullAs = "\\\\N",
? string $fields = null
): bool

public function copyToArray (
string $tableName,
string $separator = "\t",
string $nullAs = "\\\\N",
? string $fields = null
): array |false

public function copyToFile (
string $tableName,
string $filename,
string $separator = "\t",
string $nullAs = "\\\\N",
? string $fields = null
): bool

public function escapeIdentifier (string $input): string

public function getNotify (int $fetchMode = PDO::FETCH_DEFAULT , int $timeoutMilliseconds = 0): array |false

public function getPid (): int

public function lobCreate (): string |false

public function lobOpen (string $oid, string $mode = "rb"): resource |false

public function lobUnlink (string $oid): bool

public function setNoticeCallback (? callable $callback): void

/* Inherited methods */

public function PDO::__construct (
string $dsn,
? string $username = null ,
#[\SensitiveParameter] ? string $password = null ,
? array $options = null
)

public function PDO::beginTransaction (): bool

public function PDO::commit (): bool

public static function PDO::connect (
string $dsn,
? string $username = null ,
#[\SensitiveParameter] ? string $password = null ,
? array $options = null
): static

public function PDO::errorCode (): ? string

public function PDO::errorInfo (): array

public function PDO::exec (string $statement): int |false

public function PDO::getAttribute (int $attribute): mixed

public static function PDO::getAvailableDrivers (): array

public function PDO::inTransaction (): bool

public function PDO::lastInsertId (? string $name = null ): string |false

public function PDO::prepare (string $query, array $options = []): PDOStatement |false

public function PDO::query (string $query, ? int $fetchMode = null ): PDOStatement |false

public function PDO::query (string $query, ? int $fetchMode = PDO::FETCH_COLUMN, int $colno): PDOStatement |false

public function PDO::query (
string $query,
? int $fetchMode = PDO::FETCH_CLASS,
string $classname,
array $constructorArgs
): PDOStatement |false

public function PDO::query (string $query, ? int $fetchMode = PDO::FETCH_INTO, object $object): PDOStatement |false

public function PDO::quote (string $string, int $type = PDO::PARAM_STR ): string |false

public function PDO::rollBack (): bool

public function PDO::setAttribute (int $attribute, mixed $value): bool

}

Predefined Constants

Pdo\Pgsql::ATTR_DISABLE_PREPARES: Send the query and the parameters to the server together in a single call, avoiding the need to create a named prepared statement separately. If the query is only going to be executed once this can reduce latency by avoiding an unnecessary server round-trip.
Pdo\Pgsql::ATTR_RESULT_MEMORY_SIZE: Returns the amount of memory, in bytes, allocated to the specified query result PDOStatement instance, or null if no results exist before the query is executed.
Pdo\Pgsql::TRANSACTION_IDLE
Pdo\Pgsql::TRANSACTION_ACTIVE
Pdo\Pgsql::TRANSACTION_INTRANS
Pdo\Pgsql::TRANSACTION_INERROR
Pdo\Pgsql::TRANSACTION_UNKNOWN

Pdo\Pgsql::copyFromArray — Copy data from a PHP array into a table
Pdo\Pgsql::copyFromFile — Copy data from file into table
Pdo\Pgsql::copyToArray — Copy data from database table into PHP array
Pdo\Pgsql::copyToFile — Copy data from table into file
Pdo\Pgsql::escapeIdentifier — Escapes a string for use as an SQL identifier
Pdo\Pgsql::getNotify — Get asynchronous notification
Pdo\Pgsql::getPid — Get the PID of the backend process handling this connection
Pdo\Pgsql::lobCreate — Creates a new large object
Pdo\Pgsql::lobOpen — Opens an existing large object stream
Pdo\Pgsql::lobUnlink — Deletes the large object
Pdo\Pgsql::setNoticeCallback — Set a callback to handle notice and warning messages generated by the backend

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes

There are no user contributed notes for this page.