<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="solrquery.setgroupcachepercent" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>SolrQuery::setGroupCachePercent</refname>
  <refpurpose>Enables caching for result grouping</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>SolrQuery</type><methodname>SolrQuery::setGroupCachePercent</methodname>
   <methodparam><type>int</type><parameter>percent</parameter></methodparam>
  </methodsynopsis>
  <para>
    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
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>percent</parameter></term>
    <listitem>
     <para>
      
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   
  </para>
 </refsect1>
 
 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Emits <classname>SolrIllegalArgumentException</classname> in case of an invalid parameter was passed.
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>SolrQuery::setGroup</methodname></member>
   <member><methodname>SolrQuery::addGroupField</methodname></member>
   <member><methodname>SolrQuery::addGroupFunction</methodname></member>
   <member><methodname>SolrQuery::addGroupQuery</methodname></member>
   <member><methodname>SolrQuery::addGroupSortField</methodname></member>
   <member><methodname>SolrQuery::setGroupFacet</methodname></member>
   <member><methodname>SolrQuery::setGroupOffset</methodname></member>
   <member><methodname>SolrQuery::setGroupLimit</methodname></member>
   <member><methodname>SolrQuery::setGroupMain</methodname></member>
   <member><methodname>SolrQuery::setGroupNGroups</methodname></member>
   <member><methodname>SolrQuery::setGroupTruncate</methodname></member>
   <member><methodname>SolrQuery::setGroupFormat</methodname></member>
  </simplelist>
 </refsect1>
 
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
