SolrNet.SolrFacetFieldQuery Class Reference

Facet field query. More...

Inheritance diagram for SolrNet.SolrFacetFieldQuery:

List of all members.

Public Member Functions
	SolrFacetFieldQuery (string field)
Properties
string	Field [get]
	Facet field.
string	Prefix [get, set]
bool	Sort [get, set]
	Set to true, this parameter indicates that constraints should be sorted by their count. If false, facets will be in their natural index order (unicode). For terms in the ascii range, this will be alphabetically sorted. The default is true if Limit is greater than 0, false otherwise.
int	Limit [get, set]
	This param indicates the maximum number of constraint counts that should be returned for the facet fields. A negative value means unlimited. The default value is 100.
int	Offset [get, set]
	This param indicates an offset into the list of constraints to allow paging. The default value is 0.
int	MinCount [get, set]
	This param indicates the minimum counts for facet fields should be included in the response. The default value is 0.
bool	Missing [get, set]
	Set to true this param indicates that in addition to the Term based constraints of a facet field, a count of all matching results which have no value for the field should be computed Default is false.
int	EnumCacheMinDf [get, set]
	This param indicates the minimum document frequency (number of documents matching a term) for which the filterCache should be used when determining the constraint count for that term. This is only used during the term enumeration method of faceting (field type faceting on multi-valued or full-text fields). A value greater than zero will decrease memory usage of the filterCache, but increase the query time. When faceting on a field with a very large number of terms, and you wish to decrease memory usage, try a low value of 25 to 50 first. The default value is 0, causing the filterCache to be used for all terms in the field.

---

Detailed Description

Facet field query.

---

Property Documentation

int SolrNet.SolrFacetFieldQuery.EnumCacheMinDf [get, set]

This param indicates the minimum document frequency (number of documents matching a term) for which the filterCache should be used when determining the constraint count for that term. This is only used during the term enumeration method of faceting (field type faceting on multi-valued or full-text fields). A value greater than zero will decrease memory usage of the filterCache, but increase the query time. When faceting on a field with a very large number of terms, and you wish to decrease memory usage, try a low value of 25 to 50 first. The default value is 0, causing the filterCache to be used for all terms in the field.

string SolrNet.SolrFacetFieldQuery.Field [get]

Facet field.

int SolrNet.SolrFacetFieldQuery.Limit [get, set]

This param indicates the maximum number of constraint counts that should be returned for the facet fields. A negative value means unlimited. The default value is 100.

int SolrNet.SolrFacetFieldQuery.MinCount [get, set]

This param indicates the minimum counts for facet fields should be included in the response. The default value is 0.

bool SolrNet.SolrFacetFieldQuery.Missing [get, set]

Set to true this param indicates that in addition to the Term based constraints of a facet field, a count of all matching results which have no value for the field should be computed Default is false.

int SolrNet.SolrFacetFieldQuery.Offset [get, set]

This param indicates an offset into the list of constraints to allow paging. The default value is 0.

string SolrNet.SolrFacetFieldQuery.Prefix [get, set]

Limits the terms on which to facet to those starting with the given string prefix.

bool SolrNet.SolrFacetFieldQuery.Sort [get, set]

Set to true, this parameter indicates that constraints should be sorted by their count. If false, facets will be in their natural index order (unicode). For terms in the ascii range, this will be alphabetically sorted. The default is true if Limit is greater than 0, false otherwise.

---

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

• SolrNet/SolrFacetFieldQuery.cs