IFulltextSession Interface

Represents a full-text session.

Definition

Namespace: SphinxConnector.FluentApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 6.1.0
C#
public interface IFulltextSession : IDisposable
Implements
IDisposable

Example

C#
using (IFulltextSession fulltextSession = fulltextStore.StartSession())
{
    //Do stuff with session
}

Properties

Advanced Provides access to advanced index operations.

Methods

BuildKeywordsTDocument Builds tokenized and normalized forms and statistics for the keywords extracted from the text.
BuildKeywordsAsyncTDocument Asynchronously builds tokenized and normalized forms and statistics for the keywords extracted from the text.
BuildSnippetsTDocument(IEnumerableString, String) Builds snippets for the given data using the text processing settings from the index for the given document type.
BuildSnippetsTDocument(IEnumerableString, String, SnippetsOptions) Builds snippets for the given data using the text processing settings from the index for the given document type.
BuildSnippetsAsyncTDocument(IEnumerableString, String) Builds snippets for the given data using the text processing settings from the index for the given document type.
BuildSnippetsAsyncTDocument(IEnumerableString, String, SnippetsOptions) Builds snippets for the given data using the text processing settings from the index for the given document type.
DeleteTDocument(Decimal) Schedule the documents with the given id(s) for deletion. The documents will be deleted when FlushChanges is called.
DeleteTDocument(TDocument) Schedules the given document for deletion. The document will be deleted when FlushChanges is called.
DeleteTDocument(Int32) Schedule the documents with the given id(s) for deletion. The documents will be deleted when FlushChanges is called.
DeleteTDocument(Int64) Schedule the documents with the given id(s) for deletion. The documents will be deleted when FlushChanges is called.
DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
FlushChanges Flushes all pending changes, i.e. all changes made via Save and Delete since the start of the session or since the last call to FlushChanges. All statements are executed within one transaction.
FlushChangesAsync Asynchronously flushes all pending changes, i.e. all changes made via Save and Delete since the start of the session or since the last call to FlushChanges. All statements are executed within one transaction.
FlushChangesAsync(CancellationToken) Asynchronously flushes all pending changes, i.e. all changes made via Save and Delete since the start of the session or since the last call to FlushChanges. All statements are executed within one transaction.
GetSuggestionsTDocument(String) Gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.
GetSuggestionsTDocument(String, SuggestionOptions) Gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.
GetSuggestionsAsyncTDocument(String) Asynchronously gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.
GetSuggestionsAsyncTDocument(String, SuggestionOptions) Asynchronously gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.
GetSuggestionsAsyncTDocument(String, CancellationToken) Asynchronously gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.
GetSuggestionsAsyncTDocument(String, SuggestionOptions, CancellationToken) Asynchronously gets a suggestion for the given word or query. In case of a single word Sphinx' SUGGEST() function is used, in case of a query (multiple words), QSUGGEST() is used.
QueryTDocument Create a new query for the document of the given type.
QueryTDocument, TResult(IPreparedQueryTDocument, TResult) Executes the given prepared query and returns the list of results
QueryAsyncTDocument, TResult(IPreparedQueryTDocument, TResult) Asynchronously executes the given prepared query and returns the list of results
QueryAsyncTDocument, TResult(IPreparedQueryTDocument, TResult, CancellationToken) Asynchronously executes the given prepared query and returns the list of results
QueryFutureTDocument, TResult Get a lazily initialized list of results. Accessing the results will trigger the execution of all pending future results as a batch of queries in a single roundtrip to searchd.
QueryFutureAsyncTDocument, TResult(IPreparedQueryTDocument, TResult) Get an asynchronously, lazily initialized list of results for the provided prepated query instance. Accessing the results will trigger the execution of all pending future results as a batch of asynchronous queries in a single roundtrip to searchd.
QueryFutureAsyncTDocument, TResult(IPreparedQueryTDocument, TResult, CancellationToken) Get an asynchronously, lazily initialized list of results for the provided prepated query instance. Accessing the results will trigger the execution of all pending future results as a batch of asynchronous queries in a single roundtrip to searchd.
Save(Object) Save the given document when FlushChanges is called.
SaveTDocument(IEnumerableTDocument) Save the given documents when FlushChanges is called.

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