pg-parameter-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: jpauli Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.pg-parameter-status" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_parameter_status</refname>
  <refpurpose>
   Consulte un paramètre de configuration courant du serveur
  </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>
   Consulte un paramètre de configuration courant du serveur.
  </para>
  <para>
   Certaines valeurs de paramètres sont retournées par le serveur
   automatiquement lors du démarrage de la connexion ou lorsqu'une valeur
   change. <function>pg_parameter_status</function> peut être utilisée pour
   interroger ces configurations. La fonction retourne la valeur courante du
   paramètre s'il et connu ou &false; si le paramètre est inconnu. 
  </para>
  <para>
   Les paramètres retournés par PostgreSQL 8.0 sont <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> et <literal>integer_datetimes</literal>.
   (<literal>server_encoding</literal>, <literal>TimeZone</literal> et 
   <literal>integer_datetimes</literal> n'étaient pas retournés dans les
   versions antérieures à 8.0.) Notez que 
   <literal>server_version</literal>, <literal>server_encoding</literal> et <literal>integer_datetimes</literal> 
   ne peuvent changer après le démarrage de PostgreSQL.
  </para>
  <para>
   Les serveurs PostgreSQL 7.3 ou de versions inférieures ne retournent pas de paramètres de
   configurations, <function>pg_parameter_status</function> inclut une logique
   pour obtenir des valeurs pour <literal>server_version</literal> et
   <literal>client_encoding</literal> quand même. Les applications devraient
   utiliser <function>pg_parameter_status</function> au lieu du code ad hoc
   pour déterminer ces valeurs.
  </para>
  <caution>
   <para>
    Sur les versions des serveurs PostgreSQL 7.4 et antérieures, le changement de
    <literal>client_encoding</literal> avec <literal>SET</literal> après le
    démarrage de la connexion ne sera pas réfléchie par
    <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>
       Les valeurs possibles de <parameter>param_name</parameter> sont
       <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> et <literal>integer_datetimes</literal>.
       Il est à noter que cette valeur est sensible à la casse.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Une chaîne contenant la valeur du paramètre, &false; en cas d'échec ou
   du paramètre <parameter>param_name</parameter> invalide.
  </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>Exemple avec <function>pg_parameter_status</function></title>
    <programlisting role="php">
<![CDATA[
<?php
  $dbconn = pg_connect("dbname=publisher") or die("Connexion impossible");

  echo "Encodage du serveur : ", pg_parameter_status($dbconn, "server_encoding");
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Encodage du serveur : 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
-->