サーバーのパラメータ設定を検索する

# pg_parameter_status

(PHP 5, PHP 7, PHP 8)

pg_parameter_status — サーバーのパラメータ設定を検索する

### 説明

function pg_parameter_status(PgSql\Connection `$connection` = ?, string `$name`): string|false

サーバーのパラメータ設定を検索します。

いくつかのパラメータについては、接続の確立時や値の変更時にサーバーから 自動的に通知されます。pg_parameter_status() は これらの設定問い合わせるために使用可能です。指定したパラメータが存在する 場合にその値を、存在しない場合に `false` を返します。

サーバーから通知されるパラメータには以下が含まれます。 `server_version`、 `server_encoding`、`client_encoding`、 `is_superuser`、`session_authorization`、 `DateStyle`、`TimeZone` および `integer_datetimes`。 `server_version`、`server_encoding` および `integer_datetimes` は、PostgreSQL の稼動中には変更できないことに注意しましょう。

### パラメータ

`connection`

  PgSql\Connection クラスのインスタンス。 `connection` が指定されない場合は、デフォルトの接続を使います。 デフォルトの接続とは、pg_connect() または pg_pconnect() によって確立された直近の接続です。

  警告

  PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。

`name`

  指定可能な `name` には以下が含まれます。 `server_version`、 `server_encoding`、`client_encoding`、 `is_superuser`、`session_authorization`、 `DateStyle`、`TimeZone` および `integer_datetimes`。 この値は、大文字小文字を区別するので注意して下さい。

### 戻り値

パラメータの値を文字列で返します。失敗した場合や `name` が間違っている場合には `false` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | `connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。

### 例

例1 pg_parameter_status() の例

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

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

上の例の出力は以下となります。

    Server encoding: SQL_ASCII

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open