FeedIterator.ReadNextAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.45.0

Source:: FeedIterator.cs

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.

Get the next set of results from the cosmos service

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

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

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

Parameters

cancellationToken: CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

Task<ResponseMessage>

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 feedIterator = this.Container.GetItemQueryStreamIterator(
    queryDefinition))
{
    while (feedIterator.HasMoreResults)
    {
        // Stream iterator returns a response with status code
        using(ResponseMessage response = await feedIterator.ReadNextAsync())
        {
            // Handle failure scenario
            if(!response.IsSuccessStatusCode)
            {
                // Log the response.Diagnostics and handle the error
            }
        }
    }
}

Applies to

Dela via