DocumentClient.ReadDocumentCollectionAsync Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Sobrecargas
| ReadDocumentCollectionAsync(String, RequestOptions) |
Lee un DocumentCollection elemento del servicio Azure Cosmos DB como una operación asincrónica. |
| ReadDocumentCollectionAsync(Uri, RequestOptions) |
Lee como DocumentCollection una operación asincrónica desde el servicio Azure Cosmos DB. |
ReadDocumentCollectionAsync(String, RequestOptions)
Lee un DocumentCollection elemento del servicio Azure Cosmos DB como una operación asincrónica.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionAsync (string documentCollectionLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadDocumentCollectionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.ReadDocumentCollectionAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>Public Function ReadDocumentCollectionAsync (documentCollectionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))Parámetros
- documentCollectionLink
- String
Vínculo para leer DocumentCollection.
- options
- RequestOptions
(Opcional) Opciones de solicitud para la solicitud.
Devoluciones
que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene DocumentCollection el registro de recursos de lectura.
Implementaciones
Excepciones
Si documentCollectionLink no se establece.
Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 404 | NotFound: significa que el recurso que intentó leer no existía. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
//This reads a DocumentCollection record from a database where
// - sample_database is the ID of the database
// - collection_id is the ID of the collection resource to be read
var collLink = "/dbs/sample_database/colls/collection_id";
DocumentCollection coll = await client.ReadDocumentCollectionAsync(collLink);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso de la base de datos. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.
En el ejemplo que se muestra se usan vínculos basados en identificadores, donde el vínculo se compone de las propiedades de identificador usadas cuando se crearon los recursos. Todavía puede usar la SelfLink propiedad de DocumentCollection si lo prefiere. Un auto-vínculo es un URI para un recurso que se compone de identificadores de recursos (o las propiedades de _rid). Los vínculos basados en identificadores y SelfLink funcionarán. El formato de documentCollectionLink siempre es "/dbs/{db identifier}/colls/{coll identifier}" solo los valores dentro del {} cambio en función del método que desee usar para abordar el recurso.
Consulte también
Se aplica a
ReadDocumentCollectionAsync(Uri, RequestOptions)
Lee como DocumentCollection una operación asincrónica desde el servicio Azure Cosmos DB.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member ReadDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.ReadDocumentCollectionAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.DocumentCollection>>Public Function ReadDocumentCollectionAsync (documentCollectionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))Parámetros
- documentCollectionUri
- Uri
URI del recurso DocumentCollection que se va a leer.
- options
- RequestOptions
Opciones de solicitud para la solicitud.
Devoluciones
que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene DocumentCollection el registro de recursos de lectura.
Implementaciones
Excepciones
Si documentCollectionUri no se establece.
Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:
| StatusCode | Motivo de la excepción |
|---|---|
| 404 | NotFound: significa que el recurso que intentó leer no existía. |
| 429 | TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación. |
Ejemplos
//Reads a Document resource where
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection you wish to read.
var collLink = UriFactory.CreateCollectionUri("db_id", "coll_id");
DocumentCollection coll = await client.ReadDocumentCollectionAsync(collLink);
Comentarios
Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso del servicio. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.
Consulte también
Se aplica a
Azure SDK for .NET