StoredProcedure class

參考

套件:: @azure/cosmos

依標識符讀取、取代、刪除或執行特定現有預存程序的作業。

若要讓作業建立、讀取或查詢預存程式，

屬性

container
id
url	傳回資源的參考 URL。用於在許可權中連結。

方法

delete(RequestOptions)	刪除指定的 StoredProcedure。
execute<T>(PartitionKey, any[], RequestOptions)	執行指定的 StoredProcedure。用戶端不會強制執行指定的類型 T。請務必驗證預存程序的回應符合您提供的 T 類型。
read(RequestOptions)	讀取所指定 StoredProcedure StoredProcedureDefinition。
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[]

參數陣列，以作為自變數傳遞至指定的 StoredProcedure。

options: RequestOptions

其他選項，例如叫用 StoredProcedure 的分割區索引鍵。

傳回

Promise<ResourceResponse<T>>

read(RequestOptions)

讀取所指定 StoredProcedure StoredProcedureDefinition。

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

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

參數

body: StoredProcedureDefinition

指定的 StoredProcedureDefinition 來取代現有的定義。

options: RequestOptions

傳回