CosmosDatabase.GetUserQueryIterator メソッド

定義

名前空間:

Azure.Cosmos

アセンブリ:

Azure.Cosmos.dll

パッケージ:

Azure.Cosmos v4.0.0-preview3

オーバーロード

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

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

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

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

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

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

型パラメーター

T

パラメーター

queryDefinition

QueryDefinition

Cosmos SQL クエリ定義。

continuationToken

String

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

requestOptions

QueryRequestOptions

(省略可能)ユーザー クエリ要求のオプション QueryRequestOptions

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

AsyncPageable<T>

ユーザーを通過する反復子

例

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

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

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

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

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

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

Public MustOverride Function GetUserQueryIterator(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)

型パラメーター

T

パラメーター

queryText

String

Cosmos SQL クエリ テキスト。

continuationToken

String

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

requestOptions

QueryRequestOptions

(省略可能)ユーザー クエリ要求のオプション QueryRequestOptions

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

AsyncPageable<T>

ユーザーを通過する反復子

例

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

string queryText = "SELECT * FROM c where c.id like '%testId%'";
await foreach (UserProperties properties in this.cosmosDatabase.GetUserQueryIterator<UserProperties>(queryText))
{

}

2. これにより、queryText を使用しないユーザーの型フィード反復子が作成され、すべてのユーザーが取得されます。

await foreach (UserProperties properties in this.cosmosDatabase.GetUserQueryIterator<ContainerProperties>())
{

}