<?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 => 'ru',
  ),
  'this' => 
  array (
    0 => 'function.dba-open.php',
    1 => 'dba_open',
    2 => 'Открывает базу данных',
  ),
  'up' => 
  array (
    0 => 'ref.dba.php',
    1 => 'Функции 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' => 'ru',
    '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">Открывает базу данных</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.dba-open-description">
  <h3 class="title">Описание</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> устанавливает экземпляр базы данных по пути
   <code class="parameter">path</code> в режиме <code class="parameter">mode</code> используя
   обработчик <code class="parameter">handler</code>.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.dba-open-parameters">
  <h3 class="title">Список параметров</h3>
  <dl>
   
    <dt><code class="parameter">path</code></dt>
    <dd>
     <span class="simpara">
      Путь до файлов базы данных.
     </span>
    </dd>
   
   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <span class="simpara">
      <code class="literal">r</code> для режима чтения, <code class="literal">w</code> для
      режима чтения/записи с уже существующей базой данных. <code class="literal">c</code>
      для режима чтения/записи и создания базы данных, если она ещё не была создана,
      и <code class="literal">n</code> для создания, обрезания и доступа для чтения/записи.
      База данных создаётся с архитектурой BTree, другие архитектуры (вроде Hash или Queue)
      не поддерживаются.
     </span>
     <span class="simpara">
      Дополнительно, с помощью следующего символа, вы можете задать режим блокировки
      базы данных. <code class="literal">l</code> для блокировки базы данных с помощью файла
      <var class="filename">.lck</var>, или <code class="literal">d</code> для самостоятельной блокировки
      средствами самой базы. Важно, чтобы все ваши приложения делали это согласованно.
     </span>
     <span class="simpara">
      Если вы хотите просто проверить доступ и не хотите ждать освобождения блокировки,
      вы можете добавить третий символ <code class="literal">t</code>.  Если вы абсолютно уверены,
      что вам не нужно использовать блокировку базы данных, вы можете использовать
      символ <code class="literal">-</code> вместо <code class="literal">l</code> или <code class="literal">d</code>.
      Если ни один из символов: <code class="literal">d</code>, <code class="literal">l</code> или
      <code class="literal">-</code> не задан, база данных будет использовать режим <code class="literal">d</code>.
     </span>
     <blockquote class="note"><p><strong class="note">Замечание</strong>: 
      <p class="para">
       В один момент времени может быть только один процесс, пишущий в базу данных.
       Когда вы используете dba на веб-сервере, и более чем один запрос требует
       записи в базу данных, они могут это делать только строго по очереди.
       Также, в момент чтения, запись не доступна. Модуль dba использует
       блокировки для предотвращения нежелательного поведения.
       Изучите следующую таблицу:
       <table class="doctable table">
        <caption><strong>Блокировки DBA</strong></caption>
        
         <thead>
          <tr>
           <th>уже открыта</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>не открыта</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>wait</td>
           <td>false</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;wl&quot;</td>
           <td>wait</td>
           <td>false</td>
           <td>wait</td>
           <td>false</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;rd&quot;</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>ok</td>
           <td>ok</td>
           <td>wait</td>
           <td>false</td>
          </tr>

          <tr>
           <td><code class="parameter">mode</code> = &quot;wd&quot;</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>illegal</td>
           <td>wait</td>
           <td>false</td>
           <td>wait</td>
           <td>false</td>
          </tr>

         </tbody>
        
       </table>

       <ul class="simplelist">
        <li>ok: второй вызов будет успешным.</li>
        <li>wait: второй вызов будет ждать, пока первый не вызовет
         <span class="function"><a href="function.dba-close.php" class="function">dba_close()</a></span>.</li>
        <li>false: второй вызов вернёт <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.</li>
        <li>illegal: вы не можете смешивать модификаторы <code class="literal">&quot;l&quot;</code> и <code class="literal">&quot;d&quot;</code> в параметре <code class="parameter">mode</code>.</li>
       </ul>
      </p>
     </p></blockquote>
    </dd>
   
   
    <dt><code class="parameter">handler</code></dt>
    <dd>
     <span class="simpara">
      Имя <a href="dba.requirements.php" class="link">обработчика</a>, который будет
      использоваться для доступа по пути <code class="parameter">path</code>. Ему передаются
      все необязательные параметры, заданные в <span class="function"><strong>dba_open()</strong></span>.
      Если параметр <code class="parameter">handler</code> равен <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>,
      то вызывается обработчик по умолчанию.
     </span>
    </dd>
   
   
    <dt><code class="parameter">permission</code></dt>
    <dd>
     <span class="simpara">
      Необязательный параметр, заданный целым числом (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>), который передаётся драйверу.
      У него то же значение, что и у параметра <code class="parameter">permissions</code> функции <span class="function"><a href="function.chmod.php" class="function">chmod()</a></span>,
      значение по умолчанию - <code class="literal">0644</code>.
     </span>
     <span class="simpara">
      Драйверы <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> и <code class="literal">lmdb</code> поддерживают
      параметр <code class="parameter">permission</code>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">map_size</code></dt>
    <dd>
     <span class="simpara">
      Необязательный параметр, заданный целым числом (<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>), который передаётся драйверу.
      Его значение должно быть кратно размеру страницы ОС или равно нулю,
      чтобы использовать размер карты по умолчанию.
     </span>
     <span class="simpara">
      Только драйвер <code class="literal">lmdb</code> допускает параметр <code class="parameter">map_size</code>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <span class="simpara">
      Флаги для передачи драйверам базы данных. Если указано значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>,
      будут переданы флаги по умолчанию.
      В настоящее время только драйвер LMDB поддерживает следующие флаги:
      <strong><code><a href="dba.constants.php#constant.dba-lmdb-use-sub-dir">DBA_LMDB_USE_SUB_DIR</a></code></strong> и
      <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">Возвращаемые значения</h3>
  <p class="simpara">
   Функция возвращает экземпляр класса <span class="classname"><a href="class.dba-connection.php" class="classname">Dba\Connection</a></span> в случае успешного выполнения или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.dba-open-errors">
  <h3 class="title">Ошибки</h3>
  <p class="simpara">
   Функция возвращает значение <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> и выдаёт ошибку уровня <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>,
   если параметр <code class="parameter">handler</code> равен <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>, но нет обработчика по умолчанию.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.dba-open-changelog">
  <h3 class="title">Список изменений</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Версия</th>
      <th>Описание</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.4.0</td>
      <td>
       Функция теперь возвращает экземпляр класса <span class="classname"><a href="class.dba-connection.php" class="classname">Dba\Connection</a></span>;
       ранее возвращался ресурс (<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>.
      </td>
     </tr>

     <tr>
      <td>8.2.0</td>
      <td>
       Параметр <code class="parameter">handler</code> теперь допускает значение <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
      </td>
     </tr>

     <tr>
      <td>7.3.14, 7.4.2</td>
      <td>
       Драйвер <code class="literal">lmdb</code> теперь поддерживает дополнительный
       параметр <code class="parameter">map_size</code>.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 seealso" id="refsect1-function.dba-open-seealso">
  <h3 class="title">Смотрите также</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.dba-popen.php" class="function" rel="rdfs-seeAlso">dba_popen()</a> - Установить постоянный экземпляр базы данных</span></li>
   <li><span class="function"><a href="function.dba-close.php" class="function" rel="rdfs-seeAlso">dba_close()</a> - Закрывает базу данных DBA</span></li>
  </ul>
 </div>

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