Note
This documentation is for a prior release of Kinetica. For the latest documentation, click here.
URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/create/trigger/byrange
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
The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| status | String | 'OK' or 'ERROR' | |||||||||
| message | String | Empty if success or an error message | |||||||||
| data_type | String | 'create_trigger_by_range_response' or 'none' in case of an error | |||||||||
| data | String | Empty string | |||||||||
| data_str | JSON or String | This embedded JSON represents the result of the /create/trigger/byrange endpoint:
Empty string in case of an error. |
