<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Adds a collection of SolrInputDocument instances to the index</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.adddocument.html">SolrClient::addDocument</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.commit.html">SolrClient::commit</a></div>
<div class="up"><a href="class.solrclient.html">SolrClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrclient.adddocuments" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrClient::addDocuments</h1>
<p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrClient::addDocuments</span> — <span class="dc-title">Adds a collection of SolrInputDocument instances to the index</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrclient.adddocuments-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>SolrClient::addDocuments</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$docs</code></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$allowDups</code><span class="initializer"> = false</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$commitWithin</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
Adds a collection of documents to the index.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrclient.adddocuments-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">docs</code></em></span>
<dd>
<p class="para">
An array containing the collection of SolrInputDocument instances. This array must be an actual variable.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">allowDups</code></em></span>
<dd>
<p class="para">
If <strong><code>FALSE</code></strong> duplicates will be overwritten.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">commitWithin</code></em></span>
<dd>
<p class="para">
Number of milliseconds within which to commit the documents to the index. This was only available since Solr 1.4
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrclient.adddocuments-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a SolrUpdateResponse object on success and throws a SolrClientException on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-solrclient.adddocuments-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4722">
<p><strong>Example #1 <span class="methodname"><strong>SolrClient::addDocuments()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$options </span><span style="color: #007700">= array<br />(<br /> </span><span style="color: #DD0000">'hostname' </span><span style="color: #007700">=> </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">=> </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">=> </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">=> </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">-></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">-></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">-></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">$doc2 </span><span style="color: #007700">= clone </span><span style="color: #0000BB">$doc</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$doc2</span><span style="color: #007700">-></span><span style="color: #0000BB">deleteField</span><span style="color: #007700">(</span><span style="color: #DD0000">'id'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$doc2</span><span style="color: #007700">-></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">334456</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$docs </span><span style="color: #007700">= array(</span><span style="color: #0000BB">$doc</span><span style="color: #007700">, </span><span style="color: #0000BB">$doc2</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">-></span><span style="color: #0000BB">addDocuments</span><span style="color: #007700">(</span><span style="color: #0000BB">$docs</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">-></span><span style="color: #0000BB">getResponse</span><span style="color: #007700">());<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
SolrObject Object
(
[responseHeader] => SolrObject Object
(
[status] => 0
[QTime] => 2
)
)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-solrclient.adddocuments-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="solrclient.adddocument.html" class="methodname" rel="rdfs-seeAlso">SolrClient::addDocument()</a> - Adds a document to the index</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.adddocument.html">SolrClient::addDocument</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.commit.html">SolrClient::commit</a></div>
<div class="up"><a href="class.solrclient.html">SolrClient</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
