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

#include <gpudb/protocol/create_trigger_by_range.h>

Public Member Functions
	CreateTriggerByRangeRequest ()
	Constructs a CreateTriggerByRangeRequest object with default parameters. More...

	CreateTriggerByRangeRequest (const std::string &requestId_, const std::vector< std::string > &tableNames_, const std::string &columnName_, const double min_, const double max_, const std::map< std::string, std::string > &options_)
	Constructs a CreateTriggerByRangeRequest object with the specified parameters. More...

Public Attributes
std::string	requestId
	User-created ID for the trigger. More...

std::vector< std::string >	tableNames
	Tables on which the trigger will be active, each in [ schema_name. More...

std::string	columnName
	Name of a numeric column_name on which the trigger is activated. More...

double	min
	The lower bound (inclusive) for the trigger range. More...

double	max
	The upper bound (inclusive) for the trigger range. More...

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

Detailed Description

A set of parameters for GPUdb::createTriggerByRange.

Sets up a simple range trigger for a column_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via GPUdb::insertRecords with the chosen column_name's value falling within the specified range 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 33 of file create_trigger_by_range.h.

Constructor & Destructor Documentation

◆ CreateTriggerByRangeRequest() [1/2]

gpudb::CreateTriggerByRangeRequest::CreateTriggerByRangeRequest ( )

inline

Constructs a CreateTriggerByRangeRequest object with default parameters.

Definition at line 39 of file create_trigger_by_range.h.

◆ CreateTriggerByRangeRequest() [2/2]

gpudb::CreateTriggerByRangeRequest::CreateTriggerByRangeRequest	(	const std::string &	requestId_,
		const std::vector< std::string > &	tableNames_,
		const std::string &	columnName_,
		const double	min_,
		const double	max_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateTriggerByRangeRequest 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_	Tables on which the trigger will be active, each in [schema_name.]table_name format, using standard name resolution rules.
[in]	columnName_	Name of a numeric column_name on which the trigger is activated.
[in]	min_	The lower bound (inclusive) for the trigger range.
[in]	max_	The upper bound (inclusive) for the trigger range.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 68 of file create_trigger_by_range.h.

Member Data Documentation

◆ columnName

std::string gpudb::CreateTriggerByRangeRequest::columnName

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

Definition at line 95 of file create_trigger_by_range.h.

◆ max

double gpudb::CreateTriggerByRangeRequest::max

The upper bound (inclusive) for the trigger range.

Definition at line 105 of file create_trigger_by_range.h.

◆ min

double gpudb::CreateTriggerByRangeRequest::min

The lower bound (inclusive) for the trigger range.

Definition at line 100 of file create_trigger_by_range.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 110 of file create_trigger_by_range.h.

◆ requestId

std::string gpudb::CreateTriggerByRangeRequest::requestId

User-created ID for the trigger.

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

Definition at line 82 of file create_trigger_by_range.h.

◆ tableNames

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

Tables on which the trigger will be active, each in [ schema_name.

\ ]table_name format, using standard name resolution rules.

Definition at line 90 of file create_trigger_by_range.h.

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

gpudb/protocol/create_trigger_by_range.h

Public Member Functions

Public Attributes