CosmosDatabase.GetUserQueryIterator Méthode

Définition

Espace de noms:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Paquet:

Azure.Cosmos v4.0.0-preview3

Surcharges

GetUserQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)	Cette méthode crée une requête pour les utilisateurs sous une base de données à l’aide d’une instruction SQL. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition surcharge.
GetUserQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)	Cette méthode crée une requête pour les utilisateurs sous une base de données à l’aide d’une instruction SQL. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition surcharge.

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

Cette méthode crée une requête pour les utilisateurs sous une base de données à l’aide d’une instruction SQL. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition surcharge.

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)

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 requête de l’utilisateur QueryRequestOptions

cancellationToken

CancellationToken

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

Retours

AsyncPageable<T>

Un itérateur pour passer par les utilisateurs

Exemples

Cela crée l’itérateur de flux de type pour les utilisateurs avec queryDefinition comme entrée.

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)

Cette méthode crée une requête pour les utilisateurs sous une base de données à l’aide d’une instruction SQL. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition surcharge.

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)

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 requête de l’utilisateur QueryRequestOptions

cancellationToken

CancellationToken

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

Retours

AsyncPageable<T>

Un itérateur pour passer par les utilisateurs

Exemples

1. Cela crée l’itérateur de flux de type pour les utilisateurs avec queryText comme entrée,

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

}

2. Cela crée l’itérateur de flux de type pour les utilisateurs sans queryText, récupérant tous les utilisateurs.

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

}