StoredProcedures class

套件:

@azure/cosmos

建立、插入或讀取/查詢所有預存程式的作業。 如需依識別碼讀取、取代、刪除或執行特定現有預存程式的作業，請參閱 container.storedProcedure() 。

屬性

container

方法

create(StoredProcedureDefinition, RequestOptions)	建立 StoredProcedure。 Azure Cosmos DB 允許直接針對專案容器在儲存層中執行預存程式。 腳本會在指定容器的主要儲存體分割區上的 ACID 交易下執行。 如需其他詳細資料，請參閱伺服器端 JavaScript API 檔。
query(SqlQuerySpec, FeedOptions)	查詢所有預存程式。 範例 讀取所有預存程式以陣列。 const querySpec: SqlQuerySpec = { query: "SELECT * FROM root r WHERE r.id = @sproc", parameters: [ {name: "@sproc", value: "Todo"} ] }; const {body: sprocList} = await containers.storedProcedures.query(querySpec).fetchAll();
query<T>(SqlQuerySpec, FeedOptions)	查詢所有預存程式。 範例 讀取所有預存程式以陣列。 const querySpec: SqlQuerySpec = { query: "SELECT * FROM root r WHERE r.id = @sproc", parameters: [ {name: "@sproc", value: "Todo"} ] }; const {body: sprocList} = await containers.storedProcedures.query(querySpec).fetchAll();
readAll(FeedOptions)	讀取所有預存程式。 範例 讀取所有預存程式以陣列。 const {body: sprocList} = await containers.storedProcedures.readAll().fetchAll();

屬性詳細資料

container

container: Container

屬性值

Container

方法詳細資料

create(StoredProcedureDefinition, RequestOptions)

建立 StoredProcedure。 Azure Cosmos DB 允許直接針對專案容器在儲存層中執行預存程式。 腳本會在指定容器的主要儲存體分割區上的 ACID 交易下執行。 如需其他詳細資料，請參閱伺服器端 JavaScript API 檔。

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

參數

body

StoredProcedureDefinition

options

RequestOptions

傳回

Promise<StoredProcedureResponse>

query(SqlQuerySpec, FeedOptions)

查詢所有預存程式。

範例

讀取所有預存程式以陣列。

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM root r WHERE r.id = @sproc",
  parameters: [
    {name: "@sproc", value: "Todo"}
  ]
};
const {body: sprocList} = await containers.storedProcedures.query(querySpec).fetchAll();

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

參數

query

SqlQuerySpec

作業的查詢組態。 如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec 。

options

FeedOptions

傳回

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

查詢所有預存程式。

範例

讀取所有預存程式以陣列。

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM root r WHERE r.id = @sproc",
  parameters: [
    {name: "@sproc", value: "Todo"}
  ]
};
const {body: sprocList} = await containers.storedProcedures.query(querySpec).fetchAll();

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

參數

query

SqlQuerySpec

作業的查詢組態。 如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec 。

options

FeedOptions

傳回

QueryIterator<T>

readAll(FeedOptions)

讀取所有預存程式。

範例

讀取所有預存程式以陣列。

const {body: sprocList} = await containers.storedProcedures.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<StoredProcedureDefinition & Resource>

參數

options

FeedOptions

傳回

QueryIterator<StoredProcedureDefinition & Resource>