StoredProcedure class

Pacote:

@azure/cosmos

Operações para ler, substituir, excluir ou executar um procedimento armazenado específico e existente por ID.

Para operações para criar, ler tudo ou consultar procedimentos armazenados,

Propriedades

container
id
url	Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

Métodos

delete(RequestOptions)	Exclua o StoredProceduredeterminado.
execute<T>(PartitionKey, any[], RequestOptions)	Execute o StoredProcedureespecificado. O tipo especificado, T, não é imposto pelo cliente. Certifique-se de validar a resposta do procedimento armazenado que corresponde ao tipo, T, que você fornece.
read(RequestOptions)	Leia o StoredProcedureDefinition para o StoredProceduredeterminado.
replace(StoredProcedureDefinition, RequestOptions)	Substitua o StoredProcedure especificado pelo StoredProcedureDefinitionespecificado.

Detalhes da propriedade

container

container: Container

Valor da propriedade

Container

id

id: string

Valor da propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

string url

Valor da propriedade

string

Detalhes do método

delete(RequestOptions)

Exclua o StoredProceduredeterminado.

function delete(options?: RequestOptions): Promise<StoredProcedureResponse>

Parâmetros

options

RequestOptions

Retornos

Promise<StoredProcedureResponse>

execute<T>(PartitionKey, any[], RequestOptions)

Execute o StoredProcedureespecificado.

O tipo especificado, T, não é imposto pelo cliente. Certifique-se de validar a resposta do procedimento armazenado que corresponde ao tipo, T, que você fornece.

function execute<T>(partitionKey: PartitionKey, params?: any[], options?: RequestOptions): Promise<ResourceResponse<T>>

Parâmetros

partitionKey

PartitionKey

A chave de partição a ser usada ao executar o procedimento armazenado

params

any[]

Matriz de parâmetros a serem passados como argumentos para o StoredProcedurefornecido.

options

RequestOptions

Opções adicionais, como a chave de partição para invocar o StoredProcedure.

Retornos

Promise<ResourceResponse<T>>

read(RequestOptions)

Leia o StoredProcedureDefinition para o StoredProceduredeterminado.

function read(options?: RequestOptions): Promise<StoredProcedureResponse>

Parâmetros

options

RequestOptions

Retornos

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Substitua o StoredProcedure especificado pelo StoredProcedureDefinitionespecificado.

function replace(body: StoredProcedureDefinition, options?: RequestOptions): Promise<StoredProcedureResponse>

Parâmetros

body

StoredProcedureDefinition

O StoredProcedureDefinition especificado para substituir a definição existente.

options

RequestOptions

Retornos

Promise<StoredProcedureResponse>