StoredProcedure class

Paket:

@azure/cosmos

Åtgärder för att läsa, ersätta, ta bort eller köra en specifik, befintlig lagrad procedur med ID.

För åtgärder för att skapa, läsa alla eller fråga lagrade procedurer,

Egenskaper

container
id
url	Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

Metoder

delete(RequestOptions)	Ta bort angiven StoredProcedure.
execute<T>(PartitionKey, any[], RequestOptions)	Kör angiven StoredProcedure. Den angivna typen, T, framtvingas inte av klienten. Kontrollera att svaret från den lagrade proceduren matchar den typ, T, som du anger.
read(RequestOptions)	Läs StoredProcedureDefinition för den angivna StoredProcedure.
replace(StoredProcedureDefinition, RequestOptions)	Ersätt angivet StoredProcedure med angivet StoredProcedureDefinition.

Egenskapsinformation

container

container: Container

Egenskapsvärde

Container

id

id: string

Egenskapsvärde

string

url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

string

Metodinformation

delete(RequestOptions)

Ta bort angiven StoredProcedure.

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

Parametrar

options

RequestOptions

Returer

Promise<StoredProcedureResponse>

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

Kör angiven StoredProcedure.

Den angivna typen, T, framtvingas inte av klienten. Kontrollera att svaret från den lagrade proceduren matchar den typ, T, som du anger.

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

Parametrar

partitionKey

PartitionKey

Partitionsnyckeln som ska användas när den lagrade proceduren körs

params

any[]

Matris med parametrar som ska skickas som argument till angiven StoredProcedure.

options

RequestOptions

Ytterligare alternativ, till exempel partitionsnyckeln som ska anropa StoredProcedure på.

Returer

Promise<ResourceResponse<T>>

read(RequestOptions)

Läs StoredProcedureDefinition för den angivna StoredProcedure.

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

Parametrar

options

RequestOptions

Returer

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Ersätt angivet StoredProcedure med angivet StoredProcedureDefinition.

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

Parametrar

body

StoredProcedureDefinition

Den angivna StoredProcedureDefinition som ska ersätta den befintliga definitionen.

options

RequestOptions

Returer

Promise<StoredProcedureResponse>