Triggers class
すべてのトリガーを作成、アップサート、クエリ、読み取る操作。
container.triggers
を使用して、トリガーの読み取り、置換、または削除を行います。
プロパティ
container |
メソッド
create(Trigger |
トリガーを作成します。 Azure Cosmos DB では、作成、更新、および削除で実行される JavaScript で定義された事前トリガーと事後トリガーがサポートされています。 詳細については、サーバー側の JavaScript API のドキュメントを参照してください。 例
|
query(Sql |
すべてのトリガーに対してクエリを実行します。 |
query<T>(Sql |
すべてのトリガーに対してクエリを実行します。 例
|
read |
すべてのトリガーを読み取ります。 例 すべてのトリガーを配列に読み取る。
|
プロパティの詳細
container
メソッドの詳細
create(TriggerDefinition, RequestOptions)
トリガーを作成します。
Azure Cosmos DB では、作成、更新、および削除で実行される JavaScript で定義された事前トリガーと事後トリガーがサポートされています。
詳細については、サーバー側の JavaScript API のドキュメントを参照してください。
例
import { CosmosClient, TriggerDefinition, TriggerType, TriggerOperation } 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 triggerDefinition: TriggerDefinition = {
id: "sample trigger",
body: "serverScript() { var x = 10; }",
triggerType: TriggerType.Pre,
triggerOperation: TriggerOperation.All,
};
const { resource: trigger } = await container.scripts.triggers.create(triggerDefinition);
function create(body: TriggerDefinition, options?: RequestOptions): Promise<TriggerResponse>
パラメーター
- body
- TriggerDefinition
- options
- RequestOptions
戻り値
Promise<TriggerResponse>
query(SqlQuerySpec, FeedOptions)
すべてのトリガーに対してクエリを実行します。
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
パラメーター
- query
- SqlQuerySpec
操作のクエリ構成。 クエリ 構成する方法の詳細については、SqlQuerySpec を参照してください。
- options
- FeedOptions
戻り値
QueryIterator<any>
query<T>(SqlQuerySpec, 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 querySpec = {
query: "SELECT * FROM root r WHERE r.id=@id",
parameters: [
{
name: "@id",
value: "<trigger-id>",
},
],
};
const { resources: results } = await container.scripts.triggers.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: triggerList } = await container.scripts.triggers.readAll().fetchAll();
function readAll(options?: FeedOptions): QueryIterator<TriggerDefinition & Resource>
パラメーター
- options
- FeedOptions