CosmosClient.GetDatabaseQueryStreamIterator Método

Definición

Espacio de nombres:

Microsoft.Azure.Cosmos

Ensamblado:

Microsoft.Azure.Cosmos.Client.dll

Paquete:

Microsoft.Azure.Cosmos v3.39.0

Sobrecargas

GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL con valores parametrizados. Devuelve un feedIterator. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte QueryDefinition.
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)	Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL. Devuelve un feedIterator.

GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)

Source:

CosmosClient.cs

Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL con valores parametrizados. Devuelve un feedIterator. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte QueryDefinition.

public virtual Microsoft.Azure.Cosmos.FeedIterator GetDatabaseQueryStreamIterator (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetDatabaseQueryStreamIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator
override this.GetDatabaseQueryStreamIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator

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

Parámetros

queryDefinition

QueryDefinition

Definición de consulta de Cosmos SQL.

continuationToken

String

Token de continuación en el servicio Azure Cosmos DB.

requestOptions

QueryRequestOptions

(Opcional) Opciones de la solicitud de consulta.

Devoluciones

FeedIterator

Iterador para recorrer las bases de datos

Ejemplos

Ejemplo sobre cómo purgar completamente los resultados de la consulta.

QueryDefinition queryDefinition = new QueryDefinition("select * From c where c._rid = @rid")
              .WithParameter("@rid", "TheRidValue");
using (FeedIterator feedIterator = this.CosmosClient.GetDatabaseQueryStreamIterator(
    queryDefinition)
{
    while (feedIterator.HasMoreResults)
    {
        // Stream iterator returns a response with status for errors
        using(ResponseMessage response = await feedIterator.ReadNextAsync())
        {
            // Handle failure scenario. 
            if(!response.IsSuccessStatusCode)
            {
                // Log the response.Diagnostics and handle the error
            }
        }
    }
}

Comentarios

https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started Consulte para obtener sintaxis y ejemplos.

ReadStreamAsync(RequestOptions, CancellationToken) se recomienda para la búsqueda de una base de datos única.

GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)

Source:

CosmosClient.cs

Este método crea una consulta para las bases de datos en una cuenta de Cosmos DB mediante una instrucción SQL. Devuelve un feedIterator.

public virtual Microsoft.Azure.Cosmos.FeedIterator GetDatabaseQueryStreamIterator (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetDatabaseQueryStreamIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator
override this.GetDatabaseQueryStreamIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator

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

Parámetros

queryText

String

Texto de la consulta de Cosmos SQL.

continuationToken

String

Token de continuación en el servicio Azure Cosmos DB.

requestOptions

QueryRequestOptions

(Opcional) Opciones de la solicitud de consulta.

Devoluciones

FeedIterator

Iterador para recorrer las bases de datos

Ejemplos

Ejemplo sobre cómo purgar completamente los resultados de la consulta.

using (FeedIterator feedIterator = this.CosmosClient.GetDatabaseQueryStreamIterator(
    ("select * From c where c._rid = 'TheRidValue'")
{
    while (feedIterator.HasMoreResults)
    {
        // Stream iterator returns a response with status for errors
        using(ResponseMessage response = await feedIterator.ReadNextAsync())
        {
            // Handle failure scenario. 
            if(!response.IsSuccessStatusCode)
            {
                // Log the response.Diagnostics and handle the error
            }
        }
    }
}

Comentarios

https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started Consulte para obtener sintaxis y ejemplos.

ReadStreamAsync(RequestOptions, CancellationToken) se recomienda para la búsqueda de una base de datos única.