GPUdb.create_trigger_by_area( request_id = None, table_names = None,
x_column_name = None, x_vector = None,
y_column_name = None, y_vector = None, options
= {} )
Sets up an area trigger mechanism for two column_names for one or more tables. (This function is essentially the two-dimensional version of create_trigger_by_range.) Once the trigger has been activated, any record added to the listed tables(s) via insert_records with the chosen columns' values falling within the specified region will trip the trigger. All such records will be queued at GPUdb's trigger port-by default '9001' but can also be obtained 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 | str | ID for the trigger to be activated. |
| table_names | list of str | Names of the tables on which the trigger will be activated and maintained. |
| x_column_name | str | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
| x_vector | list of floats | The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. |
| y_column_name | str | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
| y_vector | list of floats | The respective coordinate values for the region on which the trigger is activated. This usually translates to the y-coordinates of a geospatial region. Must be the same length as xvals. |
| options | dict of str | Optional parameters. Default value is an empty dict ( {} ). |
Output Parameter Description
| Name | Type | Description |
|---|---|---|
| trigger_id | str | Value of input parameter request_id. |