CosmosClient.GetDatabaseQueryIterator メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

オーバーロード

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

GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)

ソース:

CosmosClient.cs

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

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

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

Public Overridable Function GetDatabaseQueryIterator(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>

データベースを通過する反復子。

例

これにより、queryText を入力として持つデータベースの型フィード反復子が作成されます。

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

注釈

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

ReadAsync(RequestOptions, CancellationToken) は、単一データベースの検索に推奨されます。

GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)

ソース:

CosmosClient.cs

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

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

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

Public Overridable Function GetDatabaseQueryIterator(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>

データベースを通過する反復子。

例

これにより、queryText を入力として持つデータベースの型フィード反復子が作成されます。

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

注釈

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

ReadAsync(RequestOptions, CancellationToken) は、単一データベースの検索に推奨されます。