IDocumentClient.ReadDatabaseAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
ReadDatabaseAsync(String, RequestOptions) |
Lê um Database do serviço do Azure Cosmos DB como uma operação assíncrona. |
ReadDatabaseAsync(Uri, RequestOptions) |
Lê um Database como uma operação assíncrona do serviço do Azure Cosmos DB. |
ReadDatabaseAsync(String, RequestOptions)
Lê um Database do serviço do Azure Cosmos DB como uma operação assíncrona.
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>>
Public Function ReadDatabaseAsync (databaseLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))
Parâmetros
- databaseLink
- String
O link do recurso banco de dados a ser lido.
- options
- RequestOptions
(Opcional) As opções de solicitação para a solicitação.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Database que contém o registro de recurso de leitura.
Exceções
Se databaseLink
não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
StatusCode | Motivo da exceção |
---|---|
404 | NotFound - Isso significa que o recurso que você tentou ler não existia. |
429 | TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação. |
Exemplos
//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);
Comentários
Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do Banco de Dados. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.
O exemplo mostrado usa links baseados em ID, em que o link é composto pelas propriedades de ID usadas quando os recursos foram criados. Você ainda pode usar a SelfLink propriedade do Banco de Dados se preferir. Um auto-link é um URI para um recurso composto por Identificadores de Recursos (ou as propriedades _rid). Os links baseados em ID e o SelfLink funcionarão. O formato para databaseLink
é sempre "/dbs/{db identifier}" apenas os valores dentro da {} alteração, dependendo de qual método você deseja usar para lidar com o recurso.
Confira também
Aplica-se a
ReadDatabaseAsync(Uri, RequestOptions)
Lê um Database como uma operação assíncrona do serviço do 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>>
Public Function ReadDatabaseAsync (databaseUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))
Parâmetros
- databaseUri
- Uri
Um URI para o recurso banco de dados a ser lido.
- options
- RequestOptions
As opções de solicitação para a solicitação.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Database que contém o registro de recurso de leitura.
Exceções
Se databaseUri
não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
StatusCode | Motivo da exceção |
---|---|
404 | NotFound - Isso significa que o recurso que você tentou ler não existia. |
429 | TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação. |
Exemplos
//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);
Comentários
Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do serviço. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.
Confira também
Aplica-se a
Azure SDK for .NET