Scripts.ExecuteStoredProcedureAsync<TOutput> Método

Definição

Namespace:

Microsoft.Azure.Cosmos.Scripts

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.39.0

Origem:

Scripts.cs

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.StoredProcedureExecuteResponse<TOutput>> ExecuteStoredProcedureAsync<TOutput> (string storedProcedureId, Microsoft.Azure.Cosmos.PartitionKey partitionKey, object[] parameters, Microsoft.Azure.Cosmos.Scripts.StoredProcedureRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Cosmos.PartitionKey * obj[] * Microsoft.Azure.Cosmos.Scripts.StoredProcedureRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.Scripts.StoredProcedureExecuteResponse<'Output>>

Public MustOverride Function ExecuteStoredProcedureAsync(Of TOutput) (storedProcedureId As String, partitionKey As PartitionKey, parameters As Object(), Optional requestOptions As StoredProcedureRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of StoredProcedureExecuteResponse(Of TOutput))

Parâmetros de tipo

TOutput

O tipo de retorno serializável JSON.

Parâmetros

storedProcedureId

String

O identificador do Procedimento Armazenado a ser executado.

partitionKey

PartitionKey

A chave de partição do item.

parameters

Object[]

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

requestOptions

StoredProcedureRequestOptions

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

cancellationToken

CancellationToken

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

Retornos

Task<StoredProcedureExecuteResponse<TOutput>>

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

Exceções

ArgumentNullException

Se storedProcedureId ou partitionKey não estiver definido.

Exemplos

Isso cria e executa um procedimento armazenado que acrescenta uma cadeia de caracteres ao primeiro item retornado da consulta.

string sprocBody = @"function simple(prefix, postfix)
   {
       var collection = getContext().getCollection();

       // Query documents and take 1st item.
       var isAccepted = collection.queryDocuments(
       collection.getSelfLink(),
       'SELECT * FROM root r',
       function(err, feed, options) {
           if (err)throw err;

           // Check the feed and if it's empty, set the body to 'no docs found',
           // Otherwise just take 1st element from the feed.
           if (!feed || !feed.length) getContext().getResponse().setBody(""no docs found"");
           else getContext().getResponse().setBody(prefix + JSON.stringify(feed[0]) + postfix);
       });

       if (!isAccepted) throw new Error(""The query wasn't accepted by the server. Try again/use continuation token between API and script."");
   }";

Scripts scripts = this.container.Scripts;
string sprocId = "appendString";
StoredProcedureResponse storedProcedureResponse = await scripts.CreateStoredProcedureAsync(
        sprocId,
        sprocBody);

// Execute the stored procedure
StoredProcedureExecuteResponse<string> sprocResponse = await scripts.ExecuteStoredProcedureAsync<string>(
                        sprocId,
                        new PartitionKey(testPartitionId),
                        new dynamic[] {"myPrefixString", "myPostfixString"});

Console.WriteLine(sprocResponse.Resource);
///