次の方法で共有

StoredProcedure class

  • リファレンス
パッケージ:
@azure/cosmos

ID による特定の既存のストアド プロシージャの読み取り、置換、削除、または実行のための操作。

ストアド プロシージャの作成、すべて読み取り、またはクエリを実行する操作の場合は、

プロパティ

container
id
url

リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

メソッド

delete(RequestOptions)

指定された StoredProcedure を削除します。

例

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" });

await container.scripts.storedProcedure("<sproc-id>").delete();
execute<T>(PartitionKey, any[], RequestOptions)

指定された StoredProcedure を実行します。

指定されたタイプ T は、クライアントによって強制されません。 ストアド プロシージャからの応答が、指定した型 T と一致することを必ず検証してください。

例

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 { resource: result } = await container.scripts
  .storedProcedure("<sproc-id>")
  .execute(undefined);
read(RequestOptions)

指定された StoredProcedure の StoredProcedureDefinition を読み取ります。

例

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 { resource: sproc } = await container.scripts.storedProcedure("<sproc-id>").read();
replace(StoredProcedureDefinition, RequestOptions)

指定された StoredProcedure を、指定された StoredProcedureDefinition で置き換えます。

例

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);

sproc.body = function () {
  const x = 20;
  console.log(x);
};
const { resource: replacedSproc } = await container.scripts
  .storedProcedure(sproc.id)
  .replace(sproc);

プロパティの詳細

container 

container: Container

プロパティ値

Container

id 

id: string

プロパティ値

string

url

リソースへの参照 URL を返します。 アクセス許可のリンクに使用されます。

string url

プロパティ値

string

メソッドの詳細

delete(RequestOptions)

指定された StoredProcedure を削除します。

例

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" });

await container.scripts.storedProcedure("<sproc-id>").delete();

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

パラメーター

options
RequestOptions

戻り値

Promise<StoredProcedureResponse>

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

指定された StoredProcedure を実行します。

指定されたタイプ T は、クライアントによって強制されません。 ストアド プロシージャからの応答が、指定した型 T と一致することを必ず検証してください。

例

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 { resource: result } = await container.scripts
  .storedProcedure("<sproc-id>")
  .execute(undefined);

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 を読み取ります。

例

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 { resource: sproc } = await container.scripts.storedProcedure("<sproc-id>").read();

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

パラメーター

options
RequestOptions

戻り値

Promise<StoredProcedureResponse>

replace(StoredProcedureDefinition, RequestOptions)

指定された StoredProcedure を、指定された StoredProcedureDefinition で置き換えます。

例

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);

sproc.body = function () {
  const x = 20;
  console.log(x);
};
const { resource: replacedSproc } = await container.scripts
  .storedProcedure(sproc.id)
  .replace(sproc);

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

パラメーター

body
StoredProcedureDefinition

既存の定義を置き換えるために指定された StoredProcedureDefinition 。

options
RequestOptions

戻り値

Promise<StoredProcedureResponse>