Compartilhar via


IDocumentClient.CreateDocumentQuery Método

Definição

Sobrecargas

CreateDocumentQuery(String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um serviço do Azure Cosmos DB. Ele retorna IOrderedQueryable{Document}.

CreateDocumentQuery(Uri, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

CreateDocumentQuery(String, SqlQuerySpec, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL com valores parametrizados. Ele retorna um IQueryable{dynamic}. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte SqlQuerySpec.

CreateDocumentQuery(String, String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL. Ele retorna um IQueryable{dynamic}.

CreateDocumentQuery(Uri, SqlQuerySpec, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

CreateDocumentQuery(Uri, String, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

CreateDocumentQuery<T>(Uri, SqlQuerySpec, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

CreateDocumentQuery<T>(Uri, String, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

CreateDocumentQuery<T>(String, String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL. Ele retorna um IQueryable{T}.

CreateDocumentQuery<T>(String, SqlQuerySpec, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL com valores parametrizados. Ele retorna um IQueryable{T}. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte SqlQuerySpec.

CreateDocumentQuery<T>(Uri, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

CreateDocumentQuery<T>(String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um serviço do Azure Cosmos DB.

CreateDocumentQuery(String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um serviço do Azure Cosmos DB. Ele retorna IOrderedQueryable{Document}.

public System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.Document> CreateDocumentQuery (string collectionLink, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.Document>
Public Function CreateDocumentQuery (collectionLink As String, Optional feedOptions As FeedOptions = Nothing) As IOrderedQueryable(Of Document)

Parâmetros

collectionLink
String

O link para a coleção de documentos pai.

feedOptions
FeedOptions

As opções para processar o feed de resultados da consulta. Para obter detalhes, confira FeedOptions

Retornos

Um IOrderedQueryable{Document} que pode avaliar a consulta.

Exemplos

Este exemplo abaixo consulta documentos por ID.

Document document = client.CreateDocumentQuery<Document>(collectionLink)
    .Where(d => d.Id == "War and Peace").AsEnumerable().FirstOrDefault();

Comentários

Essa sobrecarga deve ser usada quando o esquema dos documentos consultados é desconhecido ou ao consultar por ID e substituir/excluir documentos. Como Document é um DynamicObject, ele pode ser convertido dinamicamente de volta para o objeto C# original.

Confira também

Aplica-se a

CreateDocumentQuery(Uri, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

public System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.Document> CreateDocumentQuery (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<Microsoft.Azure.Documents.Document>
Public Function CreateDocumentQuery (documentCollectionUri As Uri, Optional feedOptions As FeedOptions = Nothing) As IOrderedQueryable(Of Document)

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos.

feedOptions
FeedOptions

(Opcional) O FeedOptions para processar o feed de resultados da consulta.

Retornos

O conjunto de resultados da consulta.

Aplica-se a

CreateDocumentQuery(String, SqlQuerySpec, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL com valores parametrizados. Ele retorna um IQueryable{dynamic}. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte SqlQuerySpec.

public System.Linq.IQueryable<dynamic> CreateDocumentQuery (string collectionLink, Microsoft.Azure.Documents.SqlQuerySpec querySpec, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : string * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
Public Function CreateDocumentQuery (collectionLink As String, querySpec As SqlQuerySpec, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)

Parâmetros

collectionLink
String

O link para a coleção de documentos pai.

querySpec
SqlQuerySpec

A instância sqlQuerySpec que contém a expressão SQL.

feedOptions
FeedOptions

As opções para processar o feed de resultados da consulta. Para obter detalhes, confira FeedOptions

Retornos

um IQueryable{dynamic> que pode avaliar a consulta.

Exemplos

Este exemplo abaixo consulta documentos de livro.

// SQL querying allows dynamic property access
var query = new SqlQuerySpec(
    "SELECT * FROM books b WHERE b.title = @title", 
    new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@title", Value = "War and Peace" }}));

dynamic document = client.CreateDocumentQuery<dynamic>(collectionLink, query).AsEnumerable().FirstOrDefault();

Comentários

Consulte para https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started/ obter sintaxe e exemplos.

Confira também

Aplica-se a

CreateDocumentQuery(String, String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL. Ele retorna um IQueryable{dynamic}.

public System.Linq.IQueryable<dynamic> CreateDocumentQuery (string collectionLink, string sqlExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : string * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
Public Function CreateDocumentQuery (collectionLink As String, sqlExpression As String, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)

Parâmetros

collectionLink
String

O link para a coleção de documentos pai.

sqlExpression
String

A instrução SQL.

feedOptions
FeedOptions

As opções para processar o feed de resultados da consulta. Para obter detalhes, confira FeedOptions

Retornos

um IQueryable{dynamic> que pode avaliar a consulta.

Exemplos

Este exemplo abaixo consulta documentos de livro.

// SQL querying allows dynamic property access
dynamic document = client.CreateDocumentQuery<dynamic>(collectionLink,
    "SELECT * FROM books b WHERE b.title == 'War and Peace'").AsEnumerable().FirstOrDefault();

Comentários

Consulte para https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started/ obter sintaxe e exemplos.

Confira também

Aplica-se a

CreateDocumentQuery(Uri, SqlQuerySpec, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

public System.Linq.IQueryable<dynamic> CreateDocumentQuery (Uri documentCollectionUri, Microsoft.Azure.Documents.SqlQuerySpec querySpec, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : Uri * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
Public Function CreateDocumentQuery (documentCollectionUri As Uri, querySpec As SqlQuerySpec, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos.

querySpec
SqlQuerySpec

A consulta sql.

feedOptions
FeedOptions

(Opcional) O FeedOptions para processar o feed de resultados da consulta.

Retornos

O conjunto de resultados da consulta.

Aplica-se a

CreateDocumentQuery(Uri, String, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

public System.Linq.IQueryable<dynamic> CreateDocumentQuery (Uri documentCollectionUri, string sqlExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : Uri * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<obj>
Public Function CreateDocumentQuery (documentCollectionUri As Uri, sqlExpression As String, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of Object)

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos.

sqlExpression
String

A consulta sql.

feedOptions
FeedOptions

(Opcional) O FeedOptions para processar o feed de resultados da consulta.

Retornos

O conjunto de resultados da consulta.

Aplica-se a

CreateDocumentQuery<T>(Uri, SqlQuerySpec, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

public System.Linq.IQueryable<T> CreateDocumentQuery<T> (Uri documentCollectionUri, Microsoft.Azure.Documents.SqlQuerySpec querySpec, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : Uri * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<'T>
Public Function CreateDocumentQuery(Of T) (documentCollectionUri As Uri, querySpec As SqlQuerySpec, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of T)

Parâmetros de tipo

T

O tipo de objeto a ser consultado.

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos.

querySpec
SqlQuerySpec

A consulta sql.

feedOptions
FeedOptions

(Opcional) O FeedOptions para processar o feed de resultados da consulta.

Retornos

O conjunto de resultados da consulta.

Aplica-se a

CreateDocumentQuery<T>(Uri, String, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

public System.Linq.IQueryable<T> CreateDocumentQuery<T> (Uri documentCollectionUri, string sqlExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : Uri * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<'T>
Public Function CreateDocumentQuery(Of T) (documentCollectionUri As Uri, sqlExpression As String, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of T)

Parâmetros de tipo

T

O tipo de objeto a ser consultado.

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos.

sqlExpression
String

A consulta sql.

feedOptions
FeedOptions

(Opcional) O FeedOptions para processar o feed de resultados da consulta.

Retornos

O conjunto de resultados da consulta.

Aplica-se a

CreateDocumentQuery<T>(String, String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL. Ele retorna um IQueryable{T}.

public System.Linq.IQueryable<T> CreateDocumentQuery<T> (string collectionLink, string sqlExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : string * string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<'T>
Public Function CreateDocumentQuery(Of T) (collectionLink As String, sqlExpression As String, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of T)

Parâmetros de tipo

T

O tipo de objeto a ser consultado.

Parâmetros

collectionLink
String

O link para a coleção pai.

sqlExpression
String

A instrução SQL.

feedOptions
FeedOptions

As opções para processar o feed de resultados da consulta. Para obter detalhes, confira FeedOptions

Retornos

Um IQueryable{T} que pode avaliar a consulta.

Exemplos

Este exemplo abaixo consulta alguns documentos de livro.

public class Book 
{
    [JsonProperty("title")]
    public string Title {get; set;}

    public Author Author {get; set;}

    public int Price {get; set;}
}

public class Author
{
    public string FirstName {get; set;}
    public string LastName {get; set;}
}

// Query by the Title property
Book book = client.CreateDocumentQuery<Book>(collectionLink, 
    "SELECT * FROM books b WHERE b.title  = 'War and Peace'").AsEnumerable().FirstOrDefault();

// Query a nested property
Book otherBook = client.CreateDocumentQuery<Book>(collectionLink,
    "SELECT * FROM books b WHERE b.Author.FirstName = 'Leo'").AsEnumerable().FirstOrDefault();

// Perform a range query (needs an IndexType.Range on price or FeedOptions.EnableScansInQuery)
foreach (Book matchingBook in client.CreateDocumentQuery<Book>(
    collectionLink, "SELECT * FROM books b where b.Price > 1000"))
{
    // Iterate through books
}

// Query asychronously. Optionally set FeedOptions.MaxItemCount to control page size
using (var queryable = client.CreateDocumentQuery<Book>(collectionLink, 
    "SELECT * FROM books b WHERE b.title  = 'War and Peace'", 
    new FeedOptions { MaxItemCount = 10 }).AsDocumentQuery())
{
    while (queryable.HasMoreResults) 
    {
        foreach(Book b in await queryable.ExecuteNextAsync<Book>())
        {
            // Iterate through books
        }
    }
}

Comentários

Consulte para https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started/ obter sintaxe e exemplos.

Confira também

Aplica-se a

CreateDocumentQuery<T>(String, SqlQuerySpec, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um banco de dados do Azure Cosmos DB usando uma instrução SQL com valores parametrizados. Ele retorna um IQueryable{T}. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte SqlQuerySpec.

public System.Linq.IQueryable<T> CreateDocumentQuery<T> (string collectionLink, Microsoft.Azure.Documents.SqlQuerySpec querySpec, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : string * Microsoft.Azure.Documents.SqlQuerySpec * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IQueryable<'T>
Public Function CreateDocumentQuery(Of T) (collectionLink As String, querySpec As SqlQuerySpec, Optional feedOptions As FeedOptions = Nothing) As IQueryable(Of T)

Parâmetros de tipo

T

O tipo de objeto a ser consultado.

Parâmetros

collectionLink
String

O link para a coleção de documentos pai.

querySpec
SqlQuerySpec

A instância sqlQuerySpec que contém a expressão SQL.

feedOptions
FeedOptions

As opções para processar o feed de resultados da consulta. Para obter detalhes, confira FeedOptions

Retornos

Um IQueryable{T} que pode avaliar a consulta.

Exemplos

Este exemplo abaixo consulta alguns documentos de livro.

public class Book 
{
    [JsonProperty("title")]
    public string Title {get; set;}

    public Author Author {get; set;}

    public int Price {get; set;}
}

public class Author
{
    public string FirstName {get; set;}
    public string LastName {get; set;}
}

// Query using Title
Book book, otherBook;

var query = new SqlQuerySpec(
    "SELECT * FROM books b WHERE b.title = @title", 
    new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@title", Value = "War and Peace" }}));
book = client.CreateDocumentQuery<Book>(collectionLink, query).AsEnumerable().FirstOrDefault();

// Query a nested property
query = new SqlQuerySpec(
    "SELECT * FROM books b WHERE b.Author.FirstName = @firstName", 
    new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@firstName", Value = "Leo" }}));
otherBook = client.CreateDocumentQuery<Book>(collectionLink, query).AsEnumerable().FirstOrDefault();

// Perform a range query (needs an IndexType.Range on price or FeedOptions.EnableScansInQuery)
query = new SqlQuerySpec(
    "SELECT * FROM books b WHERE b.Price > @minPrice", 
    new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@minPrice", Value = 1000 }}));
foreach (Book b in client.CreateDocumentQuery<Book>(
    collectionLink, query))
{
    // Iterate through books
}

// Query asychronously. Optionally set FeedOptions.MaxItemCount to control page size
query = new SqlQuerySpec(
    "SELECT * FROM books b WHERE b.title = @title", 
    new SqlParameterCollection(new SqlParameter[] { new SqlParameter { Name = "@title", Value = "War and Peace" }}));

using (var queryable = client.CreateDocumentQuery<Book>(collectionLink, query, 
    new FeedOptions { MaxItemCount = 10 }).AsDocumentQuery())
{
    while (queryable.HasMoreResults) 
    {
        foreach(Book b in await queryable.ExecuteNextAsync<Book>())
        {
            // Iterate through books
        }
    }
}

Comentários

Consulte para https://docs.microsoft.com/azure/cosmos-db/sql-query-getting-started/ obter sintaxe e exemplos.

Confira também

Aplica-se a

CreateDocumentQuery<T>(Uri, FeedOptions)

Método para criar uma consulta para documentos no serviço do Azure Cosmos DB.

public System.Linq.IOrderedQueryable<T> CreateDocumentQuery<T> (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<'T>
Public Function CreateDocumentQuery(Of T) (documentCollectionUri As Uri, Optional feedOptions As FeedOptions = Nothing) As IOrderedQueryable(Of T)

Parâmetros de tipo

T

O tipo de objeto a ser consultado.

Parâmetros

documentCollectionUri
Uri

O URI da coleção de documentos pai.

feedOptions
FeedOptions

(Opcional) O FeedOptions para processar o feed de resultados da consulta.

Retornos

O conjunto de resultados da consulta.

Aplica-se a

CreateDocumentQuery<T>(String, FeedOptions)

Sobrecarregado. Esse método cria uma consulta para documentos em uma coleção em um serviço do Azure Cosmos DB.

public System.Linq.IOrderedQueryable<T> CreateDocumentQuery<T> (string collectionLink, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = default);
abstract member CreateDocumentQuery : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Linq.IOrderedQueryable<'T>
Public Function CreateDocumentQuery(Of T) (collectionLink As String, Optional feedOptions As FeedOptions = Nothing) As IOrderedQueryable(Of T)

Parâmetros de tipo

T

O tipo de objeto a ser consultado.

Parâmetros

collectionLink
String

O link para o recurso de coleção pai.

feedOptions
FeedOptions

As opções para processar o feed de resultados da consulta. Para obter detalhes, confira FeedOptions

Retornos

Um IOrderedQueryable{T} que pode avaliar a consulta.

Exemplos

Este exemplo abaixo consulta alguns documentos de livro.

public class Book 
{
    [JsonProperty("title")]
    public string Title {get; set;}

    public Author Author {get; set;}

    public int Price {get; set;}
}

public class Author
{
    public string FirstName {get; set;}
    public string LastName {get; set;}
}

// Query by the Title property
Book book = client.CreateDocumentQuery<Book>(collectionLink).Where(b => b.Title == "War and Peace").AsEnumerable().FirstOrDefault();

// Query a nested property
Book otherBook = client.CreateDocumentQuery<Book>(collectionLink).Where(b => b.Author.FirstName == "Leo").AsEnumerable().FirstOrDefault();

// Perform a range query (needs an IndexType.Range on price or FeedOptions.EnableScansInQuery)
foreach (Book matchingBook in client.CreateDocumentQuery<Book>(collectionLink).Where(b => b.Price > 100))
{
    // Iterate through books
}

// Query asychronously. Optionally set FeedOptions.MaxItemCount to control page size
using (var queryable = client.CreateDocumentQuery<Book>(
    collectionLink,
    new FeedOptions { MaxItemCount = 10 })
    .Where(b => b.Title == "War and Peace")
    .AsDocumentQuery())
{
    while (queryable.HasMoreResults) 
    {
        foreach(Book b in await queryable.ExecuteNextAsync<Book>())
        {
            // Iterate through books
        }
    }
}

Comentários

O provedor LINQ do Azure Cosmos DB compila instruções LINQ to SQL. Consulte a https://docs.microsoft.com/azure/cosmos-db/sql-query-linq-to-sql lista de expressões compatíveis com o provedor LINQ do Azure Cosmos DB. ToString() no IQueryable gerado retorna a instrução SQL traduzida. O provedor do Azure Cosmos DB converte atributos de serialização JSON.NET e DataContract para membros em seus nomes de propriedade JSON.

Confira também

Aplica-se a