pg_parameter_status

(PHP 5, PHP 7, PHP 8)

pg_parameter_status — Перегляд поточних значень параметрів сервера

Опис

pg_parameter_status(PgSql\Connection $connection = ?, string $param_name): string

Отримує поточне значення параметра сервера.

Значення деяких параметрів сервер автоматично повідомляється під час встановлення підключення або зміни даних. Функція pg_parameter_status() може вимагати подібні значення. Вона повертає значення параметра, якщо його визначено, або **false**в случае возникновения ошибки.

Список параметрів серверів PostgreSQL версій 8.0 та вище: server_version server_encoding client_encoding is_superuser session_authorization DateStyle TimeZone, иinteger_datetimes. server_encoding TimeZone, иinteger_datetimes не визначаються для версій нижче 8.0.) server_version server_encodingиinteger_datetimesнельзя изменить после запуска PostgreSQL.

Незважаючи на те, що PostgreSQL версій 7.3 і нижче не повідомляють значень своїх параметрів, pg_parameter_status() дозволяє визначити значення параметрів server_versionиclient_encoding. Для визначення значень цих параметрів краще використовувати pg_parameter_status(), ніж спеціально розробляти інші функції.

Застереження

Якщо під час використання сервера PostgreSQL версій 7.4 і нижче змінити параметр client_encoding за допомогою команди сервера SETуже после установки соединения, функцияpg_parameter_status() не зможе відобразити цей факт.

Список параметрів

connection

Екземпляр PgSql\Connection. Якщо параметр connection не вказано, буде вибрано стандартне з'єднання. Стандартне з'єднання — це останнє з'єднання, яке встановила функція pg_connect() або pg_pconnect()

Увага

Починаючи з версії PHP 8.1.0, використання стандартного з'єднання застаріло.

param_name

Допустимі значення аргументу: server_version server_encoding client_encoding is_superuser session_authorization DateStyle TimeZoneиinteger_datetimes. Зверніть увагу, що це значення чутливе до регістру.

Значення, що повертаються

Значення запитуваного параметра у вигляді рядка, або false, якщо передано неприпустимий параметр.

список змін

ВерсияОпис
8.1.0Параметрconnection тепер чекає екземпляр PgSql\Connection; раніше очікувався ресурс (resource

Приклади

Приклад #1 Приклад використання pg_parameter_status()****

Loading...

Результат виконання наведеного прикладу:

Кодировка сервера: SQL_ASCII