CosmosContainer.GetItemQueryIterator Méthode

Définition

Espace de noms:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Paquet:

Azure.Cosmos v4.0.0-preview3

Surcharges

GetItemQueryIterator<T>(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.
GetItemQueryIterator<T>(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.

GetItemQueryIterator<T>(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 Azure.AsyncPageable<T> GetItemQueryIterator<T> (Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

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

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

Paramètres de type

T

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

AsyncPageable<T>

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

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(ToDoActivity item in this.Container.GetItemQueryIterator<ToDoActivity>(
    queryDefinition,
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        Console.WriteLine(item.cost);
}

GetItemQueryIterator<T>(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 Azure.AsyncPageable<T> GetItemQueryIterator<T> (string queryText = default, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

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

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

Paramètres de type

T

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

AsyncPageable<T>

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

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

await foreach(ToDoActivity item in this.Container.GetItemQueryIterator<ToDoActivity>(
    "select * from ToDos t where t.cost > 9000",
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        Console.WriteLine(item.cost);
}

2. Créez 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(ToDoActivity item in this.Container.GetItemQueryIterator<ToDoActivity>(
    null,
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        Console.WriteLine(item.cost);
}