A set of parameters for GPUdb::createTriggerByArea. More...

#include <gpudb/protocol/create_trigger_by_area.h>

Public Member Functions
	CreateTriggerByAreaRequest ()
	Constructs a CreateTriggerByAreaRequest object with default parameters. 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
	User-created ID for the trigger. More...

std::vector< std::string >	tableNames
	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. More...

std::string	xColumnName
	Name of a numeric column on which the trigger is activated. More...

std::vector< double >	xVector
	The respective coordinate values for the region on which the trigger is activated. More...

std::string	yColumnName
	Name of a second numeric column on which the trigger is activated. More...

std::vector< double >	yVector
	The respective coordinate values for the region on which the trigger is activated. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::createTriggerByArea.

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::createTriggerByRange.) Once the trigger has been activated, any record added to the listed tables(s) via GPUdb::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 GPUdb::showSystemStatus) for any listening client to collect. Active triggers can be cancelled by using the GPUdb::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.

Definition at line 35 of file create_trigger_by_area.h.

Constructor & Destructor Documentation

◆ CreateTriggerByAreaRequest() [1/2]

gpudb::CreateTriggerByAreaRequest::CreateTriggerByAreaRequest ( )

inline

Constructs a CreateTriggerByAreaRequest object with default parameters.

Definition at line 41 of file create_trigger_by_area.h.

◆ CreateTriggerByAreaRequest() [2/2]

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]	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, each in [schema_name.]table_name format, using standard name resolution rules.
[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. The default value is an empty map.

Definition at line 82 of file create_trigger_by_area.h.

Member Data Documentation

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 136 of file create_trigger_by_area.h.

◆ requestId

std::string gpudb::CreateTriggerByAreaRequest::requestId

User-created ID for the trigger.

The ID can be alphanumeric, contain symbols, and must contain at least one character.

Definition at line 97 of file create_trigger_by_area.h.

◆ tableNames

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

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.

Definition at line 105 of file create_trigger_by_area.h.

◆ xColumnName

std::string gpudb::CreateTriggerByAreaRequest::xColumnName

Name of a numeric column on which the trigger is activated.

Usually 'x' for geospatial data points.

Definition at line 111 of file create_trigger_by_area.h.

◆ xVector

std::vector<double> gpudb::CreateTriggerByAreaRequest::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.

Definition at line 118 of file create_trigger_by_area.h.

◆ yColumnName

std::string gpudb::CreateTriggerByAreaRequest::yColumnName

Name of a second numeric column on which the trigger is activated.

Usually 'y' for geospatial data points.

Definition at line 124 of file create_trigger_by_area.h.

◆ yVector

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