StoredProcedure class

Pakiet:

@azure/cosmos

Operacje odczytu, zastępowania, usuwania lub wykonywania określonej, istniejącej procedury składowanej według identyfikatora.

W przypadku operacji tworzenia, odczytywania wszystkich lub wykonywania zapytań dotyczących procedur składowanych,

Właściwości

container
id
url	Zwraca adres URL odwołania do zasobu. Służy do łączenia w uprawnieniach.

Metody

delete(RequestOptions)	Usuń daną wartość StoredProcedure.
execute<T>(PartitionKey, any[], RequestOptions)	Wykonaj daną wartość StoredProcedure. Określony typ T nie jest wymuszany przez klienta. Upewnij się, że odpowiedź z procedury składowanej jest zgodna z typem, po którym podajesz wartość T.
read(RequestOptions)	Przeczytaj element StoredProcedureDefinition dla danego parametru StoredProcedure.
replace(StoredProcedureDefinition, RequestOptions)	Zastąp daną wartość StoredProcedure określoną wartością StoredProcedureDefinition.

Szczegóły właściwości

container

container: Container

Wartość właściwości

Container

id

id: string

Wartość właściwości

string

url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w uprawnieniach.

string url

Wartość właściwości

string

Szczegóły metody

delete(RequestOptions)

Usuń daną wartość StoredProcedure.

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

Parametry

options

RequestOptions

Zwraca

Promise<StoredProcedureResponse>

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

Wykonaj daną wartość StoredProcedure.

Określony typ T nie jest wymuszany przez klienta. Upewnij się, że odpowiedź z procedury składowanej jest zgodna z typem, po którym podajesz wartość T.

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

Parametry

partitionKey

PartitionKey

Klucz partycji do użycia podczas wykonywania procedury składowanej

params

any[]

Tablica parametrów, które mają być przekazywane jako argumenty do danego elementu StoredProcedure.

options

RequestOptions

Dodatkowe opcje, takie jak klucz partycji do wywołania właściwości StoredProcedure .

Zwraca

Promise<ResourceResponse<T>>

read(RequestOptions)

Przeczytaj element StoredProcedureDefinition dla danego parametru StoredProcedure.

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

Parametry

options

RequestOptions

Zwraca

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Zastąp daną wartość StoredProcedure określoną wartością StoredProcedureDefinition.

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

Parametry

body

StoredProcedureDefinition

Określona definicja StoredProcedureDefinition , aby zastąpić istniejącą definicję.

options

RequestOptions

Zwraca

Promise<StoredProcedureResponse>