@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for NOSQL API
136 lines • 5.61 kB
JavaScript
import { createTriggerUri, getIdFromLink, getPathFromLink, isResourceValid, ResourceType, } from "../../common/index.js";
import { TriggerResponse } from "./TriggerResponse.js";
import { getEmptyCosmosDiagnostics, withDiagnostics } from "../../utils/diagnostics.js";
/**
* Operations to read, replace, or delete a {@link Trigger}.
*
* Use `container.triggers` to create, upsert, query, or read all.
*/
export class Trigger {
container;
id;
clientContext;
/**
* Returns a reference URL to the resource. Used for linking in Permissions.
*/
get url() {
return createTriggerUri(this.container.database.id, this.container.id, this.id);
}
/**
* @hidden
* @param container - The parent {@link Container}.
* @param id - The id of the given {@link Trigger}.
*/
constructor(container, id, clientContext) {
this.container = container;
this.id = id;
this.clientContext = clientContext;
}
/**
* Read the {@link TriggerDefinition} for the given {@link Trigger}.
* @example
* ```ts snippet:TriggerRead
* 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: trigger } = await container.scripts.trigger("<trigger-id>").read();
* ```
*/
async read(options) {
return withDiagnostics(async (diagnosticNode) => {
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
const response = await this.clientContext.read({
path,
resourceType: ResourceType.trigger,
resourceId: id,
options,
diagnosticNode,
});
return new TriggerResponse(response.result, response.headers, response.code, this, getEmptyCosmosDiagnostics());
}, this.clientContext);
}
/**
* Replace the given {@link Trigger} with the specified {@link TriggerDefinition}.
* @param body - The specified {@link TriggerDefinition} to replace the existing definition with.
* @example
* ```ts snippet:TriggerReplace
* 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);
*
* trigger.body = "function () { const x = 20; console.log(x); }";
* const { resource: replacedTrigger } = await container.scripts.trigger(trigger.id).replace(trigger);
* ```
*/
async replace(body, options) {
return withDiagnostics(async (diagnosticNode) => {
if (body.body) {
body.body = body.body.toString();
}
const err = {};
if (!isResourceValid(body, err)) {
throw err;
}
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
const response = await this.clientContext.replace({
body,
path,
resourceType: ResourceType.trigger,
resourceId: id,
options,
diagnosticNode,
});
return new TriggerResponse(response.result, response.headers, response.code, this, getEmptyCosmosDiagnostics());
}, this.clientContext);
}
/**
* Delete the given {@link Trigger}.
* @example
* ```ts snippet:TriggerDelete
* 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.trigger("<trigger-id>").delete();
* ```
*/
async delete(options) {
return withDiagnostics(async (diagnosticNode) => {
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
const response = await this.clientContext.delete({
path,
resourceType: ResourceType.trigger,
resourceId: id,
options,
diagnosticNode,
});
return new TriggerResponse(response.result, response.headers, response.code, this, getEmptyCosmosDiagnostics());
}, this.clientContext);
}
}
//# sourceMappingURL=Trigger.js.map