Click or drag to resize

IFulltextSession Interface

Represents a full-text session.

Namespace:  SphinxConnector.FluentApi
Assembly:  SphinxConnector (in SphinxConnector.dll) Version: 5.4.1
Syntax
public interface IFulltextSession : IDisposable

The IFulltextSession type exposes the following members.

Properties
  NameDescription
Public propertyAdvanced
Provides access to advanced index operations.
Top
Methods
  NameDescription
Public methodBuildKeywords<TDocument>
Builds tokenized and normalized forms and statistics for the keywords extracted from the text.
Public methodBuildKeywordsAsync<TDocument>
Asynchronously builds tokenized and normalized forms and statistics for the keywords extracted from the text.
Public methodCode exampleBuildSnippets<TDocument>(IEnumerable<String>, String)
Builds snippets for the given data using the text processing settings from the index for the given document type.
Public methodCode exampleBuildSnippets<TDocument>(IEnumerable<String>, String, SnippetsOptions)
Builds snippets for the given data using the text processing settings from the index for the given document type.
Public methodCode exampleBuildSnippetsAsync<TDocument>(IEnumerable<String>, String)
Builds snippets for the given data using the text processing settings from the index for the given document type.
Public methodCode exampleBuildSnippetsAsync<TDocument>(IEnumerable<String>, String, SnippetsOptions)
Builds snippets for the given data using the text processing settings from the index for the given document type.
Public methodCode exampleDelete<TDocument>(Decimal[])
Schedule the documents with the given id(s) for deletion. The documents will be deleted when FlushChanges() is called.
Public methodCode exampleDelete<TDocument>(TDocument)
Schedules the given document for deletion. The document will be deleted when FlushChanges() is called.
Public methodCode exampleDelete<TDocument>(Int32[])
Schedule the documents with the given id(s) for deletion. The documents will be deleted when FlushChanges() is called.
Public methodCode exampleDelete<TDocument>(Int64[])
Schedule the documents with the given id(s) for deletion. The documents will be deleted when FlushChanges() is called.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.)
Public methodFlushChanges
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.
Public methodFlushChangesAsync()
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.
Public methodFlushChangesAsync(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.
Public methodGetSuggestions<TDocument>(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.
Public methodGetSuggestions<TDocument>(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.
Public methodGetSuggestionsAsync<TDocument>(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.
Public methodGetSuggestionsAsync<TDocument>(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.
Public methodGetSuggestionsAsync<TDocument>(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.
Public methodGetSuggestionsAsync<TDocument>(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.
Public methodQuery<TDocument>()
Create a new query for the document of the given type.
Public methodCode exampleQuery<TDocument, TResult>(IPreparedQuery<TDocument, TResult>)
Executes the given prepared query and returns the list of results
Public methodCode exampleQueryAsync<TDocument, TResult>(IPreparedQuery<TDocument, TResult>)
Asynchronously executes the given prepared query and returns the list of results
Public methodCode exampleQueryAsync<TDocument, TResult>(IPreparedQuery<TDocument, TResult>, CancellationToken)
Asynchronously executes the given prepared query and returns the list of results
Public methodQueryFuture<TDocument, 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.
Public methodQueryFutureAsync<TDocument, TResult>(IPreparedQuery<TDocument, 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.
Public methodQueryFutureAsync<TDocument, TResult>(IPreparedQuery<TDocument, 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.
Public methodSave(Object)
Public methodSave<TDocument>(IEnumerable<TDocument>)
Top
Examples
using (IFulltextSession fulltextSession = fulltextStore.StartSession())
{
    //Do stuff with session
}
Thread Safety
Instance members of this type are not safe for multi-threaded operations.
See Also