DocumentClient.ReadStoredProcedureAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReadStoredProcedureAsync(String, RequestOptions) |
StoredProcedure非同期操作として Azure Cosmos DB サービスから を読み取ります。 |
| ReadStoredProcedureAsync(Uri, RequestOptions) |
StoredProcedureを非同期操作として Azure Cosmos DB サービスから読み取ります。 |
ReadStoredProcedureAsync(String, RequestOptions)
StoredProcedure非同期操作として Azure Cosmos DB サービスから を読み取ります。
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))パラメーター
- storedProcedureLink
- String
読み取るストアド プロシージャのリンク。
- options
- RequestOptions
(省略可能)要求の要求オプション。
戻り値
System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をStoredProcedureラップする を含む 。
実装
例外
が設定されていない場合 storedProcedureLink 。
この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。
| StatusCode | 例外の理由 |
|---|---|
| 404 | NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。 |
| 429 | TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。 |
例
//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);
注釈
リソースの読み取りを行うことは、データベースからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。
示されている例では、ID ベースのリンクを使用します。このリンクは、リソースの作成時に使用される ID プロパティで構成されます。 必要に応じて、 SelfLink ストアド プロシージャの プロパティを引き続き使用できます。 セルフリンクは、リソース識別子 (または_ridプロパティ) で構成されるリソースの URI です。 ID ベースのリンクと SelfLink の両方が機能します。 の storedProcedureLink 形式は常に "/dbs/{db identifier}/colls/{coll identifier}/sprocs/{sproc identifier}" です。{..} 内の値のみが、リソースのアドレス指定に使用するメソッドによって変わります。
こちらもご覧ください
適用対象
ReadStoredProcedureAsync(Uri, RequestOptions)
StoredProcedureを非同期操作として Azure Cosmos DB サービスから読み取ります。
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))パラメーター
- storedProcedureUri
- Uri
読み取る StoredProcedure リソースへの URI。
- options
- RequestOptions
要求の要求オプション。
戻り値
System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をStoredProcedureラップする を含む 。
実装
例外
が設定されていない場合 storedProcedureUri 。
この例外により、さまざまな種類のエラーがカプセル化される可能性があります。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。
| StatusCode | 例外の理由 |
|---|---|
| 404 | NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。 |
| 429 | TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。 |
例
//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);
注釈
リソースの読み取りを行うことは、サービスからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。
こちらもご覧ください
適用対象
Azure SDK for .NET