pg-parameter-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<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>
    PostgreSQL 8.0 で指定できるパラメータには以下が含まれます。
    <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_encoding</literal>、<literal>TimeZone</literal> および
    <literal>integer_datetimes</literal> は 8.0 より前のバージョンでは指定できません）。
    <literal>server_version</literal>、<literal>server_encoding</literal> および <literal>integer_datetimes</literal>
    は、PostgreSQL の稼動中には変更できないことに注意しましょう。
  </para>
  <para>
    PostgreSQL 7.3 以前のサーバーはパラメータ設定を通知する機能を持っていません。
    しかし、<function>pg_parameter_status</function> には
    <literal>server_version</literal> および <literal>client_encoding</literal>
    を取得する機能を組み込んでいます。これらの値を取得するためにアプリケーションで
    アドホックなコードを書くのではなく、<function>pg_parameter_status</function>
    を使用することを推奨します。
  </para>
  <caution>
    <para>
      7.4 より前の PostgreSQL サーバーでは、接続の確立後に <literal>SET</literal>
      を用いて <literal>client_encoding</literal> を変更しても
      <function>pg_parameter_status</function> には反映されません。
     </para>
  </caution>
 </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">
<![CDATA[
<?php
  $dbconn = pg_connect("dbname=publisher") or die("Could not connect");

  echo "Server encoding: ", pg_parameter_status($dbconn, "server_encoding");
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Server encoding: SQL_ASCII
]]>
    </screen>
   </example>
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->