CosmosContainer.GetItemQueryStreamIterator Méthode

Définition

Espace de noms:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Paquet:

Azure.Cosmos v4.0.0-preview3

Surcharges

GetItemQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)	Cette méthode crée une requête pour les éléments d’un conteneur dans une base de données Azure Cosmos à l’aide d’une instruction SQL avec des valeurs paramétrables. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition.
GetItemQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)	Cette méthode crée une requête pour les éléments d’un conteneur dans une base de données Azure Cosmos à l’aide d’une instruction SQL avec des valeurs paramétrables. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition.

GetItemQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)

Cette méthode crée une requête pour les éléments d’un conteneur dans une base de données Azure Cosmos à l’aide d’une instruction SQL avec des valeurs paramétrables. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez 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)

Paramètres

queryDefinition

QueryDefinition

Définition de requête Cosmos SQL.

continuationToken

String

(Facultatif) Jeton de continuation dans le service Azure Cosmos DB.

requestOptions

QueryRequestOptions

(Facultatif) Options de la demande de requête d’élément QueryRequestOptions

cancellationToken

CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

IAsyncEnumerable<Response>

Itérateur pour parcourir les éléments.

Exemples

Créer une requête pour obtenir tous les ToDoActivity dont le coût est supérieur à 9 000 pour la partition spécifiée

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);
        }
    }

Remarques

La requête en tant que flux ne prend en charge que les requêtes à partition unique

GetItemQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)

Cette méthode crée une requête pour les éléments d’un conteneur dans une base de données Azure Cosmos à l’aide d’une instruction SQL avec des valeurs paramétrables. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez 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)

Paramètres

queryText

String

Texte de la requête Cosmos SQL.

continuationToken

String

(Facultatif) Jeton de continuation dans le service Azure Cosmos DB.

requestOptions

QueryRequestOptions

(Facultatif) Options de la demande de requête d’élément QueryRequestOptions

cancellationToken

CancellationToken

(Facultatif) CancellationToken représentant l’annulation de la demande.

Retours

IAsyncEnumerable<Response>

Itérateur pour parcourir les éléments.

Exemples

1. Créer une requête pour obtenir tous les ToDoActivity dont le coût est supérieur à 9 000 pour la partition spécifiée

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);
        }
}

2. Crée un FeedIterator pour obtenir tous les 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(
    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);
        }
}

Remarques

La requête en tant que flux ne prend en charge que les requêtes à partition unique