You are currently browsing legacy 3.5 version of documentation. Click here to switch to the newest 5.1 version.

We can help you with migration to the latest RavenDB

Contact Us Now
see on GitHub

Session: Querying: StreamQueryAsync

Query results can be streamed using StreamQueryAsync method from Advanced session operations.

Syntax

Task<IAsyncEnumerator<FileHeader>> StreamQueryAsync(IAsyncFilesQuery<FileHeader> query);
Parameters
query IAsyncFilesQuery<FileHeader> Query to stream results for

Return Value
Task<IAsyncEnumerator<FileHeader>> A task that represents the asynchronous operation. The task result is the enumerator of FileHeaders objects.

Example

var allFilesMatchingCriteria = new List<FileHeader>();

var query = session.Query().WhereStartsWith("Name","Fa" );

using (var reader = await session.Advanced.StreamQueryAsync(query))
{
    while (await reader.MoveNextAsync())
    {
        allFilesMatchingCriteria.Add(reader.Current);
    }
}

Information

Entities loaded using Stream will be transient (not attached to session).