Database.GetUserQueryIterator Método

Definición

Espacio de nombres:

Microsoft.Azure.Cosmos

Ensamblado:

Microsoft.Azure.Cosmos.Client.dll

Paquete:

Microsoft.Azure.Cosmos v3.39.0

Sobrecargas

GetUserQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	Este método crea una consulta para los usuarios de una base de datos mediante una instrucción SQL con valores con parámetros. Devuelve un feedIterator. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte QueryDefinition sobrecarga.
GetUserQueryIterator<T>(String, String, QueryRequestOptions)	Este método crea una consulta para los usuarios de una base de datos mediante una instrucción SQL. Devuelve un feedIterator.

GetUserQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)

Source:

Database.cs

Este método crea una consulta para los usuarios de una base de datos mediante una instrucción SQL con valores con parámetros. Devuelve un feedIterator. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte QueryDefinition sobrecarga.

public abstract Microsoft.Azure.Cosmos.FeedIterator<T> GetUserQueryIterator<T> (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

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

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

Parámetros de tipo

T

Parámetros

queryDefinition

QueryDefinition

Definición de consulta de Cosmos SQL.

continuationToken

String

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

requestOptions

QueryRequestOptions

(Opcional) Las opciones de la solicitud de consulta de usuario.

Devoluciones

FeedIterator<T>

Iterador para pasar por los usuarios

Ejemplos

Esto crea el iterador de fuente de tipos para los usuarios con queryDefinition como entrada.

QueryDefinition queryDefinition = new QueryDefinition("SELECT * FROM c where c.status like @status")
    .WithParameter("@status", "start%");
using (FeedIterator<UserProperties> resultSet = this.cosmosDatabase.GetUserQueryIterator<UserProperties>(queryDefinition))
{
    while (feedIterator.HasMoreResults)
    {
        foreach (UserProperties properties in await feedIterator.ReadNextAsync())
        {
            Console.WriteLine(properties.Id);
        }
    }
}

GetUserQueryIterator<T>(String, String, QueryRequestOptions)

Source:

Database.cs

Este método crea una consulta para los usuarios de una base de datos mediante una instrucción SQL. Devuelve un feedIterator.

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

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

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

Parámetros de tipo

T

Parámetros

queryText

String

Texto de la consulta de Cosmos SQL.

continuationToken

String

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

requestOptions

QueryRequestOptions

(Opcional) Las opciones de la solicitud de consulta de usuario.

Devoluciones

FeedIterator<T>

Iterador para pasar por los usuarios

Ejemplos

1. Esto crea el iterador de fuente de tipos para los usuarios con queryText como entrada,

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

2. Esto crea el iterador de fuente de tipos para los usuarios sin queryText, recuperando todos los usuarios.

using (FeedIterator<UserProperties> feedIterator = this.cosmosDatabase.GetUserQueryIterator<UserProperties>())
{
    while (feedIterator.HasMoreResults)
    {
        FeedResponse<UserProperties> response = await feedIterator.ReadNextAsync();
        foreach (var user in response)
        {
            Console.WriteLine(user);
        }
    }
}