 | SphinxSearchOptions Class |
Provides methods and properties to configure e.g. how searchd matches and sorts results,
set filters on attributes etc.
Inheritance HierarchyNamespace: SphinxConnector.NativeApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 5.4.1
SyntaxThe SphinxSearchOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SphinxSearchOptions |
Initializes a new instance of the SphinxSearchOptions class.
|
Properties| Name | Description | |
|---|---|---|
 | Cutoff |
Gets or sets the cutoff, i.e. searchd will stop processing results after the
specified number of matches have been processed. Default is 0, which means
not to cut off results.
|
| DistributedRetryCount |
Gets or sets the distributed retry count.
|
| DistributedRetryDelay |
Gets or sets the distributed retry delay.
|
 | GroupBy |
Gets or sets the attribute to group by.
|
| GroupByFunction |
Gets or sets the group by function. Default is Day.
|
| GroupDistinct |
Gets or sets the group distinct attribute.
|
| GroupSort |
Gets or sets the group sort clause. Default is @group desc.
|
| Limit |
Gets or sets a limit for the number of matches to return from searchd. Default is 20.
|
| MatchMode |
Gets or sets the match mode. Default is All.
|
| MaxDocumentId |
Gets or sets the maximum id for a document to be matched. Default is 0.
|
| MaxMatches |
Gets or sets the maximum number of documents that searchd will match. Default is 1000.
|
| MaxQueryTime |
Gets or sets the maximum time for a query. This value is applied per index.
Default is MaxValue which means no limit.
|
| MinDocumentId |
Gets or sets the mininum Id for a document to be matched. Default is 0.
|
| Offset |
Gets or sets the offset from which to return results from searchd.
|
| QueryFlags |
Gets or sets additional query flags. Supported with Sphinx 2.1.1 and up.
|
| RankingExpression |
Gets or sets the ranking expression to use with rank mode Expression.
|
| RankMode |
Gets or sets the rank mode. Default is ProximityBM25 |
| Select |
Gets or sets the select clause. Default is "*";
|
| SortBy | |
| SortMode |
Gets or sets the sort mode. Default is Relevance.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ResetFilters |
Resets all filters which were added via one of the SetFilter() or SetFilterRange() methods
and SetGeoAnchor(String, String, Single, Single).
|
| ResetOuterSelect |
Resets the outer select.
|
| ResetOverrides |
Resets all overrides.
|
| SetDocumentIdRange |
Sets the mininum and maximum ids for a document to be matched.
|
| SetFieldWeight |
Sets a weight for the field with the given name. If a weight for the field has previously
been set, it will be overwritten.
|
| SetFilterTFilterable(String, TFilterable) |
Sets a filter for the attribute with the given name.
|
| SetFilterTFilterable(String, TFilterable, Boolean) |
Sets a filter for the attribute with the given name.
|
| SetFilterTFilterable(String, IEnumerableTFilterable, Boolean) |
Sets a filter for the attribute with the given name.
|
| SetFilterRangeTRangeFilterable |
Sets a range filter for the attribute with the given attribute name.
|
| SetGeoAnchor |
Sets an anchor point for geosphere distance calculations.
|
| SetIndexWeight |
Sets a weight for the index with the given name. The method should be called for each
index that should have a weight set. If a weight for an index has previously been set,
it will be overwritten.
|
| SetOuterSelect |
Sets the outer select. Supported with Sphinx 2.1.1 and up.
|
| SetOverrideTOverridable |
Sets the override values for an attribute. If values for the attribute have previously
been set, they will be overwritten.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Thread SafetyAny public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also