Click or drag to resize

SphinxSearchOptions Class

Provides methods and properties to configure e.g. how searchd matches and sorts results, set filters on attributes etc.
Inheritance Hierarchy
SystemObject
  SphinxConnector.NativeApiSphinxSearchOptions

Namespace:  SphinxConnector.NativeApi
Assembly:  SphinxConnector (in SphinxConnector.dll) Version: 5.3.0
Syntax
public class SphinxSearchOptions

The SphinxSearchOptions type exposes the following members.

Constructors
  NameDescription
Public methodSphinxSearchOptions
Initializes a new instance of the SphinxSearchOptions class.
Top
Properties
  NameDescription
Public propertyCutoff
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 propertyDistributedRetryCount
Gets or sets the distributed retry count.
Public propertyDistributedRetryDelay
Gets or sets the distributed retry delay.
Public propertyCode exampleGroupBy
Gets or sets the attribute to group by.
Public propertyGroupByFunction
Gets or sets the group by function. Default is Day.
Public propertyGroupDistinct
Gets or sets the group distinct attribute.
Public propertyGroupSort
Gets or sets the group sort clause. Default is @group desc.
Public propertyLimit
Gets or sets a limit for the number of matches to return from searchd. Default is 20.
Public propertyMatchMode
Gets or sets the match mode. Default is All.
Public propertyMaxDocumentId
Gets or sets the maximum id for a document to be matched. Default is 0.
Public propertyMaxMatches
Gets or sets the maximum number of documents that searchd will match. Default is 1000.
Public propertyMaxQueryTime
Gets or sets the maximum time for a query. This value is applied per index. Default is MaxValue which means no limit.
Public propertyMinDocumentId
Gets or sets the mininum Id for a document to be matched. Default is 0.
Public propertyOffset
Gets or sets the offset from which to return results from searchd.
Public propertyQueryFlags
Gets or sets additional query flags. Supported with Sphinx 2.1.1 and up.
Public propertyRankingExpression
Gets or sets the ranking expression to use with rank mode Expression.
Public propertyRankMode
Gets or sets the rank mode. Default is ProximityBM25
Public propertySelect
Gets or sets the select clause. Default is "*";
Public propertySortBy
Gets or sets a sort-by expression. Only valid if SortMode is not set to Relevance.
Public propertySortMode
Gets or sets the sort mode. Default is Relevance.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodResetFilters
Resets all filters which were added via one of the SetFilter() or SetFilterRange() methods and SetGeoAnchor(String, String, Single, Single).
Public methodResetOuterSelect
Resets the outer select.
Public methodResetOverrides
Resets all overrides.
Public methodSetDocumentIdRange
Sets the mininum and maximum ids for a document to be matched.
Public methodSetFieldWeight
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 methodCode exampleSetFilterTFilterable(String, TFilterable)
Sets a filter for the attribute with the given name.
Public methodSetFilterTFilterable(String, TFilterable, Boolean)
Sets a filter for the attribute with the given name.
Public methodSetFilterTFilterable(String, IEnumerableTFilterable, Boolean)
Sets a filter for the attribute with the given name.
Public methodCode exampleSetFilterRangeTRangeFilterable
Sets a range filter for the attribute with the given attribute name.
Public methodCode exampleSetGeoAnchor
Sets an anchor point for geosphere distance calculations.
Public methodCode exampleSetIndexWeight
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.
Public methodCode exampleSetOuterSelect
Sets the outer select. Supported with Sphinx 2.1.1 and up.
Public methodCode exampleSetOverrideTOverridable
Sets the override values for an attribute. If values for the attribute have previously been set, they will be overwritten.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Thread Safety
Any 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