create_trigger_by_area
- create_trigger_by_area(
request_id: string,
table_names: string[],
x_column_name: string,
x_vector: number[],
y_column_name: string,
y_vector: number[],
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<CreateTriggerByAreaResponse>Parameters
- 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: string[]
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.
- x_column_name: string
Name of a numeric column on which the trigger is activated. Usually ‘x’ for geospatial data points.
- x_vector: number[]
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: string
Name of a second numeric column on which the trigger is activated. Usually ‘y’ for geospatial data points.
- y_vector: number[]
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.
Optionaloptions: Record<string, string>Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<CreateTriggerByAreaResponse>
Promise<Types.CreateTriggerByAreaResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:6924
- request_id: string
create_trigger_by_area_request
- create_trigger_by_area_request(
request: CreateTriggerByAreaRequest,
callback?: GPUdbCallback,
): Promise<CreateTriggerByAreaResponse>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) viainsert_recordswith 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 viashow_system_status) for any listening client to collect. Active triggers can be cancelled by using theclear_triggerendpoint 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: CreateTriggerByAreaRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<CreateTriggerByAreaResponse>
Promise<Types.CreateTriggerByAreaResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:6880
- request: CreateTriggerByAreaRequest
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) viainsert_recordswith 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 viashow_system_status) for any listening client to collect. Active triggers can be cancelled by using theclear_triggerendpoint or by clearing all relevant tables.The output returns the trigger handle as well as indicating success or failure of the trigger activation.