GPUdb C++ API
Version 7.0.19.0
|
A set of input parameters for const. More...
#include <gpudb/protocol/create_trigger_by_area.h>
Public Member Functions | |
CreateTriggerByAreaRequest () | |
Constructs a CreateTriggerByAreaRequest object with default parameter values. More... | |
CreateTriggerByAreaRequest (const std::string &requestId_, const std::vector< std::string > &tableNames_, const std::string &xColumnName_, const std::vector< double > &xVector_, const std::string &yColumnName_, const std::vector< double > &yVector_, const std::map< std::string, std::string > &options_) | |
Constructs a CreateTriggerByAreaRequest object with the specified parameters. More... | |
Public Attributes | |
std::string | requestId |
std::vector< std::string > | tableNames |
std::string | xColumnName |
std::vector< double > | xVector |
std::string | yColumnName |
std::vector< double > | yVector |
std::map< std::string, std::string > | options |
A set of input parameters for const.
Sets up an area trigger mechanism for two column_names for one or more tables. (This function is essentially the two-dimensional version of const.) Once the trigger has been activated, any record added to the listed tables(s) via const 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 const) for any listening client to collect. Active triggers can be cancelled by using the const endpoint or by clearing all relevant tables.
The output returns the trigger handle as well as indicating success or failure of the trigger activation.
Definition at line 34 of file create_trigger_by_area.h.
|
inline |
Constructs a CreateTriggerByAreaRequest object with default parameter values.
Definition at line 41 of file create_trigger_by_area.h.
|
inline |
Constructs a CreateTriggerByAreaRequest object with the specified parameters.
[in] | requestId_ | User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character. |
[in] | tableNames_ | Names of the tables on which the trigger will be activated and maintained. |
[in] | xColumnName_ | Name of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points. |
[in] | xVector_ | The respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region. |
[in] | yColumnName_ | Name of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points. |
[in] | yVector_ | 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. |
[in] | options_ | Optional parameters. |
Definition at line 78 of file create_trigger_by_area.h.
std::map<std::string, std::string> gpudb::CreateTriggerByAreaRequest::options |
Definition at line 95 of file create_trigger_by_area.h.
std::string gpudb::CreateTriggerByAreaRequest::requestId |
Definition at line 89 of file create_trigger_by_area.h.
std::vector<std::string> gpudb::CreateTriggerByAreaRequest::tableNames |
Definition at line 90 of file create_trigger_by_area.h.
std::string gpudb::CreateTriggerByAreaRequest::xColumnName |
Definition at line 91 of file create_trigger_by_area.h.
std::vector<double> gpudb::CreateTriggerByAreaRequest::xVector |
Definition at line 92 of file create_trigger_by_area.h.
std::string gpudb::CreateTriggerByAreaRequest::yColumnName |
Definition at line 93 of file create_trigger_by_area.h.
std::vector<double> gpudb::CreateTriggerByAreaRequest::yVector |
Definition at line 94 of file create_trigger_by_area.h.