CosmosClient.GetDatabaseQueryIterator Méthode

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.39.0

Surcharges

GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à 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.
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)	Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à l’aide d’une instruction SQL. Elle retourne un FeedIterator.

GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)

Source:

CosmosClient.cs

Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à 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 virtual Microsoft.Azure.Cosmos.FeedIterator<T> GetDatabaseQueryIterator<T> (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetDatabaseQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>
override this.GetDatabaseQueryIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>

Public Overridable Function GetDatabaseQueryIterator(Of T) (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of T)

Paramètres de type

T

Paramètres

queryDefinition

QueryDefinition

Définition de requête Cosmos SQL.

continuationToken

String

Jeton de continuation dans le service Azure Cosmos DB.

requestOptions

QueryRequestOptions

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

Retours

FeedIterator<T>

Itérateur pour parcourir les bases de données.

Exemples

Cela crée l’itérateur de flux de type pour la base de données avec queryText comme entrée,

QueryDefinition queryDefinition = new QueryDefinition("SELECT * FROM c where c.status like @status")
    .WithParameter("@status", "start%");
using (FeedIterator<DatabaseProperties> feedIterator = this.users.GetDatabaseQueryIterator<DatabaseProperties>(queryDefinition))
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<DatabaseProperties> response = await feedIterator.ReadNextAsync();
        foreach (var database in response)
        {
            Console.WriteLine(database);
        }
    }
}

Remarques

Reportez-vous à pour obtenir des https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started exemples et la syntaxe.

ReadAsync(RequestOptions, CancellationToken) est recommandé pour la recherche d’une base de données unique.

GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)

Source:

CosmosClient.cs

Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à l’aide d’une instruction SQL. Elle retourne un FeedIterator.

public virtual Microsoft.Azure.Cosmos.FeedIterator<T> GetDatabaseQueryIterator<T> (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetDatabaseQueryIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>
override this.GetDatabaseQueryIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator<'T>

Public Overridable Function GetDatabaseQueryIterator(Of T) (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator(Of T)

Paramètres de type

T

Paramètres

queryText

String

Texte de la requête Cosmos SQL.

continuationToken

String

Jeton de continuation dans le service Azure Cosmos DB.

requestOptions

QueryRequestOptions

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

Retours

FeedIterator<T>

Itérateur pour parcourir les bases de données.

Exemples

Cela crée l’itérateur de flux de type pour la base de données avec queryText comme entrée,

string queryText = "SELECT * FROM c where c.status like 'start%'";
using (FeedIterator<DatabaseProperties> feedIterator = this.users.GetDatabaseQueryIterator<DatabaseProperties>(queryText)
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<DatabaseProperties> response = await feedIterator.ReadNextAsync();
        foreach (var database in response)
        {
            Console.WriteLine(database);
        }
    }
}

Remarques

Reportez-vous à pour obtenir des https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started exemples et la syntaxe.

ReadAsync(RequestOptions, CancellationToken) est recommandé pour la recherche d’une base de données unique.