IDocumentClient.CreateDocumentQuery Método

Definición

Sobrecargas

CreateDocumentQuery(String, FeedOptions)

Sobrecargado. Este método crea una consulta para los documentos de una colección en un servicio de Azure Cosmos DB. Devuelve IOrderedQueryable{Document}.

CreateDocumentQuery(Uri, FeedOptions)

Método para crear una consulta de documentos en el servicio Azure Cosmos DB.

CreateDocumentQuery(String, SqlQuerySpec, FeedOptions)

Sobrecargado. Este método crea una consulta para documentos en una colección de una base de datos de Azure Cosmos DB mediante una instrucción SQL con valores con parámetros. Devuelve un objeto IQueryable{dynamic}. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte SqlQuerySpec.

CreateDocumentQuery(String, String, FeedOptions)

Sobrecargado. Este método crea una consulta para los documentos de una colección en una base de datos de Azure Cosmos DB mediante una instrucción SQL. Devuelve un objeto IQueryable{dynamic}.

CreateDocumentQuery(Uri, SqlQuerySpec, FeedOptions)

Método para crear una consulta de documentos en el servicio Azure Cosmos DB.

CreateDocumentQuery(Uri, String, FeedOptions)

Método para crear una consulta de documentos en el servicio Azure Cosmos DB.

CreateDocumentQuery<T>(Uri, SqlQuerySpec, FeedOptions)

Método para crear una consulta de documentos en el servicio Azure Cosmos DB.

CreateDocumentQuery<T>(Uri, String, FeedOptions)

Método para crear una consulta de documentos en el servicio Azure Cosmos DB.

CreateDocumentQuery<T>(String, String, FeedOptions)

Sobrecargado. Este método crea una consulta para los documentos de una colección en una base de datos de Azure Cosmos DB mediante una instrucción SQL. Devuelve un objeto IQueryable{T}.

CreateDocumentQuery<T>(String, SqlQuerySpec, FeedOptions)

Sobrecargado. Este método crea una consulta para documentos en una colección de una base de datos de Azure Cosmos DB mediante una instrucción SQL con valores con parámetros. Devuelve un objeto IQueryable{T}. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, consulte SqlQuerySpec.

CreateDocumentQuery<T>(Uri, FeedOptions)

Método para crear una consulta de documentos en el servicio Azure Cosmos DB.

CreateDocumentQuery<T>(String, FeedOptions)

Sobrecargado. Este método crea una consulta para los documentos de una colección en un servicio de Azure Cosmos DB.

CreateDocumentQuery(String, FeedOptions)

Sobrecargado. Este método crea una consulta para los documentos de una colección en un servicio de Azure Cosmos DB. Devuelve 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

Vínculo a la colección de documentos primaria.

feedOptions
FeedOptions

Opciones para procesar la fuente de resultados de la consulta. Para obtener información detallada, vea FeedOptions.

Devoluciones

IOrderedQueryable{Document} que puede evaluar la consulta.

Ejemplos

En este ejemplo se consultan los documentos por identificador.

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

Comentarios

Esta sobrecarga se debe usar cuando se desconoce el esquema de los documentos consultados o al consultar por identificador y reemplazar o eliminar documentos. Dado que Document es un DynamicObject, se puede devolver dinámicamente al objeto C# original.

Consulte también

Se aplica a

CreateDocumentQuery(Uri, FeedOptions)

Método para crear una consulta de documentos en el servicio 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

URI de la colección de documentos.

feedOptions
FeedOptions

(Opcional) FeedOptions para procesar la fuente de resultados de la consulta.

Devoluciones

Conjunto de resultados de la consulta.

Se aplica a

CreateDocumentQuery(String, SqlQuerySpec, FeedOptions)

Sobrecargado. Este método crea una consulta para documentos en una colección de una base de datos de Azure Cosmos DB mediante una instrucción SQL con valores con parámetros. Devuelve un objeto IQueryable{dynamic}. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, 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

Vínculo a la colección de documentos primaria.

querySpec
SqlQuerySpec

Instancia de SqlQuerySpec que contiene la expresión SQL.

feedOptions
FeedOptions

Opciones para procesar la fuente de resultados de la consulta. Para obtener información detallada, vea FeedOptions.

Devoluciones

