Database.GetContainerQueryIterator メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

オーバーロード

GetContainerQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、データベースの下にコンテナーのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、「オーバーロード」を参照してください QueryDefinition 。
GetContainerQueryIterator<T>(String, String, QueryRequestOptions)	このメソッドは、SQL ステートメントを使用して、データベースの下にコンテナーのクエリを作成します。 FeedIterator を返します。

GetContainerQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)

ソース:

Database.cs

このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、データベースの下にコンテナーのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、「オーバーロード」を参照してください QueryDefinition 。

public abstract Microsoft.Azure.Cosmos.FeedIterator<T> GetContainerQueryIterator<T> (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetContainerQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>

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

型パラメーター

T

パラメーター

queryDefinition

QueryDefinition

Cosmos SQL クエリ定義。

continuationToken

String

(省略可能)Azure Cosmos DB サービスの継続トークン。

requestOptions

QueryRequestOptions

(省略可能)項目クエリ要求のオプション。

戻り値

FeedIterator<T>

コンテナーを通過する反復子

例

これにより、queryDefinition を入力として持つコンテナーの型フィード反復子が作成されます。

QueryDefinition queryDefinition = new QueryDefinition("SELECT * FROM c where c.status like @status");
    .WithParameter("@status", "start%");
using (FeedIterator<ContainerProperties> feedIterator = this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>(queryDefinition))
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<ContainerProperties> response = await feedIterator.ReadNextAsync();
        foreach (var container in response)
        {
            Console.WriteLine(container);
        }
    }
}

注釈

構文と例については、 https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started を参照してください。

ReadContainerAsync(ContainerRequestOptions, CancellationToken) は、単一コンテナーの検索に推奨されます。

GetContainerQueryIterator<T>(String, String, QueryRequestOptions)

ソース:

Database.cs

このメソッドは、SQL ステートメントを使用して、データベースの下にコンテナーのクエリを作成します。 FeedIterator を返します。

public abstract Microsoft.Azure.Cosmos.FeedIterator<T> GetContainerQueryIterator<T> (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetContainerQueryIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>

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

型パラメーター

T

パラメーター

queryText

String

Cosmos SQL クエリ テキスト。

continuationToken

String

(省略可能)Azure Cosmos DB サービスの継続トークン。

requestOptions

QueryRequestOptions

(省略可能)項目クエリ要求のオプション。

戻り値

FeedIterator<T>

コンテナーを通過する反復子

例

1. これにより、queryText を入力として持つコンテナーの型フィード反復子が作成されます。

string queryText = "SELECT * FROM c where c.status like 'start%'";
using (FeedIterator<ContainerProperties> feedIterator = this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>(queryText))
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<ContainerProperties> response = await feedIterator.ReadNextAsync();
        foreach (var container in response)
        {
            Console.WriteLine(container);
        }
    }
}

2. これにより、queryText を使用せずにコンテナーの型フィード反復子が作成され、すべてのコンテナーが取得されます。

using (FeedIterator<ContainerProperties> feedIterator = this.cosmosDatabase.GetContainerQueryIterator<ContainerProperties>())
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<ContainerProperties> response = await feedIterator.ReadNextAsync();
        foreach (var container in response)
        {
           Console.WriteLine(container);
        }
    }
}

注釈

構文と例については、 https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started を参照してください。

ReadContainerAsync(ContainerRequestOptions, CancellationToken) は、単一コンテナーの検索に推奨されます。