CosmosDatabase.GetUserQueryIterator Método

Definição

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

Sobrecargas

GetUserQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)	Esse método cria uma consulta para usuários em um banco de dados usando uma instrução SQL. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition sobrecarga.
GetUserQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)	Esse método cria uma consulta para usuários em um banco de dados usando uma instrução SQL. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition sobrecarga.

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

Esse método cria uma consulta para usuários em um banco de dados usando uma instrução SQL. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition sobrecarga.

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)

Parâmetros de tipo

T

Parâmetros

queryDefinition

QueryDefinition

A definição de consulta sql cosmos.

continuationToken

String

(Opcional) O token de continuação no serviço do Azure Cosmos DB.

requestOptions

QueryRequestOptions

(Opcional) As opções para a solicitação de consulta do usuário QueryRequestOptions

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

AsyncPageable<T>

Um iterador para percorrer os usuários

Exemplos

Isso cria o iterador de feed de tipo para usuários com queryDefinition como entrada.

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)

Esse método cria uma consulta para usuários em um banco de dados usando uma instrução SQL. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition sobrecarga.

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)

Parâmetros de tipo

T

Parâmetros

queryText

String

O texto da consulta COSMOS SQL.

continuationToken

String

(Opcional) O token de continuação no serviço do Azure Cosmos DB.

requestOptions

QueryRequestOptions

(Opcional) As opções para a solicitação de consulta do usuário QueryRequestOptions

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

AsyncPageable<T>

Um iterador para percorrer os usuários

Exemplos

1. Isso cria o iterador de feed de tipo para usuários com queryText como entrada,

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

}

2. Isso cria o iterador de feed de tipo para usuários sem queryText, recuperando todos os usuários.

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

}