db2-server-info.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 871b71764cdca8238069f27436d96011a6a2cb36 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.db2-server-info" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>db2_server_info</refname>
  <refpurpose>Retourne un objet avec des propriétés qui décrivent le serveur de base de données DB2</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>db2_server_info</methodname>
   <methodparam><type>resource</type><parameter>connection</parameter></methodparam>
  </methodsynopsis>

  <para>
   Cette fonction retourne un objet avec des propriétés en lecture seule qui
   retournent des informations à propos le serveur de base de données IBM DB2,
   Cloudscape ou Apache Derby. La table suivante liste les propriétés du
   serveur de base de données :
   <table>
    <title>Propriétés serveur de base de données</title>
    <tgroup cols="3">
     <thead>
      <row>
       <entry>Nom Propriété</entry>
       <entry>Type de retour</entry>
       <entry>Description</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>DBMS_NAME</entry>
       <entry>&string;</entry>
       <entry>Le nom du serveur de base de données sur lequel vous êtes
        connecté. Pour des serveurs DB2, c'est une combinaison de
        <literal>DB2</literal> suivi par le système d'exploitation sur lequel
        le serveur de base de données fonctionne.</entry>
      </row>
      <row>
       <entry>DBMS_VER</entry>
       <entry>&string;</entry>
       <entry>La version du serveur de la base de données, dans la forme d'une
        &string; <literal>"MM.mm.uuuu"</literal> où <varname>MM</varname> est la version majeure,
        <varname>mm</varname> est la version mineure et <varname>uuuu</varname>
        est la mise à jour. Par exemple, <literal>"08.02.0001"</literal> représente la version
        majeure 8, la version mineure 2, la mise à jour 1.
       </entry>
      </row>
      <row>
       <entry>DB_CODEPAGE</entry>
       <entry>&integer;</entry>
       <entry>Le code page de la base de données sur laquelle vous êtes
        connecté.</entry>
      </row>
      <row>
       <entry>DB_NAME</entry>
       <entry>&string;</entry>
       <entry>Le nom de la base de données sur laquelle vous êtes connecté.</entry>
      </row>
      <row>
       <entry>DFT_ISOLATION</entry>
       <entry>&string;</entry>
       <entry>
        <para>Le niveau par défaut d'isolation de transaction supporté par le
        serveur :
        <variablelist>
         <varlistentry>
          <term>UR</term>
          <listitem>
           <para>
            Lecture non-envoyée (<literal>Uncommitted read</literal>) : les changements sont
            immédiatement visibles par toutes les transactions concurrentes.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>CS</term>
          <listitem>
           <para>
            Stabilité du curseur (<literal>Cursor stability</literal>) : une ligne lue par une
            transaction peut être modifiée et envoyée par une seconde
            transaction concurrente.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>RS</term>
          <listitem>
           <para>
            Stabilité de lecture (<literal>Read stability</literal>) : une transaction peut
            ajouter ou supprimer des lignes qui correspondent à une condition
            de recherche ou à une transaction en attente.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>RR</term>
          <listitem>
           <para>
            Lecture répétée (<literal>Repeatable read</literal>) : les données affectées par les
            transaction en attente ne sont pas disponibles aux autres
            transactions.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>NC</term>
          <listitem>
           <para>
            Aucun envoi (<literal>No commit</literal>) : tout changement est visible à la fin
            d'une opération réussie. Les envois explicites et retours
            arrières ne sont pas alloués.
           </para>
          </listitem>
         </varlistentry>
        </variablelist>
        </para>
       </entry>
      </row>
      <row>
       <entry>IDENTIFIER_QUOTE_CHAR</entry>
       <entry>&string;</entry>
       <entry>Le caractère utilisé pour délimiter un identifiant.</entry>
      </row>
      <row>
       <entry>INST_NAME</entry>
       <entry>&string;</entry>
       <entry>L'instance sur le serveur de base de données qui contient la
        base de données.</entry>
      </row>
      <row>
       <entry>ISOLATION_OPTION</entry>
       <entry>&array;</entry>
       <entry>Un tableau d'options d'isolation supporté par le serveur de
       base de données. Les options d'isolation sont décrites dans la
       propriété DFT_ISOLATION.</entry>
      </row>
      <row>
       <entry>KEYWORDS</entry>
       <entry>&array;</entry>
       <entry>Un tableau des mots-clés réservés par le serveur de base de
        données.</entry>
      </row>
      <row>
       <entry>LIKE_ESCAPE_CLAUSE</entry>
       <entry>&boolean;</entry>
       <entry>&true; si le serveur de base de données supporte l'utilisation
       des caractères de remplacement <literal>%</literal> et
       <literal>_</literal>. &false; si le serveur de base de données ne
       supporte pas ces caractères de remplacement.</entry>
      </row>
      <row>
       <entry>MAX_COL_NAME_LEN</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'un nom de colonne supportée par le serveur de
       base de données, exprimée en octets.</entry>
      </row>
      <row>
       <entry>MAX_IDENTIFIER_LEN</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'un identifiant SQL supportée par les serveurs
       de base de données, exprimée en caractères.</entry>
      </row>
      <row>
       <entry>MAX_INDEX_SIZE</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale des colonnes combinées dans un index supporté
       par le serveur de base de données, exprimée en octets.</entry>
      </row>
      <row>
       <entry>MAX_PROC_NAME_LEN</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'un nom de procédure supporté par le serveur de
       base de données, exprimée en octets.</entry>
      </row>
      <row>
       <entry>MAX_ROW_SIZE</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'une ligne dans la table de base supportée par
       le serveur de base de données, exprimée en octets.</entry>
      </row>
      <row>
       <entry>MAX_SCHEMA_NAME_LEN</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'un nom de schéma supporté par le serveur de
       base de données, exprimé en octets.</entry>
      </row>
      <row>
       <entry>MAX_STATEMENT_LEN</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'une requête SQL supporté par le serveur de
       base de données, exprimée en octets.</entry>
      </row>
      <row>
       <entry>MAX_TABLE_NAME_LEN</entry>
       <entry>&integer;</entry>
       <entry>Taille maximale d'un nom de table supporté par le serveur de
       base de données, exprimée en octets.</entry>
      </row>
      <row>
       <entry>NON_NULLABLE_COLUMNS</entry>
       <entry>&boolean;</entry>
       <entry>&true; si le serveur de base de données supporte les colonnes
        qui peuvent être définies comme NOT NULL, &false; si le serveur de base
        de données ne supporte pas les colonnes définies comme NOT
        NULL.</entry>
      </row>
      <row>
       <entry>PROCEDURES</entry>
       <entry>&boolean;</entry>
       <entry>&true; si le serveur de base de données supporte l'utilisation
        de la requête CALL pour appeler les procédures enregistrées, &false; si
        le serveur de base de données ne supporte pas la requête CALL.</entry>
      </row>
      <row>
       <entry>SPECIAL_CHARS</entry>
       <entry>&string;</entry>
       <entry>Une &string; contenant tous les caractères autre que les lettres
       (majuscules et minuscules), les chiffres et le caractère souligné
        qui peuvent être utilisé en tant que nom d'identifiant.</entry>
      </row>
      <row>
       <entry>SQL_CONFORMANCE</entry>
       <entry>&string;</entry>
       <entry>
        <para>Le niveau de conformité à la spécification ANSI/ISO SQL-92
        offert par le serveur de base de données :
        <variablelist>
         <varlistentry>
          <term>ENTRY</term>
          <listitem>
           <para>
            Niveau de conformité SQL-92.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>FIPS127</term>
          <listitem>
           <para>
            Conformité traditionnelle FIPS-127-2.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>FULL</term>
          <listitem>
           <para>
            Niveau complet de conformité SQL-92.
           </para>
          </listitem>
         </varlistentry>
         <varlistentry>
          <term>INTERMEDIATE</term>
          <listitem>
           <para>
            Niveau intermédiaire de conformité SQL-92.
           </para>
          </listitem>
         </varlistentry>
        </variablelist>
        </para>
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>

 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      <para>
       Spécifie la connexion cliente DB2 active.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un objet si l'appel est réussi, &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>db2_server_info</function></title>
    <para>
     Pour récupérer des informations à propos du serveur, vous devez passer
     une ressource de connexion de base de données valide à la fonction
     <function>db2_server_info</function>.
    </para>
    <programlisting role="php"><![CDATA[<?php

$conn = db2_connect('sample', 'db2inst1', 'ibmdb2');

$server = db2_server_info( $conn );

if ($server) {
    echo "DBMS_NAME: ";                 var_dump( $server->DBMS_NAME );
    echo "DBMS_VER: ";                  var_dump( $server->DBMS_VER );
    echo "DB_CODEPAGE: ";               var_dump( $server->DB_CODEPAGE );
    echo "DB_NAME: ";                   var_dump( $server->DB_NAME );
    echo "INST_NAME: ";                 var_dump( $server->INST_NAME );
    echo "SPECIAL_CHARS: ";             var_dump( $server->SPECIAL_CHARS );
    echo "KEYWORDS: ";                  var_dump( sizeof($server->KEYWORDS) );
    echo "DFT_ISOLATION: ";             var_dump( $server->DFT_ISOLATION );
    echo "ISOLATION_OPTION: ";
    $il = '';
    foreach( $server->ISOLATION_OPTION as $opt )
    {
       $il .= $opt." ";
    }
    var_dump( $il );
    echo "SQL_CONFORMANCE: ";           var_dump( $server->SQL_CONFORMANCE );
    echo "PROCEDURES: ";                var_dump( $server->PROCEDURES );
    echo "IDENTIFIER_QUOTE_CHAR: ";     var_dump( $server->IDENTIFIER_QUOTE_CHAR );
    echo "LIKE_ESCAPE_CLAUSE: ";        var_dump( $server->LIKE_ESCAPE_CLAUSE );
    echo "MAX_COL_NAME_LEN: ";          var_dump( $server->MAX_COL_NAME_LEN );
    echo "MAX_ROW_SIZE: ";              var_dump( $server->MAX_ROW_SIZE );
    echo "MAX_IDENTIFIER_LEN: ";        var_dump( $server->MAX_IDENTIFIER_LEN );
    echo "MAX_INDEX_SIZE: ";            var_dump( $server->MAX_INDEX_SIZE );
    echo "MAX_PROC_NAME_LEN: ";         var_dump( $server->MAX_PROC_NAME_LEN );
    echo "MAX_SCHEMA_NAME_LEN: ";       var_dump( $server->MAX_SCHEMA_NAME_LEN );
    echo "MAX_STATEMENT_LEN: ";         var_dump( $server->MAX_STATEMENT_LEN );
    echo "MAX_TABLE_NAME_LEN: ";        var_dump( $server->MAX_TABLE_NAME_LEN );
    echo "NON_NULLABLE_COLUMNS: ";      var_dump( $server->NON_NULLABLE_COLUMNS );

    db2_close($conn);
}
?>]]></programlisting>
    &example.outputs;
    <screen><![CDATA[DBMS_NAME: string(9) "DB2/LINUX"
DBMS_VER: string(10) "08.02.0000"
DB_CODEPAGE: int(1208)
DB_NAME: string(6) "SAMPLE"
INST_NAME: string(8) "db2inst1"
SPECIAL_CHARS: string(2) "@#"
KEYWORDS: int(179)
DFT_ISOLATION: string(2) "CS"
ISOLATION_OPTION: string(12) "UR CS RS RR "
SQL_CONFORMANCE: string(7) "FIPS127"
PROCEDURES: bool(true)
IDENTIFIER_QUOTE_CHAR: string(1) """
LIKE_ESCAPE_CLAUSE: bool(true)
MAX_COL_NAME_LEN: int(30)
MAX_ROW_SIZE: int(32677)
MAX_IDENTIFIER_LEN: int(18)
MAX_INDEX_SIZE: int(1024)
MAX_PROC_NAME_LEN: int(128)
MAX_SCHEMA_NAME_LEN: int(30)
MAX_STATEMENT_LEN: int(2097152)
MAX_TABLE_NAME_LEN: int(128)
NON_NULLABLE_COLUMNS: bool(true)]]></screen>
   </example>
  </para>
 </refsect1>


 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>db2_client_info</function></member>
   </simplelist>
  </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
-->