pg-parameter-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<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>
     Если при использовании сервера PostgreSQL версий 7.4 и ниже изменить параметр
     <literal>client_encoding</literal> посредством команды сервера
     <literal>SET</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>
       Допустимые значения аргумента: <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>
   Значение запрашиваемого параметра в виде строки, либо &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("Невозможно соединиться с сервером");

  echo "Кодировка сервера: ", pg_parameter_status($dbconn, "server_encoding");
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Кодировка сервера: 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
-->