StoredProcedure class

Pakiet:

@azure/cosmos

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

Operacje 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 obszarze Uprawnienia.

Metody

delete(RequestOptions)	Usuń daną StoredProcedure.
execute<T>(PartitionKey, any[], RequestOptions)	Wykonaj daną StoredProcedure. Określony typ T nie jest wymuszany przez klienta. Upewnij się, że odpowiedź z procedury składowanej jest zgodna z typem, T, podajesz.
read(RequestOptions)	Przeczytaj StoredProcedureDefinition dla danego StoredProcedure.
replace(StoredProcedureDefinition, RequestOptions)	Zastąp podane StoredProcedure określonym 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 obszarze Uprawnienia.

string url

Wartość właściwości

string

Szczegóły metody

delete(RequestOptions)

Usuń daną StoredProcedure.

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

Parametry

options

RequestOptions

Zwraca

Promise<StoredProcedureResponse>

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

Wykonaj daną StoredProcedure.

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

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 danej StoredProcedure.

options

RequestOptions

Dodatkowe opcje, takie jak klucz partycji do wywoływania StoredProcedure on.

Zwraca

Promise<ResourceResponse<T>>

read(RequestOptions)

Przeczytaj StoredProcedureDefinition dla danego StoredProcedure.

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

Parametry

options

RequestOptions

Zwraca

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Zastąp podane StoredProcedure określonym StoredProcedureDefinition.

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

Parametry

body

StoredProcedureDefinition

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

options

RequestOptions

Zwraca

Promise<StoredProcedureResponse>