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

Operace pro vytvoření, čtení všech uložených procedur nebo dotazování

Vlastnosti

container
id
url	Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

Metody

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

Podrobnosti vlastnosti

container

container: Container

Hodnota vlastnosti

Container

id

id: string

Hodnota vlastnosti

string

url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete(RequestOptions)

Odstraňte danou StoredProcedure .

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

Parametry

options

RequestOptions

Návraty

Promise<StoredProcedureResponse>

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

Spusťte danou StoredProcedure.

Zadaný typ T se nevynucuje klientem. Nezapomeňte ověřit odpověď z uložené procedury, která odpovídá typu T, které zadáte.

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é mají být předány jako argumenty danému StoredProcedure.

options

RequestOptions

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

Návraty

Promise<ResourceResponse<T>>

read(RequestOptions)

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

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

Parametry

options

RequestOptions

Návraty

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Nahraďte danou StoredProcedure zadaným StoredProcedureDefinition.

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

Parametry

body

StoredProcedureDefinition

Zadaná StoredProcedureDefinition nahradit existující definici.

options

RequestOptions

Návraty

Promise<StoredProcedureResponse>