Partager via

IDocumentClient.ReadDocumentCollectionAsync Méthode

  • Référence

Définition

Espace de noms:
Microsoft.Azure.Documents
Assemblys:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Paquets:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Surcharges

ReadDocumentCollectionAsync(String, RequestOptions)

Lit un DocumentCollection à partir du service Azure Cosmos DB en tant qu’opération asynchrone.
ReadDocumentCollectionAsync(Uri, RequestOptions)

Lit un DocumentCollection en tant qu’opération asynchrone à partir du service Azure Cosmos DB.

ReadDocumentCollectionAsync(String, RequestOptions)

Lit un DocumentCollection à partir du service Azure Cosmos DB en tant qu’opération asynchrone.

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))

Paramètres

documentCollectionLink
String

Lien vers le DocumentCollection à lire.

options
RequestOptions

(Facultatif) Options de demande pour la demande.

Retours

Task<ResourceResponse<DocumentCollection>>

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un DocumentCollection contenant l’enregistrement de ressource de lecture.

Exceptions

ArgumentNullException

Si documentCollectionLink n’est pas défini.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCodeRaison de l’exception
404NotFound : cela signifie que la ressource que vous avez tenté de lire n’existait pas.
429TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour savoir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//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);

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir de la base de données. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.

L’exemple présenté utilise des liens basés sur l’ID, où le lien est composé des propriétés d’ID utilisées lors de la création des ressources. Vous pouvez toujours utiliser la SelfLink propriété de DocumentCollection si vous préférez. Un lien automatique est un URI pour une ressource composée d’identificateurs de ressource (ou des propriétés _rid). Les liens basés sur l’ID et SelfLink fonctionnent tous les deux. Le format pour documentCollectionLink est toujours « /dbs/{db identifier}/colls/{coll identifier} » uniquement les valeurs dans la modification selon la {} méthode que vous souhaitez utiliser pour traiter la ressource.

Voir aussi

S’applique à

ReadDocumentCollectionAsync(Uri, RequestOptions)

Lit un DocumentCollection en tant qu’opération asynchrone à partir du service 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))

Paramètres

documentCollectionUri
Uri

URI de la ressource DocumentCollection à lire.

options
RequestOptions

Options de demande pour la demande.

Retours

Task<ResourceResponse<DocumentCollection>>

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un DocumentCollection contenant l’enregistrement de ressource de lecture.

Exceptions

ArgumentNullException

Si documentCollectionUri n’est pas défini.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCodeRaison de l’exception
404NotFound : cela signifie que la ressource que vous avez tenté de lire n’existait pas.
429TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour savoir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//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);

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource auprès du service. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.

Voir aussi

S’applique à