Pdo\Pgsql クラス

(PHP 8 >= 8.4.0)

はじめに

PostgreSQL PDO ドライバによる接続を示す PDO サブクラスです。

このドライバは PostgreSQL 方言向けに専用の SQL クエリパーサーをサポートしています。 次のものを処理可能です:

  • シングルクオートやダブルクオートで囲まれたリテラルでのクオートの二重化によるエスケープ
  • C 言語形式の「エスケープ」文字列リテラル
  • ドル記号で囲まれた文字列リテラル
  • 2 つのハイフンによるコメント、ネストされていない C 言語形式のコメント
  • ? 演算子のエスケープシーケンスとしての ?? のサポート

クラス概要

namespace Pdo;
class Pgsql extends PDO {
/* 継承した定数 */
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;
/* 定数 */
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;
/* メソッド */
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
/* 継承したメソッド */
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
}

定義済み定数

Pdo\Pgsql::ATTR_DISABLE_PREPARES
SQL文とパラメータを一緒に、一回のコールでサーバーに送信します。 これによって、名前付きのプリペアドステートメントを別々に作ることを避けられます。 SQL文が一度しか実行されない場合、 不要なサーバーとの通信を避けられるので、レイテンシを抑えることができます。
Pdo\Pgsql::ATTR_RESULT_MEMORY_SIZE
指定されたクエリ結果 PDOStatement インスタンスに割り当てられたメモリ使用量をバイト単位で返します。 クエリ実行前で結果が存在しない場合は null を返します。
PDO::ATTR_PREFETCH
PHP 8.5.0 以降、この属性を 0 に設定すると、遅延（1行ずつの）フェッチが有効になります。 最初の PDOStatement::fetch() の呼び出しの前に結果セット全体をメモリにバッファリングするのではなく、 フェッチするたびにサーバーから1行ずつ取得します。 これによって、大きな結果セットでのメモリ使用量を削減できます。 それ以外の値の場合は、デフォルトのバッファリング動作のままになります。 この属性は、PDO::setAttribute() を使って接続ごとに設定するか、 PDO::prepare() や PDO::query() のドライバオプションを使ってステートメントごとに設定できます。
警告

遅延モードでは、1つの接続で同時にアクティブにできるステートメントは1つだけです。 別のステートメントを実行すると、前のステートメントの読み取っていない行は暗黙のうちに破棄されます。 エラーは発生しません。

Pdo\Pgsql::TRANSACTION_IDLE
警告

この定数は何の効果もなく、PHP 8.5.0 以降は非推奨です。

Pdo\Pgsql::TRANSACTION_ACTIVE
警告

この定数は何の効果もなく、PHP 8.5.0 以降は非推奨です。

Pdo\Pgsql::TRANSACTION_INTRANS
警告

この定数は何の効果もなく、PHP 8.5.0 以降は非推奨です。

Pdo\Pgsql::TRANSACTION_INERROR
警告

この定数は何の効果もなく、PHP 8.5.0 以降は非推奨です。

Pdo\Pgsql::TRANSACTION_UNKNOWN
警告

この定数は何の効果もなく、PHP 8.5.0 以降は非推奨です。

目次