Freigeben über


DocumentClient.ReadStoredProcedureAsync Methode

Definition

Überlädt

ReadStoredProcedureAsync(String, RequestOptions)

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

ReadStoredProcedureAsync(Uri, RequestOptions)

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

ReadStoredProcedureAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>> ReadStoredProcedureAsync (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>>
override this.ReadStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>>
Public Function ReadStoredProcedureAsync (storedProcedureLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of StoredProcedure))

Parameter

storedProcedureLink
String

Der Link der zu lesenden gespeicherten Prozedur.

options
RequestOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

Gibt zurück

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

Implementiert

Ausnahmen

Wenn storedProcedureLink 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 StoredProcedure from a Database and DocumentCollection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - sproc_id is the ID of the stored procedure to be read
var sprocLink = "/dbs/sample_database/colls/sample_collection/sprocs/sproc_id";
StoredProcedure sproc = await client.ReadStoredProcedureAsync(sprocLink);

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 gespeicherten Prozedur 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 storedProcedureLink lautet immer "/dbs/{db identifier}/colls/{coll identifier}/sprocs/{sproc identifier}", nur die Werte innerhalb von {...} ändern sich je nachdem, welche Methode Sie zum Adressieren der Ressource verwenden möchten.

Weitere Informationen

Gilt für:

ReadStoredProcedureAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>> ReadStoredProcedureAsync (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>>
override this.ReadStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.StoredProcedure>>
Public Function ReadStoredProcedureAsync (storedProcedureUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of StoredProcedure))

Parameter

storedProcedureUri
Uri

Ein URI für die storedProcedure-Ressource, die gelesen werden soll.

options
RequestOptions

Die Anforderungsoptionen für die Anforderung.

Gibt zurück

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

Implementiert

Ausnahmen

Wenn storedProcedureUri 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 StoredProcedure resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection 
// - sproc_id is the ID property of the StoredProcedure you wish to read. 
var sprocLink = UriFactory.CreateStoredProcedureUri("db_id", "coll_id", "sproc_id");
StoredProcedure sproc = await client.ReadStoredProcedureAsync(sprocLink);

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: