GPUdb C++ API  Version 6.2.0.3
gpudb::CreateTriggerByRangeRequest Struct Reference

A set of input parameters for createTriggerByRange(const CreateTriggerByRangeRequest&) const. More...

#include <gpudb/protocol/create_trigger_by_range.h>

Public Member Functions

 CreateTriggerByRangeRequest ()
 Constructs a CreateTriggerByRangeRequest object with default parameter values. 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
 
std::vector< std::string > tableNames
 
std::string columnName
 
double min
 
double max
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for createTriggerByRange(const CreateTriggerByRangeRequest&) const.

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 insertRecordsRaw(const RawInsertRecordsRequest&) const 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 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 31 of file create_trigger_by_range.h.

Constructor & Destructor Documentation

◆ CreateTriggerByRangeRequest() [1/2]

gpudb::CreateTriggerByRangeRequest::CreateTriggerByRangeRequest ( )
inline

Constructs a CreateTriggerByRangeRequest object with default parameter values.

Definition at line 38 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.
[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.

Definition at line 63 of file create_trigger_by_range.h.

Member Data Documentation

◆ columnName

std::string gpudb::CreateTriggerByRangeRequest::columnName

Definition at line 75 of file create_trigger_by_range.h.

◆ max

double gpudb::CreateTriggerByRangeRequest::max

Definition at line 77 of file create_trigger_by_range.h.

◆ min

double gpudb::CreateTriggerByRangeRequest::min

Definition at line 76 of file create_trigger_by_range.h.

◆ options

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

Definition at line 78 of file create_trigger_by_range.h.

◆ requestId

std::string gpudb::CreateTriggerByRangeRequest::requestId

Definition at line 73 of file create_trigger_by_range.h.

◆ tableNames

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

Definition at line 74 of file create_trigger_by_range.h.


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