create_trigger_by_area - Kinetica Docs

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=)[source]

Sets up an area trigger mechanism for two column_names for one or more tables. (This function is essentially the two-dimensional version of GPUdb.create_trigger_by_range().) Once the trigger has been activated, any record added to the listed tables(s) via GPUdb.insert_records() with the chosen columns’ values falling within the specified region will trip the trigger. All such records will be queued at the trigger port (by default ‘9001’ but able to be retrieved via GPUdb.show_system_status()) for any listening client to collect. Active triggers can be cancelled by using the GPUdb.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.

Parameters

request_id (str) –

User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

table_names (list of str) –

Names of the tables on which the trigger will be activated and maintained, each in [schema_name.]table_name format, using standard name resolution rules. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

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. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

trigger_id (str) –

Value of input parameter request_id.

info (dict of str to str) –

Additional information.