DocumentClient.ReadDatabaseAsync Método

Definición

Sobrecargas

ReadDatabaseAsync(String, RequestOptions)

Lee un Database elemento del servicio Azure Cosmos DB como una operación asincrónica.

ReadDatabaseAsync(Uri, RequestOptions)

Lee como Database una operación asincrónica desde el servicio Azure Cosmos DB.

ReadDatabaseAsync(String, RequestOptions)

Lee un Database 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.Database>> ReadDatabaseAsync (string databaseLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadDatabaseAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
override this.ReadDatabaseAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
Public Function ReadDatabaseAsync (databaseLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))

Parámetros

databaseLink
String

Vínculo del recurso De base de datos que se va a leer.

options
RequestOptions

(Opcional) Opciones de solicitud para la solicitud.

Devoluciones

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene Database el registro de recursos de lectura.

Implementaciones

Excepciones

Si databaseLink 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:

StatusCodeMotivo de la excepción
404NotFound: significa que el recurso que intentó leer no existía.
429TooManyRequests: 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 Database resource where
// - database_id is the ID property of the Database resource you wish to read.
var dbLink = "/dbs/database_id";
Database database = await client.ReadDatabaseAsync(dbLink);

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. Si lo prefiere, puede usar la SelfLink propiedad de la base de datos. 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 databaseLink siempre es "/dbs/{db 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

ReadDatabaseAsync(Uri, RequestOptions)

Lee como Database una operación asincrónica desde el servicio Azure Cosmos DB.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> ReadDatabaseAsync (Uri databaseUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadDatabaseAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
override this.ReadDatabaseAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
Public Function ReadDatabaseAsync (databaseUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))

Parámetros

databaseUri
Uri

Un URI para el recurso de base de datos 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 Database el registro de recursos de lectura.

Implementaciones

Excepciones

Si databaseUri 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:

StatusCodeMotivo de la excepción
404NotFound: significa que el recurso que intentó leer no existía.
429TooManyRequests: 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 Database resource where 
// - db_id is the ID property of the Database you wish to read. 
var dbLink = UriFactory.CreateDatabaseUri("db_id");
Database database = await client.ReadDatabaseAsync(dbLink);

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