StoredProcedures class

パッケージ:

@azure/cosmos

すべてのストアド プロシージャの作成、アップサート、または読み取り/クエリの操作。

特定の既存のストアド プロシージャを ID で読み取り、置換、削除、または実行する操作については、「」を参照してください 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>