FeedIterator<T>.ReadNextAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

FeedIterator%7BT%7D.cs

Get the next set of results from the cosmos service

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.FeedResponse<T>> ReadNextAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReadNextAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.FeedResponse<'T>>

Public MustOverride Function ReadNextAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of FeedResponse(Of T))

Parameters

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<FeedResponse<T>>

A query response from cosmos service

Examples

Example on how to fully drain the query results.

QueryDefinition queryDefinition = new QueryDefinition("select c.id From c where c.status = @status")
              .WithParameter("@status", "Failure");
using (FeedIterator<MyItem> feedIterator = this.Container.GetItemQueryIterator<MyItem>(
    queryDefinition))
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<MyItem> response = await feedIterator.ReadNextAsync();
        foreach (var item in response)
        {
            Console.WriteLine(item);
        }
    }
}