La classe Pdo\Pgsql

(PHP 8 >= 8.4.0)

Introduction

Une sous-classe de PDO représentant une connexion utilisant le pilote PostgreSQL PDO.

Ce pilote supporte un analyseur de requêtes SQL dédié pour le dialecte PostgreSQL. Il peut gérer les éléments suivants :

Les littéraux de chaînes simples et doubles, avec le doublement comme mécanisme d'échappement
Les littéraux de chaînes "échappées" de style C
Les littéraux de chaînes en dollars
Deux tirets et les commentaires de style C (non imbriqués)
Le support de ?? comme séquence d'échappement pour l'opérateur ?.

Note:
Comme cet analyseur reconnaît les littéraux de chaînes délimitées par des dollars, les points d'interrogation présents à l'intérieur ne sont pas traités comme des marqueurs de paramètre et n'ont pas besoin d'être échappés. À partir de PHP 8.4.0, l'échappement des points d'interrogation sous la forme ?? à l'intérieur d'une chaîne délimitée par des dollars est déprécié.

Synopsis de la classe

namespace Pdo;

class Pgsql extends PDO {

/* Constantes héritées */

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;

/* Constantes */

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;

/* Méthodes */

public function copyFromArray(
    string $tableName,
    array|Traversable $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

/* Méthodes héritées */

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

}

Constantes pré-définies

Pdo\Pgsql::ATTR_DISABLE_PREPARES

Envoie la requête et les paramètres au serveur en une seule fois, évitant le besoin de créer une instruction préparée nommée séparément. Si la requête va être exécutée une seule fois, cela peut réduire la latence en évitant un aller-retour inutile au serveur.

Pdo\Pgsql::ATTR_RESULT_MEMORY_SIZE

Renvoie la quantité de mémoire, en octets, allouée à l'instance de PDOStatement de résultat de requête spécifiée, ou null si aucun résultat n'existe avant l'exécution de la requête.

PDO::ATTR_PREFETCH

À partir de PHP 8.5.0, définir cet attribut à 0 active la lecture paresseuse (ligne par ligne) : les lignes sont récupérées depuis le serveur une par une au fur et à mesure de leur lecture, au lieu de mettre en mémoire tampon l'ensemble du jeu de résultats avant le premier appel à PDOStatement::fetch(). Cela réduit l'utilisation de la mémoire pour les grands jeux de résultats. Toute autre valeur conserve le comportement par défaut avec mise en mémoire tampon.

Il peut être défini par connexion avec PDO::setAttribute(), ou par instruction via les options de pilote de PDO::prepare() ou PDO::query().

Attention

En mode paresseux, une connexion ne peut avoir qu'une seule instruction active à la fois. L'exécution d'une autre instruction ignore silencieusement les lignes non lues de la précédente ; aucune erreur n'est levée.

Pdo\Pgsql::TRANSACTION_IDLE

Avertissement