<?xml version="1.0" encoding="utf-8"?>

<refentry xml:id="function.pg-parameter-status" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>pg_parameter_status</refname>

<refpurpose>サーバーのパラメータ設定を検索する</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>pg_parameter_status</methodname>

<methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>

<methodparam><type>string</type><parameter>param_name</parameter></methodparam>

</methodsynopsis>

<para>

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

</para>

<para>

いくつかのパラメータについては、接続の確立時や値の変更時にサーバーから

自動的に通知されます。<function>pg_parameter_status</function> は

これらの設定問い合わせるために使用可能です。指定したパラメータが存在する

場合にその値を、存在しない場合に &false; を返します。

</para>

<para>

サーバーから通知されるパラメータには以下が含まれます。

<literal>server_version</literal>、

<literal>server_encoding</literal>、<literal>client_encoding</literal>、

<literal>is_superuser</literal>、<literal>session_authorization</literal>、

<literal>DateStyle</literal>、<literal>TimeZone</literal> および <literal>integer_datetimes</literal>。

<literal>server_version</literal>、<literal>server_encoding</literal> および <literal>integer_datetimes</literal>

は、PostgreSQL の稼動中には変更できないことに注意しましょう。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>connection</parameter></term>

<listitem>

&pgsql.parameter.connection-with-unspecified-default;

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>param_name</parameter></term>

<listitem>

<para>

指定可能な <parameter>param_name</parameter> には以下が含まれます。

<literal>server_version</literal>、

<literal>server_encoding</literal>、<literal>client_encoding</literal>、

<literal>is_superuser</literal>、<literal>session_authorization</literal>、

<literal>DateStyle</literal>、<literal>TimeZone</literal> および

<literal>integer_datetimes</literal>。

この値は、大文字小文字を区別するので注意して下さい。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

パラメータの値を文字列で返します。失敗した場合や

<parameter>param_name</parameter> が間違っている場合には

&false; を返します。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

&pgsql.changelog.connection-object;

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>pg_parameter_status</function> の例</title>

<programlisting role="php">

</programlisting>

&example.outputs;

<screen>

</screen>

</example>

</para>

</refsect1>

</refentry>