次の方法で共有

CosmosContainer.GetItemQueryStreamIterator メソッド

  • リファレンス

定義

名前空間:
Azure.Cosmos
アセンブリ:
Azure.Cosmos.dll
パッケージ:
Azure.Cosmos v4.0.0-preview3

オーバーロード

GetItemQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)

このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、Azure Cosmos データベース内のコンテナーの下に項目のクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、 を参照してください QueryDefinition。
GetItemQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)

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

GetItemQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)

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

public abstract System.Collections.Generic.IAsyncEnumerable<Azure.Response> GetItemQueryStreamIterator (Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetItemQueryStreamIterator : Azure.Cosmos.QueryDefinition * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Response>
Public MustOverride Function GetItemQueryStreamIterator (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Response)

パラメーター

queryDefinition
QueryDefinition

Cosmos SQL クエリ定義。

continuationToken
String

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

requestOptions
QueryRequestOptions

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

cancellationToken
CancellationToken

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

戻り値

IAsyncEnumerable<Response>

項目を通過する反復子。

例

指定したパーティションのコストが 9000 を超えるすべての ToDoActivity を取得するクエリを作成する

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
    public int cost {get; set;}
}

QueryDefinition queryDefinition = new QueryDefinition("select * from ToDos t where t.cost > @expensive")
    .WithParameter("@expensive", 9000);
await foreach(Response response in this.Container.GetItemQueryStreamIterator(
                                                queryDefinition,
                                                null,
                                                new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
    {
        using (StreamReader sr = new StreamReader(response.Content))
        using (JsonTextReader jtr = new JsonTextReader(sr))
        {
            JObject result = JObject.Load(jtr);
        }
    }

注釈

ストリームとしてのクエリでは、単一パーティション クエリのみがサポートされます

適用対象

GetItemQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)

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

public abstract System.Collections.Generic.IAsyncEnumerable<Azure.Response> GetItemQueryStreamIterator (string queryText = default, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetItemQueryStreamIterator : string * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Response>
Public MustOverride Function GetItemQueryStreamIterator (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Response)

パラメーター

queryText
String

Cosmos SQL クエリ テキスト。

continuationToken
String

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

requestOptions
QueryRequestOptions

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

cancellationToken
CancellationToken

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

戻り値

IAsyncEnumerable<Response>

項目を通過する反復子。

例

  1. 指定したパーティションのコストが 9000 を超えるすべての ToDoActivity を取得するクエリを作成する
public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
    public int cost {get; set;}
}

await foreach(Response response in this.Container.GetItemQueryStreamIterator(
    "select * from ToDos t where t.cost > 9000",
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        using (StreamReader sr = new StreamReader(response.Content))
        using (JsonTextReader jtr = new JsonTextReader(sr))
        {
            JObject result = JObject.Load(jtr);
        }
}
  1. すべての ToDoActivity を取得する FeedIterator を作成します。
public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
    public int cost {get; set;}
}

await foreach(Response response in this.Container.GetItemQueryStreamIterator(
    null,
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        using (StreamReader sr = new StreamReader(response.Content))
        using (JsonTextReader jtr = new JsonTextReader(sr))
        {
            JObject result = JObject.Load(jtr);
        }
}

注釈

ストリームとしてのクエリでは、単一パーティション クエリのみがサポートされます

適用対象