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

We can help you with migration to the latest RavenDB

Contact Us Now
see on GitHub

Session: Querying: StreamFileHeadersAsync

File Header can be streamed With StreamFileHeadersAsync method from Advanced session operations .

Syntax

Task<IAsyncEnumerator<FileHeader>> StreamFileHeadersAsync(Etag fromEtag, int pageSize = int.MaxValue);
Parameters
fromEtag Etag ETag of a file from which stream should start
pageSize int Maximum number of file headers that will be retrieved

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>();

using (var reader = await session.Advanced.StreamFileHeadersAsync(fromEtag: fromEtag, pageSize: 10))
{
    while (await reader.MoveNextAsync())
    {
        allFilesMatchingCriteria.Add(reader.Current);
    }
}

Information

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