DocumentClient.ReadDocumentAsync Methode
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Überlädt
| ReadDocumentAsync(String, RequestOptions, CancellationToken) |
Liest einen Document aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
| ReadDocumentAsync(Uri, RequestOptions, CancellationToken) |
Liest einen Document als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst. |
| ReadDocumentAsync<T>(String, RequestOptions, CancellationToken) |
Liest einen Document als generischen Typ T aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
| ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken) |
Liest einen Document als generischen Typ T aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang. |
ReadDocumentAsync(String, RequestOptions, CancellationToken)
Liest einen Document aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
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))Parameter
- documentLink
- String
Der Link für das zu lesende Dokument.
- options
- RequestOptions
(Optional) Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.
Gibt zurück
Eine System.Threading.Tasks , die einen ResourceResponse<TResource> enthält, der einen Document umschließt, der den Leseressourcendatensatz enthält.
Implementiert
Ausnahmen
Wenn documentLink 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, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
| 429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//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);
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 anstelle einer Abfrage nach ID einen Lesevorgang durch.
Das gezeigte Beispiel verwendet ID-basierte Links, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können weiterhin die SelfLink Eigenschaft des Dokuments 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 documentLink ist immer "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" nur die Werte innerhalb der {} Änderung, je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.
Weitere Informationen
Gilt für:
ReadDocumentAsync(Uri, RequestOptions, CancellationToken)
Liest einen Document als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.
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))Parameter
- documentUri
- Uri
Ein URI für die zu lesende Dokumentressource.
- options
- RequestOptions
Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) CancellationToken stellt die Anforderungsabbruch dar.
Gibt zurück
Eine System.Threading.Tasks , die einen ResourceResponse<TResource> enthält, der einen Document umschließt, der den Leseressourcendatensatz enthält.
Implementiert
Ausnahmen
Wenn documentUri 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 Lesen eines Dokuments erhalten, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
| 429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, 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
// - 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);
Hinweise
Das Lesen einer Ressource ist die effizienteste Möglichkeit, eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie anstelle einer Abfrage nach ID einen Lesevorgang durch.
Weitere Informationen
Gilt für:
ReadDocumentAsync<T>(String, RequestOptions, CancellationToken)
Liest einen Document als generischen Typ T aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
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))Typparameter
- T
Parameter
- documentLink
- String
Der Link für das zu lesende Dokument.
- options
- RequestOptions
(Optional) Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.
Gibt zurück
Eine System.Threading.Tasks , die einen DocumentResponse<TDocument> enthält, der einen Document umschließt, der den Leseressourcendatensatz enthält.
Implementiert
Ausnahmen
Wenn documentLink 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, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
| 429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen. |
Beispiele
//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);
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 anstelle einer Abfrage nach ID einen Lesevorgang durch.
Das gezeigte Beispiel verwendet ID-basierte Links, wobei der Link aus den ID-Eigenschaften besteht, die beim Erstellen der Ressourcen verwendet wurden. Sie können weiterhin die SelfLink Eigenschaft des Dokuments 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 documentLink ist immer "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" nur die Werte innerhalb der {} Änderung, je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.
Weitere Informationen
Gilt für:
ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken)
Liest einen Document als generischen Typ T aus dem Azure Cosmos DB-Dienst als asynchronen Vorgang.
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))Typparameter
- T
Parameter
- documentUri
- Uri
Ein URI für die zu lesende Dokumentressource.
- options
- RequestOptions
Die Anforderungsoptionen für die Anforderung.
- cancellationToken
- CancellationToken
(Optional) CancellationToken stellt die Anforderungsabbruch dar.
Gibt zurück
Eine System.Threading.Tasks , die einen DocumentResponse<TDocument> enthält, der einen Document umschließt, der den Leseressourcendatensatz enthält.
Implementiert
Ausnahmen
Wenn documentUri 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 Lesen eines Dokuments erhalten, sind:
| StatusCode | Ausnahmegrund |
|---|---|
| 404 | NotFound: Dies bedeutet, dass die Ressource, die Sie lesen möchten, nicht vorhanden war. |
| 429 | TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, 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
// - 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);
Hinweise
Das Lesen einer Ressource ist die effizienteste Möglichkeit, eine Ressource aus dem Dienst abzurufen. Wenn Sie die ID der Ressource kennen, führen Sie anstelle einer Abfrage nach ID einen Lesevorgang durch.
Weitere Informationen
Gilt für:
Azure SDK for .NET