DocumentQueryable.AsDocumentQuery<T>(IQueryable<T>) Method

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Linq

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Converts an IQueryable to IDocumentQuery which supports pagination and asynchronous execution in the Azure Cosmos DB service.

public static Microsoft.Azure.Documents.Linq.IDocumentQuery<T> AsDocumentQuery<T> (this System.Linq.IQueryable<T> query);

static member AsDocumentQuery : System.Linq.IQueryable<'T> -> Microsoft.Azure.Documents.Linq.IDocumentQuery<'T>

<Extension()>
Public Function AsDocumentQuery(Of T) (query As IQueryable(Of T)) As IDocumentQuery(Of T)

Type Parameters

T

the type of object to query.

Parameters

query: IQueryable<T>

the IQueryable{T} to be converted.

Returns

IDocumentQuery<T>

An IDocumentQuery{T} that can evaluate the query.

Examples

This example shows how to run a query asynchronously using the AsDocumentQuery() interface.

using (var queryable = client.CreateDocumentQuery<Book>(
    collectionLink,
    new FeedOptions { MaxItemCount = 10 })
    .Where(b => b.Title == "War and Peace")
    .AsDocumentQuery())
{
    while (queryable.HasMoreResults) 
    {
        foreach(Book b in await queryable.ExecuteNextAsync<Book>())
        {
            // Iterate through books
        }
    }
}

Applies to

Share via