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

A set of input parameters for createTableMonitor(const CreateTableMonitorRequest&) const. More...

#include <gpudb/protocol/create_table_monitor.h>

Public Member Functions

 CreateTableMonitorRequest ()
 Constructs a CreateTableMonitorRequest object with default parameter values. More...
 
 CreateTableMonitorRequest (const std::string &tableName_, const std::map< std::string, std::string > &options_)
 Constructs a CreateTableMonitorRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for createTableMonitor(const CreateTableMonitorRequest&) const.

Creates a monitor that watches for new records inserted into a particular table (identified by tableName) and forwards copies to subscribers via ZMQ. After this call completes, subscribe to the returned topicId on the ZMQ table monitor port (default 9002). Each time an insert operation on the table completes, a multipart message is published for that topic; the first part contains only the topic ID, and each subsequent part contains one binary-encoded Avro object that was inserted. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with clearTableMonitor(const ClearTableMonitorRequest&) const.

Definition at line 27 of file create_table_monitor.h.

Constructor & Destructor Documentation

◆ CreateTableMonitorRequest() [1/2]

gpudb::CreateTableMonitorRequest::CreateTableMonitorRequest ( )
inline

Constructs a CreateTableMonitorRequest object with default parameter values.

Definition at line 34 of file create_table_monitor.h.

◆ CreateTableMonitorRequest() [2/2]

gpudb::CreateTableMonitorRequest::CreateTableMonitorRequest ( const std::string &  tableName_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a CreateTableMonitorRequest object with the specified parameters.

Parameters
[in]tableName_Name of the table to monitor. Must not refer to a collection.
[in]options_Optional parameters.

Definition at line 49 of file create_table_monitor.h.

Member Data Documentation

◆ options

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

Definition at line 56 of file create_table_monitor.h.

◆ tableName

std::string gpudb::CreateTableMonitorRequest::tableName

Definition at line 55 of file create_table_monitor.h.


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