Sets up a simple range trigger for a column_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via Insert Records with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via Show System Status) for any listening client to collect. Active triggers can be cancelled by using the Clear Trigger endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
Input Parameter Description
| Name | Type | Description |
|---|---|---|
| request_id | string | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | array of strings | Tables on which the trigger will be active, each in [schema_name.]table_name format, using standard name resolution rules. |
| column_name | string | Name of a numeric column_name on which the trigger is activated. |
| min | double | The lower bound (inclusive) for the trigger range. |
| max | double | The upper bound (inclusive) for the trigger range. |
| options | map of string to strings | Optional parameters. The default value is an empty map ( {} ). |
Output Parameter Description
| Name | Type | Description |
|---|---|---|
| trigger_id | string | Value of input parameter request_id. |
| info | map of string to strings | Additional information. |
