DocumentClient.ReadStoredProcedureAsync Método

Definición

Sobrecargas

ReadStoredProcedureAsync(String, RequestOptions)

Lee un StoredProcedure elemento del servicio Azure Cosmos DB como una operación asincrónica.

ReadStoredProcedureAsync(Uri, RequestOptions)

Lee como StoredProcedure una operación asincrónica desde el servicio Azure Cosmos DB.

ReadStoredProcedureAsync(String, RequestOptions)

Lee un StoredProcedure elemento del servicio Azure Cosmos DB como una operación asincrónica.

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

Parámetros

storedProcedureLink
String

Vínculo del procedimiento almacenado que se va a leer.

options
RequestOptions

(Opcional) Opciones de solicitud para la solicitud.

Devoluciones

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene StoredProcedure el registro de recursos de lectura.

Implementaciones

Excepciones

Si storedProcedureLink no se establece.

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:

StatusCodeMotivo de la excepción
404NotFound: significa que el recurso que intentó leer no existía.
429TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación.

Ejemplos

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

Comentarios

Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso de la base de datos. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.

En el ejemplo que se muestra se usan vínculos basados en identificadores, donde el vínculo se compone de las propiedades de identificador usadas cuando se crearon los recursos. Si lo prefiere, puede usar la SelfLink propiedad del procedimiento almacenado. Un auto-vínculo es un URI para un recurso que se compone de identificadores de recursos (o las propiedades de _rid). Los vínculos basados en identificadores y SelfLink funcionarán. El formato de storedProcedureLink siempre es "/dbs/{db identifier}/colls/{coll identifier}/sprocs/{sproc identifier}" solo los valores del {...} cambian en función del método que desee usar para abordar el recurso.

Consulte también

Se aplica a

ReadStoredProcedureAsync(Uri, RequestOptions)

Lee como StoredProcedure una operación asincrónica desde el servicio 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))

Parámetros

storedProcedureUri
Uri

Un URI para el recurso StoredProcedure que se va a leer.

options
RequestOptions

Opciones de solicitud para la solicitud.

Devoluciones

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene StoredProcedure el registro de recursos de lectura.

Implementaciones

Excepciones

Si storedProcedureUri no se establece.

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:

StatusCodeMotivo de la excepción
404NotFound: significa que el recurso que intentó leer no existía.
429TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación.

Ejemplos

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

Comentarios

Realizar una lectura de un recurso es la manera más eficaz de obtener un recurso del servicio. Si conoce el identificador del recurso, realice una lectura en lugar de una consulta por identificador.

Consulte también

Se aplica a