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

A set of output parameters for createTriggerByArea(const CreateTriggerByAreaRequest&) const. More...

#include <gpudb/protocol/create_trigger_by_area.h>

Public Member Functions

 CreateTriggerByAreaResponse ()
 Constructs a CreateTriggerByAreaResponse object with default parameter values. More...
 

Public Attributes

std::string triggerId
 

Detailed Description

A set of output 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 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 196 of file create_trigger_by_area.h.

Constructor & Destructor Documentation

◆ CreateTriggerByAreaResponse()

gpudb::CreateTriggerByAreaResponse::CreateTriggerByAreaResponse ( )
inline

Constructs a CreateTriggerByAreaResponse object with default parameter values.

Definition at line 203 of file create_trigger_by_area.h.

Member Data Documentation

◆ triggerId

std::string gpudb::CreateTriggerByAreaResponse::triggerId

Definition at line 208 of file create_trigger_by_area.h.


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