Freigeben über


DocumentClient.ReadDocumentCollectionAsync Methode

Definition

Überlädt

ReadDocumentCollectionAsync(String, RequestOptions)

Liest einen DocumentCollection aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.

ReadDocumentCollectionAsync(Uri, RequestOptions)

Liest einen DocumentCollection als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.

ReadDocumentCollectionAsync(String, RequestOptions)

Liest einen DocumentCollection aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.

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>>
override this.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))

Parameter

documentCollectionLink
String

Der Link, über den die DocumentCollection gelesen werden soll.

options
RequestOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

Gibt zurück

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen DocumentCollection umschließt, der den gelesenen Ressourcendatensatz enthält.

Implementiert

Ausnahmen

Wenn documentCollectionLink nicht festgelegt ist.

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten können, sind:

StatusCodeGrund für die Ausnahme
404NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war.
429TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den DocumentClientException.RetryAfter-Wert, um zu sehen, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen.

Beispiele

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

Hinweise

Das Lesen einer Ressource ist die effizienteste Methode, um eine Ressource aus der Datenbank abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie einen Lesevorgang anstelle einer Abfrage nach ID durch.

Im gezeigten Beispiel werden ID-basierte Links verwendet, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können die SelfLink Eigenschaft der DocumentCollection weiterhin verwenden, wenn Sie möchten. Eine Selbstverknüpfung ist ein URI für eine Ressource, die aus Ressourcenbezeichnern (oder den _rid Eigenschaften) besteht. ID-basierte Links und SelfLink funktionieren beide. Das Format für documentCollectionLink ist immer "/dbs/{db identifier}/colls/{coll identifier}" nur die Werte innerhalb der {} Änderung, je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.

Weitere Informationen

Gilt für:

ReadDocumentCollectionAsync(Uri, RequestOptions)

Liest einen DocumentCollection als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.

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>>
override this.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))

Parameter

documentCollectionUri
Uri

Ein URI für die zu lesende DocumentCollection-Ressource.

options
RequestOptions

Die Anforderungsoptionen für die Anforderung.

Gibt zurück

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält, das einen DocumentCollection umschließt, der den gelesenen Ressourcendatensatz enthält.

Implementiert

Ausnahmen

Wenn documentCollectionUri nicht festgelegt ist.

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten können, sind:

StatusCodeGrund für die Ausnahme
404NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war.
429TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den DocumentClientException.RetryAfter-Wert, um zu sehen, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen.

Beispiele

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

Hinweise

Das Lesen einer Ressource ist die effizienteste Methode, um eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie einen Lesevorgang anstelle einer Abfrage nach ID durch.

Weitere Informationen

Gilt für: