Поделиться через

StoredProcedure class

  • Ссылка
Пакет:
@azure/cosmos

Операции чтения, замены, удаления или выполнения определенной хранимой процедуры по идентификатору.

Для операций для создания, чтения всех или запроса хранимых процедур

Свойства

container
id
url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

Методы

delete(RequestOptions)

Удалите указанный StoredProcedure.
execute<T>(PartitionKey, any[], RequestOptions)

Выполните указанный StoredProcedure.

Указанный тип T не применяется клиентом. Убедитесь, что ответ от хранимой процедуры соответствует типу T, который вы предоставляете.
read(RequestOptions)

Прочитайте StoredProcedureDefinition для заданного StoredProcedure.
replace(StoredProcedureDefinition, RequestOptions)

Замените указанный StoredProcedure указанным StoredProcedureDefinition.

Сведения о свойстве

container 

container: Container

Значение свойства

Container

id 

id: string

Значение свойства

string

url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

string url

Значение свойства

string

Сведения о методе

delete(RequestOptions)

Удалите указанный StoredProcedure.

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

Параметры

options
RequestOptions

Возвращаемое значение

Promise<StoredProcedureResponse>

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

Выполните указанный StoredProcedure.

Указанный тип T не применяется клиентом. Убедитесь, что ответ от хранимой процедуры соответствует типу T, который вы предоставляете.

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

Параметры

partitionKey
PartitionKey

Ключ секции, используемый при выполнении хранимой процедуры

params

any[]

Массив параметров, передаваемых в качестве аргументов в заданный хранимой.

options
RequestOptions

Дополнительные параметры, такие как ключ секции для вызова хранимой.

Возвращаемое значение

Promise<ResourceResponse<T>>

read(RequestOptions)

Прочитайте StoredProcedureDefinition для заданного StoredProcedure.

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

Параметры

options
RequestOptions

Возвращаемое значение

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

Замените указанный StoredProcedure указанным StoredProcedureDefinition.

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

Параметры

body
StoredProcedureDefinition

Указанный StoredProcedureDefinition для замены существующего определения.

options
RequestOptions

Возвращаемое значение

Promise<StoredProcedureResponse>