<!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>Defragments the index</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrclient.getoptions.html">SolrClient::getOptions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.ping.html">SolrClient::ping</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.optimize" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrClient::optimize</h1>
<p class="verinfo">(PECL solr >= 0.9.2)</p><p class="refpurpose"><span class="refname">SolrClient::optimize</span> — <span class="dc-title">Defragments the index</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrclient.optimize-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.solrupdateresponse.html" class="type SolrUpdateResponse">SolrUpdateResponse</a></span> <span class="methodname"><strong>SolrClient::optimize</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$maxSegments</code><span class="initializer"> = 1</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$softCommit</code><span class="initializer"> = <strong><code>TRUE</code></strong></span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$waitSearcher</code><span class="initializer"> = <strong><code>TRUE</code></strong></span></span>
]]] )</div>
<p class="para rdfs-comment">
Defragments the index for faster search performance.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrclient.optimize-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">maxSegments</code></dt>
<dd>
<p class="para">
Optimizes down to at most this number of segments. Since Solr 1.3
</p>
</dd>
<dt>
<code class="parameter">softCommit</code></dt>
<dd>
<p class="para">
This will refresh the 'view' of the index in a more performant manner, but without "on-disk" guarantees. (Solr4.0+)
</p>
</dd>
<dt>
<code class="parameter">waitSearcher</code></dt>
<dd>
<p class="para">
Block until a new searcher is opened and registered as the main query searcher, making the changes visible.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrclient.optimize-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a SolrUpdateResponse on success or throws an exception on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-solrclient.optimize-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.solrclientexception.html" class="classname">SolrClientException</a> if the client had failed, or there was a connection issue.
</p>
<p class="para">
Throws <a href="class.solrserverexception.html" class="classname">SolrServerException</a> if the Solr Server had failed to process the request.
</p>
</div>
<div class="refsect1 notes" id="refsect1-solrclient.optimize-notes">
<h3 class="title">Notes</h3>
<div class="warning"><strong class="warning">Warning</strong>
<p class="para">
PECL Solr >= 2.0 only supports Solr Server >= 4.0
</p>
<p class="para">
Prior to PECL Solr 2.0 this method used to accept these arguments "int $maxSegments, bool $waitFlush, bool $waitSearcher".
</p>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-solrclient.optimize-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="solrclient.commit.html" class="methodname" rel="rdfs-seeAlso">SolrClient::commit()</a> - Finalizes all add/deletes made to the index</span></li>
<li class="member"><span class="methodname"><a href="solrclient.rollback.html" class="methodname" rel="rdfs-seeAlso">SolrClient::rollback()</a> - Rollbacks all add/deletes made to the index since the last commit</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.getoptions.html">SolrClient::getOptions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrclient.ping.html">SolrClient::ping</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>
