StoredProcedure class

Balíček:

@azure/cosmos

Operace pro čtení, nahrazení, odstranění nebo spuštění konkrétní existující uložené procedury podle ID.

Pro operace vytvoření, čtení všech nebo dotazování uložených procedur:

Vlastnosti

container
id
url	Vrátí referenční adresu URL prostředku. Používá se pro propojení v oprávněních.

Metody

delete(RequestOptions)	Odstraňte zadaný objekt StoredProcedure.
execute<T>(PartitionKey, any[], RequestOptions)	Spusťte daný StoredProcedure. Zadaný typ T klient nevynucuje. Nezapomeňte ověřit, že odpověď z uložené procedury odpovídá zadanému typu T.
read(RequestOptions)	Přečtěte si definice StoredProcedureDefinition pro danou StoredProcedure.
replace(StoredProcedureDefinition, RequestOptions)	Nahraďte danou hodnotu StoredProcedure zadaným parametrem StoredProcedureDefinition.

Podrobnosti vlastnosti

container

container: Container

Hodnota vlastnosti

Container

id

id: string

Hodnota vlastnosti

string

url

Vrátí referenční adresu URL prostředku. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete(RequestOptions)

Odstraňte zadaný objekt StoredProcedure.

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

Parametry

options

RequestOptions

Návraty

Promise<StoredProcedureResponse>

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

Spusťte daný StoredProcedure.

Zadaný typ T klient nevynucuje. Nezapomeňte ověřit, že odpověď z uložené procedury odpovídá zadanému typu T.

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

Parametry

partitionKey

PartitionKey

Klíč oddílu, který se má použít při provádění uložené procedury

params

any[]

Pole parametrů, které se mají předat jako argumenty danému uloženému objektu StoredProcedure.

options

RequestOptions

Další možnosti, například klíč oddílu pro vyvolání StoredProcedure na.

Návraty

Promise<ResourceResponse<T>>

read(RequestOptions)

Přečtěte si definice StoredProcedureDefinition pro danou StoredProcedure.

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

Parametry

options

RequestOptions

Návraty

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Nahraďte danou hodnotu StoredProcedure zadaným parametrem StoredProcedureDefinition.

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

Parametry

body

StoredProcedureDefinition

Zadaná StoredProcedureDefinition nahradí existující definici.

options

RequestOptions

Návraty

Promise<StoredProcedureResponse>