php8.5
Home/ Manual/ solr / solrquery/ SolrQuery::addGroupField

SolrQuery::addGroupField

PHP function Edit on GitHub ✎

(PECL solr >= 2.2.0)

Add a field to be used to group results

Description

SolrQuery::addGroupField(string $value): SolrQuery

The name of the field by which to group results. The field must be single-valued, and either be indexed or a field type that has a value source and works in a function query, such as ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses group.field parameter

Parameters

value

The name of the field.

Return Values

Returns an instance of SolrQuery.

See Also

  • SolrQuery::setGroup
  • SolrQuery::addGroupFunction
  • SolrQuery::addGroupQuery
  • SolrQuery::addGroupSortField
  • SolrQuery::setGroupFacet
  • SolrQuery::setGroupOffset
  • SolrQuery::setGroupLimit
  • SolrQuery::setGroupMain
  • SolrQuery::setGroupNGroups
  • SolrQuery::setGroupTruncate
  • SolrQuery::setGroupFormat
  • SolrQuery::setGroupCachePercent

Source: reference/solr/solrquery/addgroupfield.xml · from the official PHP manual (php/doc-en)