IQueryable{dynamic> que puede evaluar la consulta.

Ejemplos

En este ejemplo se consultan los documentos de libros.

// 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();

Comentarios

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

Consulte también

Se aplica a

CreateDocumentQuery(String, String, FeedOptions)

Sobrecargado. Este método crea una consulta para los documentos de una colección en una base de datos de Azure Cosmos DB mediante una instrucción SQL. Devuelve un objeto 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

Vínculo a la colección de documentos primaria.

sqlExpression
String

Instrucción SQL.

feedOptions
FeedOptions

Opciones para procesar la fuente de resultados de la consulta. Para obtener información detallada, vea FeedOptions.

Devoluciones

IQueryable{dynamic> que puede evaluar la consulta.

Ejemplos

En este ejemplo se consultan los documentos de libros.

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

Comentarios

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

Consulte también

Se aplica a

CreateDocumentQuery(Uri, SqlQuerySpec, FeedOptions)

Método para crear una consulta de documentos en el servicio 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

URI de la colección de documentos.

querySpec
SqlQuerySpec

Consulta sql.

feedOptions
FeedOptions

(Opcional) FeedOptions para procesar la fuente de resultados de la consulta.

Devoluciones

Conjunto de resultados de la consulta.

Se aplica a

CreateDocumentQuery(Uri, String, FeedOptions)

Método para crear una consulta de documentos en el servicio 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

URI de la colección de documentos.

sqlExpression
String

Consulta sql.

feedOptions
FeedOptions

(Opcional) FeedOptions para procesar la fuente de resultados de la consulta.

Devoluciones

Conjunto de resultados de la consulta.

Se aplica a

CreateDocumentQuery<T>(Uri, SqlQuerySpec, FeedOptions)

Método para crear una consulta de documentos en el servicio 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

Tipo de objeto que se va a consultar.

Parámetros

documentCollectionUri
Uri

URI de la colección de documentos.

querySpec
SqlQuerySpec

Consulta sql.

feedOptions
FeedOptions

(Opcional) FeedOptions para procesar la fuente de resultados de la consulta.

Devoluciones

Conjunto de resultados de la consulta.

Se aplica a

CreateDocumentQuery<T>(Uri, String, FeedOptions)

Método para crear una consulta de documentos en el servicio 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

Tipo de objeto que se va a consultar.

Parámetros

documentCollectionUri
Uri

URI de la colección de documentos.

sqlExpression
String

Consulta sql.

feedOptions
FeedOptions

(Opcional) FeedOptions para procesar la fuente de resultados de la consulta.

Devoluciones

Conjunto de resultados de la consulta.

Se aplica a

CreateDocumentQuery<T>(String, String, FeedOptions)

Sobrecargado. Este método crea una consulta para documentos en una colección de una base de datos de Azure Cosmos DB mediante una instrucción SQL. Devuelve un 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

Tipo de objeto que se va a consultar.

Parámetros

collectionLink
String

Vínculo a la colección primaria.

sqlExpression
String

Instrucción SQL.

feedOptions
FeedOptions

Opciones para procesar la fuente de resultados de la consulta. Para obtener información detallada, vea FeedOptions.

Devoluciones

IQueryable{T} que puede evaluar la consulta.

Ejemplos

En este ejemplo se consultan algunos documentos de libro.

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
        }
    }
}

Comentarios

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

Consulte también

Se aplica a

CreateDocumentQuery<T>(String, SqlQuerySpec, FeedOptions)

Sobrecargado. Este método crea una consulta para documentos en una colección de una base de datos de Azure Cosmos DB mediante una instrucción SQL con valores con parámetros. Devuelve un IQueryable{T}. Para obtener más información sobre cómo preparar instrucciones SQL con valores con parámetros, 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

Tipo de objeto que se va a consultar.

Parámetros

collectionLink
String

Vínculo a la colección de documentos primaria.

querySpec
SqlQuerySpec

Instancia de SqlQuerySpec que contiene la expresión SQL.

feedOptions
FeedOptions

Opciones para procesar la fuente de resultados de la consulta. Para obtener información detallada, vea FeedOptions.

Devoluciones

IQueryable{T} que puede evaluar la consulta.

Ejemplos

En este ejemplo se consultan algunos documentos de libro.

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
        }
    }
}

Comentarios

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

Consulte también

Se aplica a

CreateDocumentQuery<T>(Uri, FeedOptions)

Método para crear una consulta de documentos en el servicio 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

Tipo de objeto que se va a consultar.

Parámetros

documentCollectionUri
Uri

URI de la colección de documentos primaria.

feedOptions
FeedOptions

(Opcional) FeedOptions para procesar la fuente de resultados de la consulta.

Devoluciones

Conjunto de resultados de la consulta.

Se aplica a

CreateDocumentQuery<T>(String, FeedOptions)

Sobrecargado. Este método crea una consulta para documentos en una colección en un servicio de 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

Tipo de objeto que se va a consultar.

Parámetros

collectionLink
String

Vínculo al recurso de la colección primaria.

feedOptions
FeedOptions

Opciones para procesar la fuente de resultados de la consulta. Para obtener información detallada, vea FeedOptions.

Devoluciones

IOrderedQueryable{T} que puede evaluar la consulta.

Ejemplos

En este ejemplo se consultan algunos documentos de libro.

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
        }
    }
}

Comentarios

El proveedor LINQ de Azure Cosmos DB compila instrucciones LINQ to SQL. Consulte la https://docs.microsoft.com/azure/cosmos-db/sql-query-linq-to-sql lista de expresiones admitidas por el proveedor LINQ de Azure Cosmos DB. ToString() en el objeto IQueryable generado devuelve la instrucción SQL traducida. El proveedor de Azure Cosmos DB traduce los atributos de serialización JSON.NET y DataContract para los miembros a sus nombres de propiedad JSON.

Consulte también

Se aplica a