The SphinxClient type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
|
SphinxClient()()()() |
Initializes a new instance of the SphinxClient class with
127.0.0.1 as host, 9312 as port and 0.9.9 as version.
|
|
|
SphinxClient(IPEndPoint) |
Initializes a new instance of the SphinxClient class.
|
|
|
SphinxClient(String, Int32) |
Initializes a new instance of the SphinxClient class.
|
Methods
| Name | Description | |
|---|---|---|
|
|
AddQuery(String) |
Adds a new query with the current SearchOptions to the search request.
|
|
|
AddQuery(String, String) |
Adds a new query with the current SearchOptions for the index with the
given name to the search request.
|
|
|
AddQuery(String, String, String) |
Adds a new query with the current SearchOptions for the index with the
given name, and the given comment to the search request.
|
|
|
BuildExcerpts(IEnumerable<(Of <<'(String>)>>), String, String) |
Builds excerpts for the given documents using the settings from the given index name and
inserting the default values for BeforeMatch and
AfterMatch before and after the given highlight
words.
|
|
|
BuildExcerpts(IEnumerable<(Of <<'(String>)>>), String, String, BuildExcerptsOptions) |
Builds excerpts for the given documents using the settings from the given index name and
the given options.
|
|
|
BuildKeywords |
Builds a list of keywords from the given query, using the settings from the specified index.
|
|
|
ClearQueries |
Clears the (internal) list of scheduled queries (queries which have been added via AddQuery(String)).
|
|
|
ClosePersistentConnection |
Closes a persistent connection.
|
|
|
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
|
|
Equals | (Inherited from Object.) |
|
|
FlushAttributes |
Causes Sphinx to do an attribute flush.
|
|
|
GetHashCode |
Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetStatus |
Gets an array of SphinxStatusInfo instances for each
status variable from searchd.
|
|
|
GetType |
Gets the type of the current instance. (Inherited from Object.) |
|
|
OpenPersistentConnection |
Opens a persistent connection to searchd.
|
|
|
Query(String) |
Sends the specified query to searchd and returns its result. The query is run
on all indices.
|
|
|
Query(String, String) |
Sends the specified query for the index with the given name to searchd and
returns its result.
|
|
|
Query(String, String, String) |
Sends the specified query for the index with the given name and a comment, which
will be written to the query log, to searchd and returns its result.
|
|
|
QueryWithSphinxQL | Obsolete.
Query searchd with SphinxQL.
|
|
|
ResetSearchOptions |
Resets the search options to their default values and clears field weights,
index weights etc.
|
|
|
RunQueries |
Runs the queries which have been added via the AddQuery method.
|
|
|
ToString |
Returns a string that represents the current object. (Inherited from Object.) |
|
|
UpdateAttributes<(Of <<'(TUpdateable>)>>) |
Updates attributes for the index with the given name with values from the given
sequence of SphinxAttributeUpdateItems.
|
Properties
| Name | Description | |
|---|---|---|
|
|
ConnectTimeout |
Gets or sets the connect timeout. Default is 30 seconds.
|
|
|
Encoding |
Gets or sets the encoding which is used when sending strings to searchd. Default is
UTF8.
|
|
|
Host |
Gets or sets the host on which searchd is running. Default is 127.0.0.1.
|
|
|
IPEndpoint | |
|
|
IsConnected |
Gets a value indicating whether the current instance is connected to Sphinx.
|
|
|
License |
Gets or sets the license information.
|
|
|
Port |
Gets or sets the port on which searchd is listening. Default is 9312.
|
|
|
SearchOptions |
Gets or sets the search options which are applied when a query is sent to searchd.
|
|
|
Version |
Gets or sets the version of Sphinx which this instance will
connect to. Default is 0.9.9.
|