DocumentClient.ReadDocumentAsync 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
| ReadDocumentAsync(String, RequestOptions, CancellationToken) |
Lê um Document do serviço do Azure Cosmos DB como uma operação assíncrona. |
| ReadDocumentAsync(Uri, RequestOptions, CancellationToken) |
Lê um Document como uma operação assíncrona do serviço do Azure Cosmos DB. |
| ReadDocumentAsync<T>(String, RequestOptions, CancellationToken) |
Lê um Document como um tipo genérico T do serviço do Azure Cosmos DB como uma operação assíncrona. |
| ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken) |
Lê um Document como um tipo genérico T do serviço do Azure Cosmos DB como uma operação assíncrona. |
ReadDocumentAsync(String, RequestOptions, CancellationToken)
Lê um Document 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.Document>> ReadDocumentAsync (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReadDocumentAsync (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parâmetros
- documentLink
- String
O link para o documento a ser lido.
- options
- RequestOptions
(Opcional) As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber uma notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Document que contém o registro de recurso de leitura.
Implementações
Exceções
Se documentLink 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
//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Document doc = await client.ReadDocumentAsync(docLink);
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 Documento, se preferir. Um auto-link é um URI para um recurso composto por Identificadores de Recurso (ou as propriedades _rid). Os links baseados em ID e o SelfLink funcionarão. O formato para documentLink é sempre "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" somente os valores dentro da {} alteração, dependendo do método que você deseja usar para endereçar o recurso.
Confira também
Aplica-se a
ReadDocumentAsync(Uri, RequestOptions, CancellationToken)
Lê um Document 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.Document>> ReadDocumentAsync (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>Public Function ReadDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))Parâmetros
- documentUri
- Uri
Um URI para o recurso Documento a ser lido.
- options
- RequestOptions
As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) CancellationToken que representa o cancelamento da solicitação.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Document que contém o registro de recurso de leitura.
Implementações
Exceções
Se documentUri 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 ler 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 Document resource where
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read.
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Document document = await client.ReadDocumentAsync(docUri);
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
ReadDocumentAsync<T>(String, RequestOptions, CancellationToken)
Lê um Document como um tipo genérico T do serviço do Azure Cosmos DB como uma operação assíncrona.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
override this.ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>Public Function ReadDocumentAsync(Of T) (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))Parâmetros de tipo
- T
Parâmetros
- documentLink
- String
O link para o documento a ser lido.
- options
- RequestOptions
(Opcional) As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber uma notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um DocumentResponse<TDocument> que encapsula um Document que contém o registro de recurso de leitura.
Implementações
Exceções
Se documentLink 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
//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Customer customer = await client.ReadDocumentAsync<Customer>(docLink);
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 Documento, se preferir. Um auto-link é um URI para um recurso composto por Identificadores de Recurso (ou as propriedades _rid). Os links baseados em ID e o SelfLink funcionarão. O formato para documentLink é sempre "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" somente os valores dentro da {} alteração, dependendo do método que você deseja usar para endereçar o recurso.
Confira também
Aplica-se a
ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken)
Lê um Document como um tipo genérico T do serviço do Azure Cosmos DB como uma operação assíncrona.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
override this.ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>Public Function ReadDocumentAsync(Of T) (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))Parâmetros de tipo
- T
Parâmetros
- documentUri
- Uri
Um URI para o recurso Documento a ser lido.
- options
- RequestOptions
As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) CancellationToken que representa o cancelamento da solicitação.
Retornos
Um System.Threading.Tasks que contém um DocumentResponse<TDocument> que encapsula um Document que contém o registro de recurso de leitura.
Implementações
Exceções
Se documentUri 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 ler 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 Document resource where
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read.
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Customer customer = await client.ReadDocumentAsync<Customer>(docUri);
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
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de