CosmosContainer.GetItemQueryIterator Método

Definição

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

Sobrecargas

GetItemQueryIterator<T>(QueryDefinition, String, QueryRequestOptions, CancellationToken)	Esse método cria uma consulta para itens em um contêiner em um banco de dados do Azure Cosmos usando uma instrução SQL com valores parametrizados. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition.
GetItemQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)	Esse método cria uma consulta para itens em um contêiner em um banco de dados do Azure Cosmos usando uma instrução SQL com valores parametrizados. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition.

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

Esse método cria uma consulta para itens em um contêiner em um banco de dados do Azure Cosmos usando uma instrução SQL com valores parametrizados. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition.

public abstract Azure.AsyncPageable<T> GetItemQueryIterator<T> (Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetItemQueryIterator : Azure.Cosmos.QueryDefinition * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>

Public MustOverride Function GetItemQueryIterator(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 de item QueryRequestOptions

cancellationToken

CancellationToken

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

Retornos

AsyncPageable<T>

Um iterador para percorrer os itens.

Exemplos

Criar uma consulta para obter todos os ToDoActivity que têm um custo maior que 9000

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
    public int cost {get; set;}
}

QueryDefinition queryDefinition = new QueryDefinition("select * from ToDos t where t.cost > @expensive")
    .WithParameter("@expensive", 9000);
await foreach(ToDoActivity item in this.Container.GetItemQueryIterator<ToDoActivity>(
    queryDefinition,
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        Console.WriteLine(item.cost);
}

GetItemQueryIterator<T>(String, String, QueryRequestOptions, CancellationToken)

Esse método cria uma consulta para itens em um contêiner em um banco de dados do Azure Cosmos usando uma instrução SQL com valores parametrizados. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition.

public abstract Azure.AsyncPageable<T> GetItemQueryIterator<T> (string queryText = default, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetItemQueryIterator : string * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> Azure.AsyncPageable<'T>

Public MustOverride Function GetItemQueryIterator(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 de item QueryRequestOptions

cancellationToken

CancellationToken

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

Retornos

AsyncPageable<T>

Um iterador para percorrer os itens.

Exemplos

1. Criar uma consulta para obter todos os ToDoActivity que têm um custo maior que 9000

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
    public int cost {get; set;}
}

await foreach(ToDoActivity item in this.Container.GetItemQueryIterator<ToDoActivity>(
    "select * from ToDos t where t.cost > 9000",
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        Console.WriteLine(item.cost);
}

2. Crie um FeedIterator para obter toda a ToDoActivity.

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
    public int cost {get; set;}
}

await foreach(ToDoActivity item in this.Container.GetItemQueryIterator<ToDoActivity>(
    null,
    null,
    new QueryRequestOptions() { PartitionKey = new PartitionKey("Error")}))
{
        Console.WriteLine(item.cost);
}