Contains classes to access Sphinx via the native protocol.

Classes

  Class Description
Public class BuildExcerptsOptions
Represents the options for the BuildExcerpts() method.
Public class LicenseException
The exception that is thrown on a licensing error.
Public class SphinxAttributeMatch
Provides information about a matched attribute.
Public class SphinxAttributeOverride<(Of <(<'TOverridable>)>)>
Represents an attribute for which values should be overwritten.
Public class SphinxAttributeUpdate<(Of <(<'TUpdateable>)>)>
Represents an attribute which should be updated with new values.
Public class SphinxBuildKeywordResult
Represents the result of the BuildKeywords() method.
Public class SphinxClient
Provides methods to access the functions offered by Sphinx using the native Sphinx protocol.
Public class SphinxClientException
The exception that is thrown when an error occurs.
Public class SphinxConversionException
Thrown in case a conversion from a .NET type to a Sphinx type fails.
Public class SphinxException
Base class for Sphinx exceptions.
Public class SphinxHelper
Provides helper methods.
Public class SphinxMatch
Provides information about a matched document.
Public class SphinxSearchOptions
Provides methods and properties to configure e.g. how searchd matches and sorts results, set filters on attributes etc.
Public class SphinxSearchResult
Represents the result of a query.
Public class SphinxStatusInfo
Provides the name and value of a status variable of searchd.
Public class SphinxVersion
Provides a convenient way to access to all supported Sphinx versions.
Public class SphinxWordInfo
Provides statistical information about a word from the query.

Structures

  Structure Description
Public structure SphinxBigInt
Represents the Sphinx type big int.
Public structure SphinxBoolean
Represents the Sphinx type bool.
Public structure SphinxFloat
Represents the Sphinx type float.
Public structure SphinxInteger
Represents the Sphinx type uint.
Public structure SphinxOrdinal
Represents the Sphinx type str2ordinal.
Public structure SphinxTimestamp
Represents the Sphinx type timestamp.

Interfaces

  Interface Description
Public interface IFilterableType
Types that implement this interface can be used as type argument to the SetFilter() method.
Public interface IOverridableType
Types that implement this interface can be overriden via the SetOverride() method.
Public interface IRangeFilterableType
Types that implement this interface can be used as a type argument to the SetFilterRange() method.
Public interface ISphinxType
Interface every implementation for a Sphinx type must implement.
Public interface IUpdateableType
Types that implement this interface can be updated via the UpdateAttributes() method.

Enumerations

  Enumeration Description
Public enumeration HtmlStripMode
Determines the mode Sphinx uses when stripping HTML from excerpts.
Public enumeration PassageBoundary
Determines the passage boundary when building excerpts.
Public enumeration SphinxAttributeType
Indicates the type of a Sphinx attribute.
Public enumeration SphinxGroupByFunction
Determines how the group by value is calculated.
Public enumeration SphinxMatchMode
Determines the mode searchd uses to match a document.
Public enumeration SphinxRankMode
Determines the rank mode searchd uses to rank matched documents. Only valid with Extended and Extended2.
Public enumeration SphinxSortMode
Determines the sort mode searchd uses to sort matched documents.