次の方法で共有


StoredProcedures class

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

ID で特定の既存のストアド プロシージャを読み取り、置換、削除、または実行する操作については、container.storedProcedure()を参照してください。

プロパティ

container

メソッド

create(StoredProcedureDefinition, RequestOptions)

StoredProcedure を作成します。

Azure Cosmos DB では、項目コンテナーに対して直接、ストレージ層でストアド プロシージャを実行できます。 スクリプトは、指定されたコンテナーのプライマリ ストレージ パーティション上の ACID トランザクションで実行されます。 詳細については、サーバー側の JavaScript API のドキュメントを参照してください。

import { CosmosClient, StoredProcedureDefinition } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const sprocDefinition: StoredProcedureDefinition = {
  id: "sample sproc",
  body: "function () { const x = 10; }",
};

const { resource: sproc } = await container.scripts.storedProcedures.create(sprocDefinition);
query(SqlQuerySpec, FeedOptions)

すべてのストアド プロシージャに対してクエリを実行します。

すべてのストアド プロシージャを配列に読み取ります。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();
query<T>(SqlQuerySpec, FeedOptions)

すべてのストアド プロシージャに対してクエリを実行します。

すべてのストアド プロシージャを配列に読み取ります。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();
readAll(FeedOptions)

すべてのストアド プロシージャを読み取ります。

すべてのストアド プロシージャを配列に読み取ります。

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .readAll()
  .fetchAll();

プロパティの詳細

container

container: Container

プロパティ値

メソッドの詳細

create(StoredProcedureDefinition, RequestOptions)

StoredProcedure を作成します。

Azure Cosmos DB では、項目コンテナーに対して直接、ストレージ層でストアド プロシージャを実行できます。 スクリプトは、指定されたコンテナーのプライマリ ストレージ パーティション上の ACID トランザクションで実行されます。 詳細については、サーバー側の JavaScript API のドキュメントを参照してください。

import { CosmosClient, StoredProcedureDefinition } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const sprocDefinition: StoredProcedureDefinition = {
  id: "sample sproc",
  body: "function () { const x = 10; }",
};

const { resource: sproc } = await container.scripts.storedProcedures.create(sprocDefinition);
function create(body: StoredProcedureDefinition, options?: RequestOptions): Promise<StoredProcedureResponse>

パラメーター

options
RequestOptions

戻り値

query(SqlQuerySpec, FeedOptions)

すべてのストアド プロシージャに対してクエリを実行します。

すべてのストアド プロシージャを配列に読み取ります。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

パラメーター

query
SqlQuerySpec

操作のクエリ構成。 クエリ 構成する方法の詳細については、SqlQuerySpec を参照してください。

options
FeedOptions

戻り値

query<T>(SqlQuerySpec, FeedOptions)

すべてのストアド プロシージャに対してクエリを実行します。

すべてのストアド プロシージャを配列に読み取ります。

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @sproc`,
  parameters: [{ name: "@sproc", value: "Todo" }],
};
const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .query(querySpec)
  .fetchAll();
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

パラメーター

query
SqlQuerySpec

操作のクエリ構成。 クエリ 構成する方法の詳細については、SqlQuerySpec を参照してください。

options
FeedOptions

戻り値

readAll(FeedOptions)

すべてのストアド プロシージャを読み取ります。

すべてのストアド プロシージャを配列に読み取ります。

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const { resources: storedProceduresList } = await container.scripts.storedProcedures
  .readAll()
  .fetchAll();
function readAll(options?: FeedOptions): QueryIterator<StoredProcedureDefinition & Resource>

パラメーター

options
FeedOptions

戻り値