<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.dba.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.dba-open.php',
    1 => 'dba_open',
    2 => 'Ouvre une base de donn&eacute;es DBA',
  ),
  'up' => 
  array (
    0 => 'ref.dba.php',
    1 => 'Fonctions DBA',
  ),
  'prev' => 
  array (
    0 => 'function.dba-nextkey.php',
    1 => 'dba_nextkey',
  ),
  'next' => 
  array (
    0 => 'function.dba-optimize.php',
    1 => 'dba_optimize',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/dba/functions/dba-open.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.dba-open" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">dba_open</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">dba_open</span> &mdash; <span class="dc-title">Ouvre une base de données DBA</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.dba-open-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>dba_open</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$mode</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$handler</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$permission</code><span class="initializer"> = 0644</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$map_size</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$flags</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="class.dba-connection.php" class="type Dba\Connection">Dba\Connection</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   <span class="function"><strong>dba_open()</strong></span> établit une connexion à
   la base identifiée par <code class="parameter">path</code> avec le
   mode <code class="parameter">mode</code> et l&#039;identifiant
   <code class="parameter">handler</code>.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.dba-open-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <dl>
   
    <dt><code class="parameter">path</code></dt>
    <dd>
     <span class="simpara">
      Chemin sur le système de fichiers.
     </span>
    </dd>
   
   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <span class="simpara">
      Il vaut <code class="literal">r</code> pour lecture seule, <code class="literal">w</code> pour
      lecture/écriture, <code class="literal">c</code> pour lecture/écriture, et
      création si la base n&#039;existe pas, et <code class="literal">n</code> pour
      création, écrasement et accès en lecture/écriture.
      La base de données est créée en mode BTree ; les autres modes (comme Hash ou
      Queue) ne sont pas supportés.
     </span>
     <span class="simpara">
      De plus, il est possible de choisir la méthode de verrouillage de la base avec le
      caractère suivant. Il est possible d&#039;utiliser <code class="literal">l</code> pour verrouiller la base avec un
      fichier <var class="filename">.lck</var>, ou <code class="literal">d</code> pour verrouiller
      la base elle-même. Il est important que les applications utilisent ces
      options de manière cohérente.
     </span>
     <span class="simpara">
      Si l&#039;on veut tester la possibilité d&#039;accès, et ne pas attendre la
      disponibilité du verrou, il est possible d&#039;ajouter la lettre <code class="literal">t</code>
      comme troisième caractère. Lorsque l&#039;on est absolument certain que la base
      ne requiert pas de verrou, il est possible d&#039;utiliser le tiret <code class="literal">-</code>
      à la place de <code class="literal">l</code> ou <code class="literal">d</code>.
      Lorsque l&#039;on n&#039;utilise ni <code class="literal">d</code>, ni <code class="literal">l</code> ni
      <code class="literal">-</code>, dba va verrouiller en mode <code class="literal">d</code>.
     </span>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       Il ne peut y avoir qu&#039;un seul type d&#039;écriture dans la base. Lorsque l&#039;on
       utilise dba sur un serveur web, et que plusieurs requêtes HTTP effectuent
       des écritures, elles ne peuvent être faites que l&#039;une après l&#039;autre. De même,
       la lecture durant l&#039;écriture n&#039;est pas possible. L&#039;extension dba utilise
       un verrou pour éviter ces problèmes. Voici la table de verrouillage :
       <table class="doctable table">
        <caption><strong>Verrouillage DBA</strong></caption>
        
         <thead>
          <tr>
           <th>déjà ouverte</th>
           <th><code class="parameter">mode</code> = &quot;rl&quot;</th>
           <th><code class="parameter">mode</code> = &quot;rlt&quot;</th>
           <th><code class="parameter">mode</code> = &quot;wl&quot;</th>
           <th><code class="parameter">mode</code> = &quot;wlt&quot;</th>
           <th><code class="parameter">mode</code> = &quot;rd&quot;</th>
           <th><code class="parameter">mode</code> = &quot;rdt&quot;</th>
           <th><code class="parameter">mode</code> = &quot;wd&quot;</th>
           <th><code class="parameter">mode</code> = &quot;wdt&quot;</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>non-ouverte</td>
           <td>ok</td>
           <td>ok</td>
           <td>ok</td>
           <td>ok</td>
           <td>ok</td>
           <td>ok</td>
           <td>ok</td>
           <td>ok</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;rl&quot;</td>
           <td>ok</td>
           <td>ok</td>
           <td>attente</td>
           <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;wl&quot;</td>
           <td>attente</td>
           <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
           <td>attente</td>
           <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;rd&quot;</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>ok</td>
           <td>ok</td>
           <td>attente</td>
           <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;wd&quot;</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>illégal</td>
           <td>attente</td>
           <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
           <td>attente</td>
           <td><strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></td>
          </tr>

         </tbody>
        
       </table>

       <ul class="simplelist">
        <li>ok: Le second appel réussit.</li>
        <li>wait: Le second appel attend que <span class="function"><a href="function.dba-close.php" class="function">dba_close()</a></span>
         soit appelé par le premier script.</li>
        <li>false: Le second appel retourne <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.</li>
        <li>illégal: il ne faut pas mélanger les options
         <code class="literal">&quot;l&quot;</code> et <code class="literal">&quot;d&quot;</code> pour le paramètre
         <code class="parameter">mode</code>.</li>
       </ul>
      </p>
     </p></blockquote>
    </dd>
   
   
    <dt><code class="parameter">handler</code></dt>
    <dd>
     <span class="simpara">
      Le nom du <a href="dba.requirements.php" class="link">gestionnaire</a>
      qui doit être utilisé pour accéder à <code class="parameter">path</code>.
      C&#039;est passé à tous les paramètres facultatifs donnés à
      <span class="function"><strong>dba_open()</strong></span> et peut agir au nom d&#039;eux.
      Si le paramètre <code class="parameter">handler</code> est <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>,
      alors le gestionnaire par défaut est invoqué.
     </span>
    </dd>
   
   
    <dt><code class="parameter">permission</code></dt>
    <dd>
     <span class="simpara">
      Paramètre facultatif de type <a href="language.types.integer.php" class="link">entier</a> qui est passé au pilote. Il a la même signification que
      le paramètre <code class="parameter">permissions</code> de la fonction <span class="function"><a href="function.chmod.php" class="function">chmod()</a></span>,
      et a une valeur par défaut de <code class="literal">0644</code>.
     </span>
     <span class="simpara">
      Les pilotes <code class="literal">db1</code>, <code class="literal">db2</code>,
      <code class="literal">db3</code>, <code class="literal">db4</code>, <code class="literal">dbm</code>,
      <code class="literal">gdbm</code>,
      <code class="literal">ndbm</code> et <code class="literal">lmdb</code> prennent en charge le
      paramètre <code class="parameter">permission</code>.
     </span>
     <span class="simpara">
      Le pilote <code class="literal">lmdb</code> supporte deux paramètres additionnels.
      Le premier permet de définir le <code class="literal">$filemode</code>
      (voir description ci-dessus), et le second permet de définir la
      <code class="literal">$mapsize</code>, dont la valeur devrait être un multiple de
      la taille de page du système d&#039;exploitation, ou zéro pour utiliser la
      mapsize par défaut.
      Le paramètre <code class="literal">$mapsize</code> est supporté à partir de
      PHP 7.3.14 et 7.4.2, respectivement.
     </span>
    </dd>
   
   
    <dt><code class="parameter">map_size</code></dt>
    <dd>
     <span class="simpara">
      Paramètre facultatif de type <a href="language.types.integer.php" class="link">entier</a> qui est passé au pilote. Sa valeur doit être un multiple de la
      taille de page du système d&#039;exploitation, ou zéro pour utiliser la taille de mappage par défaut.
     </span>
     <span class="simpara">
      Seul le pilote <code class="literal">lmdb</code> accepte le paramètre <code class="parameter">map_size</code>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <span class="simpara">
      Drapeaux à passer aux pilotes de base de données. Si <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, les drapeaux par défaut seront fournis.
      Actuellement, seul le pilote LMDB prend en charge les drapeaux suivants :
      <strong><code><a href="dba.constants.php#constant.dba-lmdb-use-sub-dir">DBA_LMDB_USE_SUB_DIR</a></code></strong> et
      <strong><code><a href="dba.constants.php#constant.dba-lmdb-no-sub-dir">DBA_LMDB_NO_SUB_DIR</a></code></strong>.
     </span>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.dba-open-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="simpara">
   Retourne une instance <span class="classname"><a href="class.dba-connection.php" class="classname">Dba\Connection</a></span> en cas de succès ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
 </div>

 <div class="refsect1 errors" id="refsect1-function.dba-open-errors">
  <h3 class="title">Erreurs / Exceptions</h3>
  <p class="simpara">
   <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> est retourné et une erreur de niveau <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> est émise lorsque
   le paramètre <code class="parameter">handler</code> est <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, mais qu&#039;aucun gestionnaire par défaut n&#039;est disponible.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.dba-open-changelog">
  <h3 class="title">Historique</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.4.0</td>
      <td>
       Retourne désormais une instance de <span class="classname"><a href="class.dba-connection.php" class="classname">Dba\Connection</a></span>;
       auparavant, une <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> était retournée.
      </td>
     </tr>

     <tr>
      <td>8.2.0</td>
      <td>
       Le paramètre <code class="parameter">flags</code> est ajouté.
      </td>
     </tr>

     <tr>
      <td>8.2.0</td>
      <td>
       Le paramètre <code class="parameter">handler</code> est désormais nullable.
      </td>
     </tr>

     <tr>
      <td>7.3.14, 7.4.2</td>
      <td>
       Le pilote <code class="literal">lmdb</code> supporte désormais un paramètre
       additionnel <code class="parameter">map_size</code>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.dba-open-seealso">
  <h3 class="title">Voir aussi</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.dba-popen.php" class="function" rel="rdfs-seeAlso">dba_popen()</a> - Ouvre une connexion persistante &agrave; une base de donn&eacute;es DBA</span></li>
   <li><span class="function"><a href="function.dba-close.php" class="function" rel="rdfs-seeAlso">dba_close()</a> - Ferme une base DBA</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>