StoredProcedure class

Paquete:

@azure/cosmos

Operaciones para leer, reemplazar, eliminar o ejecutar un procedimiento almacenado específico existente por id.

Para que las operaciones creen, lean todos o consulten procedimientos almacenados,

Propiedades

container
id
url	Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

Métodos

delete(RequestOptions)	Elimine el StoredProcedure especificado.
execute<T>(PartitionKey, any[], RequestOptions)	Ejecute el StoredProcedure especificado. El cliente no aplica el tipo especificado, T. Asegúrese de validar que la respuesta del procedimiento almacenado coincide con el tipo, T, que proporcione.
read(RequestOptions)	Lea el StoredProcedureDefinition de para el StoredProcedure especificado.
replace(StoredProcedureDefinition, RequestOptions)	Reemplace el StoredProcedure especificado por el StoredProcedureDefinition especificado.

Detalles de las propiedades

container

container: Container

Valor de propiedad

Container

id

id: string

Valor de propiedad

string

url

Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

string url

Valor de propiedad

string

Detalles del método

delete(RequestOptions)

Elimine el StoredProcedure especificado.

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

Parámetros

options

RequestOptions

Devoluciones

Promise<StoredProcedureResponse>

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

Ejecute el StoredProcedure especificado.

El cliente no aplica el tipo especificado, T. Asegúrese de validar que la respuesta del procedimiento almacenado coincide con el tipo, T, que proporcione.

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

Parámetros

partitionKey

PartitionKey

Clave de partición que se va a usar al ejecutar el procedimiento almacenado

params

any[]

Matriz de parámetros que se van a pasar como argumentos al StoredProcedure especificado.

options

RequestOptions

Opciones adicionales, como la clave de partición para invocar el StoredProcedure de.

Devoluciones

Promise<ResourceResponse<T>>

read(RequestOptions)

Lea el StoredProcedureDefinition de para el StoredProcedure especificado.

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

Parámetros

options

RequestOptions

Devoluciones

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Reemplace el StoredProcedure especificado por el StoredProcedureDefinition especificado.

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

Parámetros

body

StoredProcedureDefinition

El StoredProcedureDefinition especificado para reemplazar la definición existente.

options

RequestOptions

Devoluciones

Promise<StoredProcedureResponse>