DocumentClient.ExecuteStoredProcedureAsync Método

Referência

Definição

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pacotes:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])	Executa um procedimento armazenado em uma coleção particionada no serviço do Azure Cosmos DB como uma operação assíncrona, especificando uma partição de destino.
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])	Executa um procedimento armazenado em uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])	Executa um procedimento armazenado em uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.
ExecuteStoredProcedureAsync<TValue>(Uri, Object[])	Executa um procedimento armazenado em uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.
ExecuteStoredProcedureAsync<TValue>(String, Object[])	Executa um procedimento armazenado em uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB.
ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])	Executa um procedimento armazenado em uma coleção particionada no serviço do Azure Cosmos DB como uma operação assíncrona, especificando uma partição de destino.

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])

Executa um procedimento armazenado em uma coleção particionada no serviço do Azure Cosmos DB como uma operação assíncrona, especificando uma partição de destino.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options, System.Threading.CancellationToken cancellationToken, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, cancellationToken As CancellationToken, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Parâmetros de tipo

TValue

O tipo do valor retornado do procedimento armazenado.

Parâmetros

storedProcedureLink: String

O link para o procedimento armazenado a ser executado.

options: RequestOptions

(Opcional) As opções de solicitação para a solicitação.

cancellationToken: CancellationToken

(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber uma notificação de cancelamento.

procedureParams: Object[]

(Opcional) Uma matriz de objetos dinâmicos que representam os parâmetros do procedimento armazenado.

Retornos

Task<StoredProcedureResponse<TValue>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona que conteria qualquer conjunto de respostas no procedimento armazenado.

Implementações

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])

Exceções

ArgumentNullException

Se storedProcedureLink não estiver definido.

Exemplos

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new RequestOptions { PartitionKey = new PartitionKey(1) },
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

Confira também

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Executa um procedimento armazenado em uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Parâmetros de tipo

TValue

o tipo do valor retornado do procedimento armazenado.

Parâmetros

storedProcedureUri: Uri

o URI do procedimento armazenado a ser executado.

options: RequestOptions

As opções de solicitação para a solicitação.

procedureParams: Object[]

os parâmetros para a execução do procedimento armazenado.

Retornos

Task<StoredProcedureResponse<TValue>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona.

Implementações

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])

Executa um procedimento armazenado em uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, System.Threading.CancellationToken cancellationToken = default, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, Optional cancellationToken As CancellationToken = Nothing, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Parâmetros de tipo

TValue

o tipo do valor retornado do procedimento armazenado.

Parâmetros

storedProcedureUri: Uri

o URI do procedimento armazenado a ser executado.

options: RequestOptions

As opções de solicitação para a solicitação.

cancellationToken: CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

procedureParams: Object[]

os parâmetros para a execução do procedimento armazenado.

Retornos

Task<StoredProcedureResponse<TValue>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona.

Implementações

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Executa um procedimento armazenado em uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Parâmetros de tipo

TValue

o tipo do valor retornado do procedimento armazenado.

Parâmetros

storedProcedureUri: Uri

o URI do procedimento armazenado a ser executado.

procedureParams: Object[]

os parâmetros para a execução do procedimento armazenado.

Retornos

Task<StoredProcedureResponse<TValue>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona.

Implementações

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Executa um procedimento armazenado em uma coleção como uma operação assíncrona no serviço do Azure Cosmos DB.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Parâmetros de tipo

TValue

O tipo do valor retornado do procedimento armazenado.

Parâmetros

storedProcedureLink: String

O link para o procedimento armazenado a ser executado.

procedureParams: Object[]

(Opcional) Uma matriz de objetos dinâmicos que representam os parâmetros do procedimento armazenado.

Retornos

Task<StoredProcedureResponse<TValue>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona que conteria qualquer conjunto de respostas no procedimento armazenado.

Implementações

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Exceções

ArgumentNullException

Se storedProcedureLink não estiver definido.

Exemplos

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

Confira também

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Executa um procedimento armazenado em uma coleção particionada no serviço do Azure Cosmos DB como uma operação assíncrona, especificando uma partição de destino.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

Parâmetros de tipo

TValue

O tipo do valor retornado do procedimento armazenado.

Parâmetros

storedProcedureLink: String

O link para o procedimento armazenado a ser executado.

options: RequestOptions

(Opcional) As opções de solicitação para a solicitação.

procedureParams: Object[]

(Opcional) Uma matriz de objetos dinâmicos que representam os parâmetros do procedimento armazenado.

Retornos

Task<StoredProcedureResponse<TValue>>

O objeto de tarefa que representa a resposta do serviço para a operação assíncrona que conteria qualquer conjunto de respostas no procedimento armazenado.

Implementações

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Exceções

ArgumentNullException

Se storedProcedureLink não estiver definido.

Exemplos

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new RequestOptions { PartitionKey = new PartitionKey(1) },
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

Confira também

Aplica-se a

DocumentClient.ExecuteStoredProcedureAsync Método

Definição

Sobrecargas

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])

Parâmetros de tipo

Parâmetros

Retornos

Implementações

Exceções

Exemplos

Confira também

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Parâmetros de tipo

Parâmetros

Retornos

Implementações

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])

Parâmetros de tipo

Parâmetros

Retornos

Implementações

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Parâmetros de tipo

Parâmetros

Retornos

Implementações

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Parâmetros de tipo

Parâmetros

Retornos

Implementações

Exceções

Exemplos

Confira também

Aplica-se a

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Parâmetros de tipo

Parâmetros

Retornos

Implementações

Exceções

Exemplos

Confira também

Aplica-se a

Comentários

Recursos adicionais