Home/ Manual/ pgsql / functions/ pg_parameter_status

pg_parameter_status

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Looks up a current parameter setting of the server

Description

pg_parameter_status([PgSql\Connection $connection], string $name): string|false

Looks up a current parameter setting of the server.

Certain parameter values are reported by the server automatically at connection startup or whenever their values change. pg_parameter_status() can be used to interrogate these settings. It returns the current value of a parameter if known, or false if the parameter is not known.

Parameters reported by the server include server_version, server_encoding, client_encoding, is_superuser, session_authorization, DateStyle, TimeZone, and integer_datetimes. Note that server_version, server_encoding and integer_datetimes cannot change after PostgreSQL startup.

Parameters

connection: Connection-with-unspecified-default
name: Possible name values include server_version, server_encoding, client_encoding, is_superuser, session_authorization, DateStyle, TimeZone, and integer_datetimes. Note that this value is case-sensitive.

Return Values

A string containing the value of the parameter, false on failure or invalid name.

Changelog

Version	Description

Examples

pg_parameter_status() example

php

<?php
  $dbconn = pg_connect("dbname=publisher") or die("Could not connect");

  echo "Server encoding: ", pg_parameter_status($dbconn, "server_encoding");
?>

The above example will output:

output

Server encoding: SQL_ASCII

Source: reference/pgsql/functions/pg-parameter-status.xml · from the official PHP manual (php/doc-en)