GPUdb C++ API  Version 5.2.0.0
gpudb::CreateTriggerByAreaRequest Struct Reference

A set of input parameters for createTriggerByArea(const CreateTriggerByAreaRequest&) 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
 

Detailed Description

A set of input parameters for createTriggerByArea(const CreateTriggerByAreaRequest&) 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 createTriggerByRange(const CreateTriggerByRangeRequest&) const.) Once the trigger has been activated, any record added to the listed tables(s) via insertRecordsRaw(const RawInsertRecordsRequest&) const 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 showSystemStatus(const ShowSystemStatusRequest&) const-for any listening client to collect. Active triggers can be cancelled by using the clearTrigger(const ClearTriggerRequest&) 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.

Constructor & Destructor Documentation

gpudb::CreateTriggerByAreaRequest::CreateTriggerByAreaRequest ( )
inline

Constructs a CreateTriggerByAreaRequest object with default parameter values.

Definition at line 41 of file create_trigger_by_area.h.

gpudb::CreateTriggerByAreaRequest::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 
)
inline

Constructs a CreateTriggerByAreaRequest object with the specified parameters.

Parameters
[in]requestIdID for the trigger to be activated.
[in]tableNamesNames of the tables on which the trigger will be activated and maintained.
[in]xColumnNameName of a numeric column on which the trigger is activated. Usually 'x' for geospatial data points.
[in]xVectorThe respective coordinate values for the region on which the trigger is activated. This usually translates to the x-coordinates of a geospatial region.
[in]yColumnNameName of a second numeric column on which the trigger is activated. Usually 'y' for geospatial data points.
[in]yVectorThe 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]optionsOptional parameters. Default value is an empty std::map.

Definition at line 77 of file create_trigger_by_area.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::CreateTriggerByAreaRequest::options

Definition at line 94 of file create_trigger_by_area.h.

std::string gpudb::CreateTriggerByAreaRequest::requestId

Definition at line 88 of file create_trigger_by_area.h.

std::vector<std::string> gpudb::CreateTriggerByAreaRequest::tableNames

Definition at line 89 of file create_trigger_by_area.h.

std::string gpudb::CreateTriggerByAreaRequest::xColumnName

Definition at line 90 of file create_trigger_by_area.h.

std::vector<double> gpudb::CreateTriggerByAreaRequest::xVector

Definition at line 91 of file create_trigger_by_area.h.

std::string gpudb::CreateTriggerByAreaRequest::yColumnName

Definition at line 92 of file create_trigger_by_area.h.

std::vector<double> gpudb::CreateTriggerByAreaRequest::yVector

Definition at line 93 of file create_trigger_by_area.h.


The documentation for this struct was generated from the following file: