The SphinxSearchOptions type exposes the following members.

Constructors

  Name Description
Public method SphinxSearchOptions
Initializes a new instance of the SphinxSearchOptions class.

Methods

  Name Description
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method ResetFilters
Resets all filters which were added via one of the SetFilter() or SetFilterRange() methods and SetGeoAnchor(String, String, Single, Single).
Public method ResetOverrides
Resets all overrides.
Public method SetDocumentIdRange
Sets the mininum and maximum ids for a document to be matched.
Public method 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.
Public method SetFilter<(Of <<'(TFilterable>)>>)(String, array<TFilterable>[]()[][])
Sets a filter for the attribute with the given name.
Public method SetFilter<(Of <<'(TFilterable>)>>)(String, IEnumerable<(Of <<'(TFilterable>)>>), Boolean)
Sets a filter for the attribute with the given name.
Public method SetFilter<(Of <<'(TFilterable>)>>)(String, TFilterable, Boolean)
Sets a filter for the attribute with the given name.
Public method SetFilterRange<(Of <<'(TRangeFilterable>)>>)(String, TRangeFilterable, TRangeFilterable)
Sets a range filter for the attribute with the given attribute name.
Public method SetFilterRange<(Of <<'(TRangeFilterable>)>>)(String, TRangeFilterable, TRangeFilterable, Boolean)
Sets a range filter for the attribute with the given attribute name.
Public method SetGeoAnchor
Sets an anchor point for geosphere distance calculations.
Public method SetIndexWeight
Sets a weight for the index with the given name. If a weight for the index has previously been set, it will be overwritten.
Public method SetOverride<(Of <<'(TOverridable>)>>)
Sets the override values for an attribute. If values for the attribute have previously been set, they will be overwritten.
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  Name Description
Public property 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.
Public property DistributedRetryCount
Gets or sets the distributed retry count.
Public property DistributedRetryDelay
Gets or sets the distributed retry delay.
Public property GroupBy
Gets or sets the attribute to group by.
Public property GroupByFunction
Gets or sets the group by function. Default is Day.
Public property GroupDistinct
Gets or sets the group distinct attribute.
Public property GroupSort
Gets or sets the group sort clause. Default is @group desc.
Public property Limit
Gets or sets a limit for the number of matches to return from searchd. Default is 20.
Public property MatchMode
Gets or sets the match mode. Default is All.
Public property MaxDocumentId
Gets or sets the maximum id for a document to be matched. Default is 0.
Public property MaxMatches
Gets or sets the maximum number of documents that searchd will match. Default is 1000.
Public property MaxQueryTime
Gets or sets the maximum time for a query. This value is applied per index. Default is MaxValue which means no limit.
Public property MinDocumentId
Gets or sets the mininum Id for a document to be matched. Default is 0.
Public property Offset
Gets or sets the offset from which to return results from searchd.
Public property RankingExpression
Gets or sets the ranking expression to use with Expression.
Public property RankMode
Gets or sets the rank mode. Default is ProximityBM25
Public property Select
Gets or sets the select clause. Default is "*";
Public property SortBy
Gets or sets a sort-by expression. Only valid if SortMode is not set to Relevance.
Public property SortMode
Gets or sets the sort mode. Default is Relevance.

See Also