php-src/ext/pdo_pgsql/pgsql_driver.stub.php
Guillaume Outters c265b9085a
ext/pdo_pgsql: adding pgsqlSetNoticeCallback
Allows a callback to be triggered on every notice sent by PostgreSQL.

Such notices can be sent with a RAISE NOTICE in PL/pgSQL; in a long running
stored procedure, they prove useful as realtime checkpoint indicators.

close GH-6764
2024-05-22 12:32:11 +01:00

39 lines
1.5 KiB
PHP

<?php
/** @generate-function-entries */
/**
* These are extension methods for PDO. This is not a real class.
* @undocumentable
*/
class PDO_PGSql_Ext {
/** @tentative-return-type */
public function pgsqlCopyFromArray(string $tableName, array $rows, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): bool {}
/** @tentative-return-type */
public function pgsqlCopyFromFile(string $tableName, string $filename, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): bool {}
/** @tentative-return-type */
public function pgsqlCopyToArray(string $tableName, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): array|false {}
/** @tentative-return-type */
public function pgsqlCopyToFile(string $tableName, string $filename, string $separator = "\t", string $nullAs = "\\\\N", ?string $fields = null): bool {}
/** @tentative-return-type */
public function pgsqlLOBCreate(): string|false {}
/** @return resource|false */
public function pgsqlLOBOpen(string $oid, string $mode = "rb") {}
/** @tentative-return-type */
public function pgsqlLOBUnlink(string $oid): bool {}
/** @tentative-return-type */
public function pgsqlGetNotify(int $fetchMode = PDO::FETCH_DEFAULT, int $timeoutMilliseconds = 0): array|false {}
/** @tentative-return-type */
public function pgsqlGetPid(): int {}
/** @tentative-return-type */
public function pgsqlSetNoticeCallback(?callable $callback): void {}
}