root/traduc/branches/bv747/manuel/bki.sgml

<!--
$Header: /var/lib/cvs/pgsql-fr/sgml/bki.sgml,v 1.5.2.1 2005/03/14 06:02:59 guillaume Exp $
 -->

<chapter id="bki">
 <title>Interface moteur <acronym>BKI</acronym></title>

 <para>
  Les fichiers d'interface du moteur (<acronym>BKI</acronym>) sont des scripts
  écrits dans un langage spécial, servis au serveur
  <productname>PostgreSQL</productname> lancé dans le mode spécial
  <quote>bootstrap</quote> qui lui permet de réaliser les fonctions de base de
  données sans système de base de données déjà existant.
  Les fichiers <acronym>BKI</acronym> peuvent donc être utilisés pour créer le
  système de base de données en tout premier lieu. (Et ils ne sont probablement
  pas utiles pour un autre emploi.)
 </para>

 <para>
  <application>initdb</application> utilise un fichier <acronym>BKI</acronym>
  pour faire une partie de son travail lors de la création d'un nouveau groupe
  de base de données. Le fichier en entrée utilisé par
  <application>initdb</application> est créé lors de la construction et de
  l'installation de <productname>PostgreSQL</productname> par un programme
  nommé <filename>genbki.sh</filename> à partir de quelques fichiers d'en-têtes
  C spécialement formatés dans le répertoire des sources. Le fichier
  <acronym>BKI</acronym> créé est appelé <filename>postgres.bki</filename> et
  est normalement installé dans le sous-répertoire <filename>share</filename>
  du répertoire d'installation.
 </para>

 <para>
  Des informations plus complètes sont disponibles dans la documentation pour
  <application>initdb</application>.
 </para>

 <sect1 id="bki-format">
  <title>Format des fichiers <acronym>BKI</acronym></title>

  <para>
   Cette section décrit comment le serveur <productname>PostgreSQL</productname>
   interprète les fichiers <acronym>BKI</acronym>. Cette description
   sera plus simple à comprendre si le fichier <filename>postgres.bki</filename>
   se trouve à portée de main comme exemple. Vous devriez aussi étudier le code
   source d'<application>initdb</application> pour avoir une idée de la façon
   dont le moteur est appelé.
  </para>

  <para>
   L'entrée <acronym>BKI</acronym> consiste en une séquence de commandes. Les
   commandes sont constituées d'un certain nombre d'éléments, suivant la syntaxe de
   la commande. Les éléments sont habituellement séparés par des espaces blancs
   mais n'ont pas besoin de l'être s'il n'y a pas d'ambiguïté. Il n'existe pas
   de séparateur spécial pour les commandes&nbsp;; le prochain élément qui ne
   peut syntaxiquement pas appartenir à la commande précédente en lance une
   autre. (Habituellement, vous devriez mettre une nouvelle commande sur une
   nouvelle ligne pour plus de clarté.) Les éléments peuvent être certains mots
   clés, des caractères spéciaux (parenthèses, virgules, etc.), nombres ou
   chaînes de caractères entre guillemets doubles. Tous sont sensibles à la
   casse.
  </para>

  <para>
   Les lignes commençant avec un <literal>#</literal> sont ignorées.
  </para>

 </sect1>

 <sect1 id="bki-commands">
  <title>Commandes <acronym>BKI</acronym></title>

  <variablelist>
   <varlistentry>
    <term>
     open <replaceable class="parameter">nomtable</replaceable>
    </term>

    <listitem>
     <para>
      Ouvre la table nommée
      <replaceable class="parameter">nomtable</replaceable>
      pour plus de manipulations.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>
     close <optional><replaceable class="parameter">nomtable</replaceable></optional>
    </term>

    <listitem>
     <para>
      Ferme la table ouverte appelée <replaceable
      class="parameter">nomtable</replaceable>. Une erreur survient si
      <replaceable class="parameter">nomtable</replaceable> n'est pas déjà
      ouverte. Si <replaceable class="parameter">nomtable</replaceable> n'est
      pas indiqué, alors la table ouverte en cours est fermée.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>
     create <replaceable class="parameter">nomtable</replaceable>
     (<replaceable class="parameter">nom1</replaceable> =
     <replaceable class="parameter">type1</replaceable> <optional>,
     <replaceable class="parameter">nom2</replaceable> = <replaceable
     class="parameter">type2</replaceable>, ...</optional>)
    </term>

    <listitem>
     <para>
      Crée une table nommée <replaceable
      class="parameter">nomtable</replaceable> avec les colonnes spécifiées
      entre parenthèses.
     </para>

     <para>
      Le <replaceable>type</replaceable> n'est pas nécessairement le type de
      données que la colonne aura dans l'environnement SQL&nbsp;; c'est
      déterminé par le catalogue système <structname>pg_attribute</structname>.
      Ici, le type est seulement utilisé pour allouer un emplacement. Les types
      suivants sont autorisés&nbsp;: <type>bool</type>,
      <type>bytea</type>, <type>char</type> (1 octet),
      <type>name</type>, <type>int2</type>, <type>int2vector</type>,
      <type>int4</type>, <type>regproc</type>, <type>regclass</type>,
      <type>regtype</type>, <type>text</type>,
      <type>oid</type>, <type>tid</type>, <type>xid</type>,
      <type>cid</type>, <type>oidvector</type>, <type>smgr</type>,
      <type>_int4</type> (tableau), <type>_aclitem</type> (tableau).
      Les types tableau peuvent aussi être indiqués en écrivant
      <literal>[]</literal> après le nom du type de l'élément.
     </para>

     <note>
      <para>
       La table sera seulement créée sur disque, elle ne sera pas
       automatiquement enregistrée dans les catalogues système et ne sera donc
       pas accessible sauf si les lignes appropriées sont insérées dans
       <structname>pg_class</structname>,
       <structname>pg_attribute</structname>, etc.
      </para>
     </note>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>
     insert <optional>OID = <replaceable class="parameter">valeur_oid</replaceable></optional> (<replaceable class="parameter">valeur1</replaceable> <replaceable class="parameter">valeur2</replaceable> ...)
    </term>

    <listitem>
     <para>
      Insère une nouvelle ligne dans la table ouverte en utilisant <replaceable
      class="parameter">valeur1</replaceable>, <replaceable
      class="parameter">valeur2</replaceable>, etc., comme valeurs de ses
      colonnes et <replaceable
      class="parameter">valeur_oid</replaceable> pour son OID. Si
      <replaceable class="parameter">valeur_oid</replaceable> vaut zéro
      (0) ou si la clause est omise, alors le prochain OID disponible est
      utilisé.
     </para>

     <para>
      Les valeurs NULL peuvent être indiquées en utilisant le mot clé spécial
      <literal>_null_</literal>. Les valeurs contenant des espaces doivent être
      entre des guillemets doubles.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>
     declare <optional>unique</optional> index <replaceable
     class="parameter">nomindex</replaceable> on <replaceable
     class="parameter">nomtable</replaceable> using <replaceable
     class="parameter">nomma</replaceable> (<replaceable
     class="parameter">classeop1</replaceable> <replaceable
     class="parameter">nom1</replaceable> <optional>, ...</optional>)
    </term>

    <listitem>
     <para>
      Crée un index nommé <replaceable
      class="parameter">nomindex</replaceable> sur la table nommée
      <replaceable class="parameter">nomtable</replaceable> en utilisant la
      méthode d'accès nommée <replaceable class="parameter">nomma</replaceable>.
      Les champs de l'index sont appelés <replaceable
      class="parameter">nom1</replaceable>, <replaceable
      class="parameter">nom2</replaceable> etc., et les classes d'opérateur à
      utiliser sont respectivement <replaceable
      class="parameter">classeop1</replaceable>, <replaceable
      class="parameter">classeop2</replaceable> etc.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>build indices</term>

    <listitem>
     <para>
      Construit les index précédemment déclarés.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>

 </sect1>

 <sect1 id="bki-example">
  <title>Exemple</title>

  <para>
   La séquence suivante de commandes créera la table
   <literal>test_table</literal> avec les deux colonnes
   <literal>cola</literal> et <literal>colb</literal> de type, respectivement,
   <type>int4</type> et <type>text</type> et insèrera deux lignes dans la
   table.
<programlisting>
create test_table (cola = int4, colb = text)
open test_table
insert OID=421 ( 1 "value1" )
insert OID=422 ( 2 _null_ )
close test_table
</programlisting>
  </para>
 </sect1>
</chapter>

<!-- Keep this comment at the end of the file
Local variables:
mode:sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:("/usr/lib/sgml/catalog")
sgml-local-ecat-files:nil
End:
-->