<!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>Enables caching for result grouping</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrquery.setgroup.html">SolrQuery::setGroup</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrquery.setgroupfacet.html">SolrQuery::setGroupFacet</a></div>
<div class="up"><a href="class.solrquery.html">SolrQuery</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="solrquery.setgroupcachepercent" class="refentry">
<div class="refnamediv">
<h1 class="refname">SolrQuery::setGroupCachePercent</h1>
<p class="verinfo">(PECL solr >= 2.2.0)</p><p class="refpurpose"><span class="refname">SolrQuery::setGroupCachePercent</span> — <span class="dc-title">Enables caching for result grouping</span></p>
</div>
<div class="refsect1 description" id="refsect1-solrquery.setgroupcachepercent-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.solrquery.html" class="type SolrQuery">SolrQuery</a></span> <span class="methodname"><strong>SolrQuery::setGroupCachePercent</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$percent</code></span>
)</div>
<p class="para rdfs-comment">
Setting this parameter to a number greater than 0 enables caching for result grouping.
Result Grouping executes two searches; this option caches the second search. The server default value is 0.
Testing has shown that group caching only improves search time with Boolean, wildcard, and fuzzy queries. For simple queries like term or "match all" queries, group caching degrades performance.
group.cache.percent parameter
</p>
</div>
<div class="refsect1 parameters" id="refsect1-solrquery.setgroupcachepercent-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">percent</code></dt>
<dd>
<p class="para">
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-solrquery.setgroupcachepercent-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 errors" id="refsect1-solrquery.setgroupcachepercent-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Emits <a href="class.solrillegalargumentexception.html" class="classname">SolrIllegalArgumentException</a> in case of an invalid parameter was passed.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-solrquery.setgroupcachepercent-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="solrquery.setgroup.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroup()</a> - Enable/Disable result grouping (group parameter)</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupfield.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupField()</a> - Add a field to be used to group results</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupfunction.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupFunction()</a> - Allows grouping results based on the unique values of a function query (group.func parameter)</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupquery.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupQuery()</a> - Allows grouping of documents that match the given query</span></li>
<li class="member"><span class="methodname"><a href="solrquery.addgroupsortfield.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::addGroupSortField()</a> - Add a group sort field (group.sort parameter)</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupfacet.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupFacet()</a> - Sets group.facet parameter</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupoffset.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupOffset()</a> - Sets the group.offset parameter</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgrouplimit.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupLimit()</a> - Specifies the number of results to return for each group. The server default value is 1</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupmain.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupMain()</a> - If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupngroups.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupNGroups()</a> - If true, Solr includes the number of groups that have matched the query in the results</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgrouptruncate.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupTruncate()</a> - If true, facet counts are based on the most relevant document of each group matching the query</span></li>
<li class="member"><span class="methodname"><a href="solrquery.setgroupformat.html" class="methodname" rel="rdfs-seeAlso">SolrQuery::setGroupFormat()</a> - Sets the group format, result structure (group.format parameter)</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="solrquery.setgroup.html">SolrQuery::setGroup</a></div>
<div class="next" style="text-align: right; float: right;"><a href="solrquery.setgroupfacet.html">SolrQuery::setGroupFacet</a></div>
<div class="up"><a href="class.solrquery.html">SolrQuery</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
