<?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 => 'de',
  ),
  'this' => 
  array (
    0 => 'solrclient.adddocument.php',
    1 => 'SolrClient::addDocument',
    2 => 'Adds a document to the index',
  ),
  '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' => 'en',
    '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">Adds a document to the index</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-solrclient.adddocument-description">
  <h3 class="title">Beschreibung</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">
   This method adds a document to the index.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-solrclient.adddocument-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">doc</code></dt>
     <dd>
      <p class="para">
       The SolrInputDocument instance.
      </p>
     </dd>
    
    
     <dt><code class="parameter">overwrite</code></dt>
     <dd>
      <p class="para">
       Whether to overwrite existing document or not. If <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> there will be duplicates (several documents with the same ID).
        
      </p>
        <div class="warning"><strong class="warning">Warnung</strong>
            <p class="para">
              PECL Solr &lt; 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
            </p>
            <p class="para">
              $allowDups = false is the same as $overwrite = true
            </p>
        </div>
     </dd>
    
    
     <dt><code class="parameter">commitWithin</code></dt>
     <dd>
      <p class="para">
        Number of milliseconds within which to auto commit this document. Available since Solr 1.4 . Default (0) means disabled.
      </p>
      <p class="para">
        When this value specified, it leaves the control of when to do the commit
        to Solr itself, optimizing number of commits to a minimum while still
        fulfilling
        the update latency requirements, and Solr will automatically do a commit
        when the oldest add in the buffer is due.
       </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-solrclient.adddocument-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="para">
   Returns a <span class="type"><a href="class.solrupdateresponse.php" class="type SolrUpdateResponse">SolrUpdateResponse</a></span> object or throws an Exception on failure.
  </p>
 </div>

 
 <div class="refsect1 errors" id="refsect1-solrclient.adddocument-errors">
  <h3 class="title">Fehler/Exceptions</h3>
  <p class="para">
   Throws <span class="classname"><a href="class.solrclientexception.php" class="classname">SolrClientException</a></span> if the client had failed, or there was a connection issue.
  </p>
  <p class="para">
   Throws <span class="classname"><a href="class.solrserverexception.php" class="classname">SolrServerException</a></span> if the Solr Server had failed to process the request.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-solrclient.adddocument-examples">
  <h3 class="title">Beispiele</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Beispiel #1 <span class="methodname"><strong>SolrClient::addDocument()</strong></span> example</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">// you will have to commit changes to be written if you didn't use $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>Das oben gezeigte Beispiel erzeugt
eine ähnliche Ausgabe wie:</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>Beispiel #2 <span class="methodname"><strong>SolrClient::addDocument()</strong></span> example 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">// No need to call commit() because $commitWithin is passed, so Solr Server will auto commit within 10 seconds<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>Das oben gezeigte Beispiel erzeugt
eine ähnliche Ausgabe wie:</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">Siehe auch</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="solrclient.adddocuments.php" class="methodname" rel="rdfs-seeAlso">SolrClient::addDocuments()</a> - Adds a collection of SolrInputDocument instances to the index</span></li>
    <li><span class="methodname"><a href="solrclient.commit.php" class="methodname" rel="rdfs-seeAlso">SolrClient::commit()</a> - Finalizes all add/deletes made to the index</span></li>
   </ul>
  </p>
 </div>


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