IFulltextQueryTDocumentToFutureListAsync(CancellationToken) Method

Get an asynchronously, lazily initialized list of results. Accessing the results will trigger the execution of all pending future results as a batch of asynchronous queries in a single roundtrip to searchd.

Namespace: SphinxConnector.FluentApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 6.0.0

Syntax

Copy

Lazy<Task<IList<TDocument>>> ToFutureListAsync(
	CancellationToken cancellationToken
)

Function ToFutureListAsync ( 
	cancellationToken As CancellationToken
) As Lazy(Of Task(Of IList(Of TDocument)))

Parameters

cancellationToken CancellationToken: The token to monitor for cancellation requests.

Return Value

LazyTaskIListTDocument
A lazily initialized list of results for the query.
A task representing the asynchronous operation.

Exceptions

Exception	Condition
FulltextException	Occurs when there is an error during the execution of the query.
OperationCanceledException	Occurs when cancellation has been requested.

Example

Suppose you have the following class representing a document in your index:
Consider the following example:


             using (IFulltextSession fulltextSession = fulltextStore.StartSession())
             {                
                 var results = fulltextSession.Query<Product>().
                                               Match("a product").        
                                               ToFutureListAsync();
             
                 var facets = fulltextSession.Query<Product>().
                                              Match("a product").
                                              GroupBy(p => p.CategoryId).
                                              Select(p => new 
                                              { 
                                                    p.CategoryId,
                                                    Count = Projection.Count()
                                              }).
                                              ToFutureListAsync();
            
                //No query has been executed up to this point
             
                foreach (result in await results.Value) //<-- accessing the result of a query will cause all pending future queries 
                {                                       //to be executed in one roundtrip to Sphinx at this point
                     //...
                }
             }

Reference

IFulltextQueryTDocument Interface

ToFutureListAsync Overload

SphinxConnector.FluentApi Namespace