<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.dba-open.php',
    1 => 'dba_open',
    2 => 'Abre um banco de dados',
  ),
  'up' => 
  array (
    0 => 'ref.dba.php',
    1 => 'Fun&ccedil;&otilde;es de 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' => 'pt_BR',
    '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">Abre um banco de dados</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.dba-open-description">
  <h3 class="title">Descrição</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> estabelece uma instância de banco de dados para
   o arquivo especificado em <code class="parameter">path</code> no modo definido por <code class="parameter">mode</code> usando
   o manipulador informado em <code class="parameter">handler</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.dba-open-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">path</code></dt>
    <dd>
     <span class="simpara">
      Normalmente um caminho comum no seu sistema de arquivos.
     </span>
    </dd>
   
   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <span class="simpara">
      Define os modos: <code class="literal">r</code> para acesso de leitura, <code class="literal">w</code> para
      acesso de leitura/gravação a um baco de dados já existente, <code class="literal">c</code>
      para leitura/gravação e criação de banco de dados se ainda não existir,
      e <code class="literal">n</code> para criar, truncar e acesso leitura/gravação.
      O banco de dados é criado modo de árvore binária (BTree), outros modos (como Hash ou Queue)
      não são suportados.
     </span>
     <span class="simpara">
      Além disso, pode ser definido o método de trava do banco de dados com o próximo caractere.
      Use <code class="literal">l</code> para travar o banco de dados com um arquivo <var class="filename">.lck</var>
      ou <code class="literal">d</code> para travar o próprio arquivo de banco de dados. É
      importante que todas as aplicações façam isso de forma consistente.
     </span>
     <span class="simpara">
      Se a intenção for testar o acesso e não esperar pela trava,
      pode-se adicionar <code class="literal">t</code> como terceiro caractere. Quando
      houver certeza absoluta de que não é necessário travar o banco de dados,
      pode-se fazê-lo usando <code class="literal">-</code> em vez de <code class="literal">l</code> ou
      <code class="literal">d</code>. Quando nenhum dos caracteres <code class="literal">d</code>,
      <code class="literal">l</code> ou <code class="literal">-</code> forem usados, o DBA irá travar
      o arquivo de banco de dados como faria com <code class="literal">d</code>.
     </span>
     <blockquote class="note"><p><strong class="note">Nota</strong>: 
      <p class="para">
       Só pode haver um gravador para um arquivo de banco de dados. Quando um DBA é usados
       em um servidor web e mais de uma solicitação requerer operações de gravação, elas só
       poderão ser feitas uma após a outra. Também não será permitido ler durante a gravação.
       A extensão DBA usa travas para evitar isso. Veja a tabela a seguir:
       <table class="doctable table">
        <caption><strong>Travas DBA</strong></caption>
        
         <thead>
          <tr>
           <th>já aberto</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>não aberto</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>espera</td>
           <td>falso</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;wl&quot;</td>
           <td>espera</td>
           <td>falso</td>
           <td>espera</td>
           <td>falso</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;rd&quot;</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ok</td>
           <td>ok</td>
           <td>espera</td>
           <td>falso</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;wd&quot;</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>ilegal</td>
           <td>espera</td>
           <td>falso</td>
           <td>espera</td>
           <td>falso</td>
          </tr>

         </tbody>
        
       </table>

       <ul class="simplelist">
        <li>ok: a segunda chamada será bem sucedida.</li>
        <li>espera: a segunda chamada espera até que <span class="function"><a href="function.dba-close.php" class="function">dba_close()</a></span> seja chamada para a primeira.</li>
        <li>falso: a segunda chamada retorna falso.</li>
        <li>ilegal: não se deve misturar os modificadores <code class="literal">&quot;l&quot;</code> e <code class="literal">&quot;d&quot;</code> no parâmetro <code class="parameter">mode</code>.</li>
       </ul>
      </p>
     </p></blockquote>
    </dd>
   
   
    <dt><code class="parameter">handler</code></dt>
    <dd>
     <span class="simpara">
      O nome do <a href="dba.requirements.php" class="link">manipulador</a> que
      deve ser usado para acessar o arquivo definido em <code class="parameter">path</code>. São passados
      ​​todos os parâmetros opcionais fornecidos para <span class="function"><strong>dba_open()</strong></span> e
      pode agir em nome deles. Se <code class="parameter">handler</code> for <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>,
      o manipulador padrão será invocado.
     </span>
    </dd>
   
   
    <dt><code class="parameter">permission</code></dt>
    <dd>
     <span class="simpara">
      Parâmetro opcional <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> que é passado ao driver. Tem o mesmo significado que
      o parâmetro <code class="parameter">permissions</code> de <span class="function"><a href="function.chmod.php" class="function">chmod()</a></span> (*nix)
      e o padrão é <code class="literal">0644</code>.
     </span>
     <span class="simpara">
      Os drivers <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> e <code class="literal">lmdb</code> suportam o
      parâmetro <code class="parameter">permission</code>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">map_size</code></dt>
    <dd>
     <span class="simpara">
      Parâmetro opcional <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> que é passado ao driver. Seu valor deve ser um múltiplo do
      tamanho da página do sistema operacional, ou zero, para usar o tamanho padrão do mapa.
     </span>
     <span class="simpara">
      Somente o driver <code class="literal">lmdb</code> aceita o parâmetro <code class="parameter">map_size</code>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <span class="simpara">
      Opções a serem passadas aos drivers de banco de dados. Se for <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, as opções padrão serão passadas.
      Atualmente, apenas o driver LMDB suporta as opções
      <strong><code><a href="dba.constants.php#constant.dba-lmdb-use-sub-dir">DBA_LMDB_USE_SUB_DIR</a></code></strong> e
      <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">Valor Retornado</h3>
  <p class="simpara">
   Retorna uma instância de <span class="classname"><a href="class.dba-connection.php" class="classname">Dba\Connection</a></span> em caso de sucesso ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.dba-open-errors">
  <h3 class="title">Erros/Exceções</h3>
  <p class="simpara">
   <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> é retornado e um erro de nível <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> é emitido quando
   <code class="parameter">handler</code> for <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> mas não houver manipulador padrão.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.dba-open-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versão</th>
      <th>Descrição</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.4.0</td>
      <td>
       Retorna agora uma instância de <span class="classname"><a href="class.dba-connection.php" class="classname">Dba\Connection</a></span>;
       anteriormente, retornava um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>.
      </td>
     </tr>

     <tr>
      <td>8.2.0</td>
      <td>
       <code class="parameter">flags</code> foi adicionado.
      </td>
     </tr>

     <tr>
      <td>8.2.0</td>
      <td>
       <code class="parameter">handler</code> agora pode ser nulo.
      </td>
     </tr>

     <tr>
      <td>7.3.14, 7.4.2</td>
      <td>
       O driver <code class="literal">lmdb</code> agora suporta o parâmetro adicional
       <code class="parameter">map_size</code>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.dba-open-seealso">
  <h3 class="title">Veja Também</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.dba-popen.php" class="function" rel="rdfs-seeAlso">dba_popen()</a> - Abre o banco de dados de forma persistente</span></li>
   <li><span class="function"><a href="function.dba-close.php" class="function" rel="rdfs-seeAlso">dba_close()</a> - Fecha um banco de dados DBA</span></li>
  </ul>
 </div>

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