SolrNet.Commands.Parameters.GroupingParameters Class Reference

Parameters to query grouping / collapsing (Only SOLR 4.0) More...

List of all members.

Public Member Functions
	GroupingParameters ()
	Constructor for GroupingParameters.
Properties
ICollection< string >	Fields [get, set]
	Fields to group the results by. Each field will return it's own group. Group based on the unique values of a field(s). The field must currently be single-valued and must be either indexed, or be another field type that has a value source and works in a function query - such as ExternalFileField.
int	Limit [get, set]
	The number of results (documents) to return for each group. Defaults to 1.
int	Offset [get, set]
	The offset into the document list of each group.
ICollection< SortOrder >	OrderBy [get, set]
	How to sort documents within a single group. Defaults to the same value as the sort parameter.
bool	Main [get, set]
	If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple default is false.
string	Query [get, set]
	Return a single group of documents that also match the given query.
string	Func [get, set]
	Group based on the unique values of a function query.
bool	Ngroups [get, set]
	Includes the number of groups that have matched the query. Default is false.
GroupingFormat	Format [get, set]
	Controls the way the group is formatted in the output http://wiki.apache.org/solr/FieldCollapsing.parameters

---

Detailed Description

Parameters to query grouping / collapsing (Only SOLR 4.0)

group.func AND group.query parameters are missing http://wiki.apache.org/solr/FieldCollapsing http://wiki.apache.org/solr/FieldCollapsing.parameters

---

Constructor & Destructor Documentation

SolrNet.Commands.Parameters.GroupingParameters.GroupingParameters

(

)

Constructor for GroupingParameters.

---

Property Documentation

ICollection<string> SolrNet.Commands.Parameters.GroupingParameters.Fields [get, set]

Fields to group the results by. Each field will return it's own group. Group based on the unique values of a field(s). The field must currently be single-valued and must be either indexed, or be another field type that has a value source and works in a function query - such as ExternalFileField.

GroupingFormat SolrNet.Commands.Parameters.GroupingParameters.Format [get, set]

Controls the way the group is formatted in the output http://wiki.apache.org/solr/FieldCollapsing.parameters

string SolrNet.Commands.Parameters.GroupingParameters.Func [get, set]

Group based on the unique values of a function query.

int SolrNet.Commands.Parameters.GroupingParameters.Limit [get, set]

The number of results (documents) to return for each group. Defaults to 1.

bool SolrNet.Commands.Parameters.GroupingParameters.Main [get, set]

If true, the result of the first field grouping command is used as the main result list in the response, using group.format=simple default is false.

bool SolrNet.Commands.Parameters.GroupingParameters.Ngroups [get, set]

Includes the number of groups that have matched the query. Default is false.

int SolrNet.Commands.Parameters.GroupingParameters.Offset [get, set]

The offset into the document list of each group.

ICollection<SortOrder> SolrNet.Commands.Parameters.GroupingParameters.OrderBy [get, set]

How to sort documents within a single group. Defaults to the same value as the sort parameter.

string SolrNet.Commands.Parameters.GroupingParameters.Query [get, set]

Return a single group of documents that also match the given query.

---

The documentation for this class was generated from the following file:

• SolrNet/Commands/Parameters/GroupingParameters.cs