◆ createTriggerByArea() [1/2]
| inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords 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 showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_ | Request object containing the parameters for the operation. |
Definition at line 28588 of file KineticaFunctions.cs.
◆ createTriggerByArea() [2/2]
| inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords 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 showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_id | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | 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 | Name of a numeric column on which the trigger is activated. Usually ‘x’ for geospatial data points. |
| x_vector | 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 | Name of a second numeric column on which the trigger is activated. Usually ‘y’ for geospatial data points. |
| y_vector | 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 | Optional parameters. The default value is an empty Dictionary. |
Definition at line 28669 of file KineticaFunctions.cs.
◆ CreateTriggerByAreaAsync() [1/2]
| inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(async)
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords 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 showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_ | Request object containing the parameters for the operation. |
| cancellationToken | Cancellation token to cancel the operation. |
Definition at line 28619 of file KineticaFunctions.cs.
◆ CreateTriggerByAreaAsync() [2/2]
| inline |
Sets up an area trigger mechanism for two column_names for one or more tables.
(async)
(This function is essentially the two-dimensional version of createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecords 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 showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the clearTrigger endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
| request_id | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
| table_names | 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 | Name of a numeric column on which the trigger is activated. Usually ‘x’ for geospatial data points. |
| x_vector | 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 | Name of a second numeric column on which the trigger is activated. Usually ‘y’ for geospatial data points. |
| y_vector | 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 | Optional parameters. The default value is an empty Dictionary. |
| cancellationToken | Cancellation token to cancel the operation. |
Definition at line 28729 of file KineticaFunctions.cs.