Triggers | @azure/cosmos

Operations to create, upsert, query, and read all triggers.

Use container.triggers to read, replace, or delete a Trigger.

Hierarchy

Triggers

Index

Properties

container

Methods

Properties

container

container: Container

The parent Container.

Methods

create

create(body: TriggerDefinition, options?: RequestOptions): Promise<TriggerResponse>

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/client/Trigger/Triggers.ts:78
Create a trigger.

Azure Cosmos DB supports pre and post triggers defined in JavaScript to be executed on creates, updates and deletes.

For additional details, refer to the server-side JavaScript API documentation.

Parameters
- body: TriggerDefinition
- Optional options: RequestOptions
Returns Promise<TriggerResponse>

query

query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/client/Trigger/Triggers.ts:34
Query all Triggers.

Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<any>
- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/client/Trigger/Triggers.ts:40
Query all Triggers.

Type parameters
- T
Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<T>

readAll

readAll(options?: FeedOptions): QueryIterator<TriggerDefinition & Resource>

- Defined in home/vsts/work/1/s/sdk/cosmosdb/cosmos/src/client/Trigger/Triggers.ts:65
Read all Triggers.
example
Read all trigger to array.
```
const {body: triggerList} = await container.triggers.readAll().fetchAll();
```
Parameters
- Optional options: FeedOptions
Returns QueryIterator<TriggerDefinition & Resource>

Hierarchy

Index

Properties

Methods

Properties

container

Methods

create

Parameters

body: TriggerDefinition

Optional options: RequestOptions

Returns Promise<TriggerResponse>

query

Parameters

query: SqlQuerySpec

Optional options: FeedOptions

Returns QueryIterator<any>

Type parameters

T

Parameters

query: SqlQuerySpec

Optional options: FeedOptions

Returns QueryIterator<T>

readAll

Parameters

Optional options: FeedOptions

Returns QueryIterator<TriggerDefinition & Resource>