IDocumentClient.ReadDocumentCollectionAsync 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
| ReadDocumentCollectionAsync(String, RequestOptions) |
Lê um DocumentCollection do serviço do Azure Cosmos DB como uma operação assíncrona. |
| ReadDocumentCollectionAsync(Uri, RequestOptions) |
Lê um DocumentCollection como uma operação assíncrona do serviço do Azure Cosmos DB. |
ReadDocumentCollectionAsync(String, RequestOptions)
Lê um DocumentCollection 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.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>>Public Function ReadDocumentCollectionAsync (documentCollectionLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))Parâmetros
- documentCollectionLink
- String
O link para a DocumentCollection a ser lida.
- 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 DocumentCollection que contém o registro de recurso de leitura.
Exceções
Se documentCollectionLink 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 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);
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 DocumentCollection 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 documentCollectionLink é sempre "/dbs/{db identifier}/colls/{coll identifier}" somente os valores dentro da {} alteração, dependendo de qual método você deseja usar para endereçar o recurso.
Confira também
Aplica-se a
ReadDocumentCollectionAsync(Uri, RequestOptions)
Lê um DocumentCollection 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.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>>Public Function ReadDocumentCollectionAsync (documentCollectionUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of DocumentCollection))Parâmetros
- documentCollectionUri
- Uri
Um URI para o recurso DocumentCollection 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 DocumentCollection que contém o registro de recurso de leitura.
Exceções
Se documentCollectionUri 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 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);
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