Triggers allow you to execute server-side logic in response to database events or according to a schedule. Atlas provides two kinds of Triggers: Database and Scheduled triggers.
Triggers are only available for MongoDB Atlas clusters that are running MongoDB version 3.6 or newer.
Database triggers allow you to execute server-side logic whenever a document is added, updated, or removed in a linked cluster.
Use database triggers to implement complex data interactions, including updating information in one document when a related document changes or interacting with an external service when a new document is inserted.
MongoDB Atlas performs a
replace command rather than an
update command when executing an update via Data
Explorer. Database triggers will only recognize this update via
Data Explorer if you have marked the replace
database event for the trigger.
Scheduled triggers allow you to execute server-side logic on a regular schedule that you define using CRON expressions. Use scheduled triggers to do work that happens on a periodic basis, such as updating a document every minute, generating a nightly report, or sending an automated weekly email newsletter.
MongoDB Realm Functions Provide Server-side Logic¶
Triggers execute a MongoDB Realm Function that you specify. Each trigger is associated with exactly one MongoDB Realm Function.
To find this app, click MongoDB Realm in the navigation and select the Triggers_RealmApp app:
Triggers created prior to 09 Jun 2020 use the name Triggers_StitchApp.
Create a Trigger¶
To create a new database or scheduled trigger:
- Click the Atlas tab in the top navigation of your screen if you have not already navigated to Atlas.
- Click Triggers in the left-hand navigation.
- On the Overview tab of the Triggers page, click Add Trigger to open the trigger configuration page.
- Enter configuration values for the trigger and click Save at the bottom of the page.
Restart a Suspended Trigger¶
Triggers may enter a suspended state in response to an event that prevents the trigger's change stream from continuing, such as a network disruption. When a trigger is suspended, it does not receive change events and will not fire.
In the event of a failed trigger, MongoDB Realm sends an email notification to the project owner, alerting them of the issue.
To restart a suspended trigger:
Find the Suspended Trigger¶
On the Database Triggers tab of the Triggers page, find the trigger that you want to resume in the list of triggers. Suspended triggers are marked with a Status of Suspended.
Restart the Trigger¶
Click Restart in the trigger's Actions column.
You can choose to restart the trigger with a change stream resume token or open a new change stream. Indicate whether or not to use a resume token and then click Resume Database Trigger.
If you use a resume token, Atlas attempts to resume the trigger's underlying change stream at the event immediately following the last change event it processed. If successful, the trigger processes any events that occurred while it was suspended.
If you do not use a resume token, the trigger begins listening for new events but will not fire for any events that occurred while it was suspended.
An external dependency is an external library that includes logic you'd rather not implement yourself, such as string parsing, convenience functions for array manipulations, and data structure or algorithm implementations.
Configure a Trigger¶
To configure a Database trigger, see Database Trigger Configuration.
To configure a Scheduled trigger, see Scheduled Trigger Configuration.