<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.solrclient.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'solrclient.adddocument.php',
    1 => 'SolrClient::addDocument',
    2 => 'Добавляет документ в индекс',
  ),
  'up' => 
  array (
    0 => 'class.solrclient.php',
    1 => 'SolrClient',
  ),
  'prev' => 
  array (
    0 => 'class.solrclient.php',
    1 => 'SolrClient',
  ),
  'next' => 
  array (
    0 => 'solrclient.adddocuments.php',
    1 => 'SolrClient::addDocuments',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/solr/solrclient/adddocument.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="solrclient.adddocument" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SolrClient::addDocument</h1>
  <p class="verinfo">(PECL solr &gt;= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrClient::addDocument</span> &mdash; <span class="dc-title">Добавляет документ в индекс</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-solrclient.adddocument-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SolrClient::addDocument</strong></span>(<span class="methodparam"><span class="type"><a href="class.solrinputdocument.php" class="type SolrInputDocument">SolrInputDocument</a></span> <code class="parameter">$doc</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$overwrite</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$commitWithin</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="class.solrupdateresponse.php" class="type SolrUpdateResponse">SolrUpdateResponse</a></span></div>

  <p class="para rdfs-comment">
   Метод добавляет документ в индекс.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-solrclient.adddocument-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">doc</code></dt>
     <dd>
      <p class="para">
       Экземпляр SolrInputDocument.
      </p>
     </dd>
    
    
     <dt><code class="parameter">overwrite</code></dt>
     <dd>
      <p class="para">
       Следует ли перезаписывать существующий документ или нет. Если указано <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, будут разрешены дубликаты (несколько документов с одинаковым ID).

      </p>
      <div class="warning"><strong class="warning">Внимание</strong>
       <p class="para">
        В PECL Solr &lt; 2.0 $allowDups использовался вместо $overwrite, который выполняет те же функции с полностью противоположным флагом bool.
       </p>
       <p class="para">
        $allowDups = false тоже самое, что и $overwrite = true
       </p>
      </div>
     </dd>
    
    
     <dt><code class="parameter">commitWithin</code></dt>
     <dd>
      <p class="para">
       Количество миллисекунд для автоматической фиксации документа. Доступно, начиная с Solr 1.4. По умолчанию (0) означает отключено.
      </p>
      <p class="para">
       Если значение указано, остаётся контроль над тем, когда делать фиксацию
       для самого Solr, оптимизируя количество коммитов до минимума, при этом
       соблюдая
       требования к задержке обновления, и Solr автоматически выполнит фиксацию,
       когда наступит самое старое добавление в буфер.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-solrclient.adddocument-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Возвращает объект <span class="type"><a href="class.solrupdateresponse.php" class="type SolrUpdateResponse">SolrUpdateResponse</a></span> или выбрасывает исключение в случае возникновения ошибки.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-solrclient.adddocument-errors">
  <h3 class="title">Ошибки</h3>
  <p class="para">
   Выбрасывает <span class="classname"><a href="class.solrclientexception.php" class="classname">SolrClientException</a></span>, если клиент отказал или возникла проблема с подключением.
  </p>
  <p class="para">
   Выбрасывает <span class="classname"><a href="class.solrserverexception.php" class="classname">SolrServerException</a></span>, если сервер Solr не смог обработать запрос.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-solrclient.adddocument-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример использования <span class="methodname"><strong>SolrClient::addDocument()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$options </span><span style="color: #007700">= array<br />(<br />    </span><span style="color: #DD0000">'hostname' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_HOSTNAME</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'login'    </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_USERNAME</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'password' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_PASSWORD</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'port'     </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_PORT</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrClient</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$doc </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrInputDocument</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'id'</span><span style="color: #007700">, </span><span style="color: #0000BB">334455</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'cat'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Software'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'cat'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Lucene'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$updateResponse </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addDocument</span><span style="color: #007700">(</span><span style="color: #0000BB">$doc</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// вам нужно будет зафиксировать изменения, которые будут записаны, если вы не использовали $commitWithin<br /></span><span style="color: #0000BB">$client</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">commit</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$updateResponse</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponse</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    
<div class="example-contents"><p>
 Вывод приведённого примера будет похож на:
</p></div>

    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">SolrObject Object
(
    [responseHeader] =&gt; SolrObject Object
        (
            [status] =&gt; 0
            [QTime] =&gt; 1
        )

)</pre>
</div>
    </div>
   </div>
  </p>
  <p class="para">
   <div class="example" id="example-2">
    <p><strong>Пример #2 Пример использования <span class="methodname"><strong>SolrClient::addDocument()</strong></span> #2</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$options </span><span style="color: #007700">= array<br />(<br />    </span><span style="color: #DD0000">'hostname' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_HOSTNAME</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'login'    </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_USERNAME</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'password' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_PASSWORD</span><span style="color: #007700">,<br />    </span><span style="color: #DD0000">'port'     </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">SOLR_SERVER_PORT</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$client </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrClient</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$doc </span><span style="color: #007700">= new </span><span style="color: #0000BB">SolrInputDocument</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'id'</span><span style="color: #007700">, </span><span style="color: #0000BB">334455</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'cat'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Software'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$doc</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addField</span><span style="color: #007700">(</span><span style="color: #DD0000">'cat'</span><span style="color: #007700">, </span><span style="color: #DD0000">'Lucene'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Нет необходимости вызывать commit(), потому что передаётся $commitWithin, поэтому Solr Server будет автоматически фиксировать в течение 10 секунд<br /></span><span style="color: #0000BB">$updateResponse </span><span style="color: #007700">= </span><span style="color: #0000BB">$client</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addDocument</span><span style="color: #007700">(</span><span style="color: #0000BB">$doc</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">10000</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$updateResponse</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponse</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    
<div class="example-contents"><p>
 Вывод приведённого примера будет похож на:
</p></div>

    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">SolrObject Object
(
    [responseHeader] =&gt; SolrObject Object
        (
            [status] =&gt; 0
            [QTime] =&gt; 1
        )

)</pre>
</div>
    </div>
    </div>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-solrclient.adddocument-seealso">
  <h3 class="title">Смотрите также</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="solrclient.adddocuments.php" class="methodname" rel="rdfs-seeAlso">SolrClient::addDocuments()</a> - Добавляет коллекцию экземпляров SolrInputDocument в индекс</span></li>
    <li><span class="methodname"><a href="solrclient.commit.php" class="methodname" rel="rdfs-seeAlso">SolrClient::commit()</a> - Завершает каждое добавление и удаление, которое сделали в индексе</span></li>
   </ul>
  </p>
 </div>


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