CosmosDatabase.GetContainerQueryIterator Method

Definition

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Package:

Azure.Cosmos v4.0.0-preview3

Overloads

GetContainerQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)	This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.
GetContainerQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)	This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

GetContainerQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)

This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

public abstract Azure.AsyncPageable<T> GetContainerQueryIterator<T> (string queryText = default, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetContainerQueryIterator : string * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>

Public MustOverride Function GetContainerQueryIterator(Of T) (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of T)

Type Parameters

T

Parameters

queryText

String

The cosmos SQL query text.

continuationToken

String

(Optional) The continuation token in the Azure Cosmos DB service.

requestOptions

QueryRequestOptions

(Optional) The options for the item query request QueryRequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

AsyncPageable<T>

An iterator to go through the containers

Examples

1. This create the type feed iterator for containers with queryText as input,

string queryText = "SELECT * FROM c where c.id like '%testId%'";
await foreach(ContainerProperties properties in this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>(querytext))
{
    Console.WriteLine(properties.Id);
}

2. This create the type feed iterator for containers without queryText, retrieving all containers.

await foreach(ContainerProperties properties in this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>())
{
    Console.WriteLine(properties.Id);
}

GetContainerQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)

This method creates a query for containers under an database using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

public abstract Azure.AsyncPageable<T> GetContainerQueryIterator<T> (Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetContainerQueryIterator : Azure.Cosmos.QueryDefinition * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>

Public MustOverride Function GetContainerQueryIterator(Of T) (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of T)

Type Parameters

T

Parameters

queryDefinition

QueryDefinition

The cosmos SQL query definition.

continuationToken

String

(Optional) The continuation token in the Azure Cosmos DB service.

requestOptions

QueryRequestOptions

(Optional) The options for the item query request QueryRequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

AsyncPageable<T>

An iterator to go through the containers

Examples

This create the type feed iterator for containers with queryDefinition as input.

string queryText = "SELECT * FROM c where c.id like @testId";
QueryDefinition queryDefinition = new QueryDefinition(queryText);
queryDefinition.WithParameter("@testId", "testDatabaseId");
await foreach(ContainerProperties properties in this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>(queryDefinition))
{
    Console.WriteLine(properties.Id);
}