A set of parameters for Kinetica.createTableMonitor(string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.CreateTableMonitorRequest:

Collaboration diagram for kinetica.CreateTableMonitorRequest:

Classes
struct	Options
	Optional parameters. More...

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

	CreateTableMonitorRequest (string table_name, IDictionary< string, string > options=null)
	Constructs a CreateTableMonitorRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	table_name `[get, set]`
	Name of the table to monitor, in [schema_name. More...

IDictionary< string, string >	options `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.createTableMonitor(string,IDictionary{string, string}).

Creates a monitor that watches for a single table modification event type (insert, update, or delete) on a particular table (identified by table_name) and forwards event notifications to subscribers via ZMQ. After this call completes, subscribe to the returned <member name="topic_id"> on the ZMQ table monitor port (default 9002). Each time an operation of the given type 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 corresponds to the event and can be decoded using <member name="type_schema">. The monitor will continue to run (regardless of whether or not there are any subscribers) until deactivated with Kinetica.clearTableMonitor(string,IDictionary{string, string}).
For more information on table monitors, see Table Monitors.

Definition at line 42 of file CreateTableMonitor.cs.

Constructor & Destructor Documentation

kinetica.CreateTableMonitorRequest.CreateTableMonitorRequest ( )

inline

Constructs a CreateTableMonitorRequest object with default parameters.

Definition at line 397 of file CreateTableMonitor.cs.

kinetica.CreateTableMonitorRequest.CreateTableMonitorRequest	(	string	table_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateTableMonitorRequest object with the specified parameters.

Parameters

table_name Name of the table to monitor, in [schema_name.]table_name format, using standard name resolution rules.

options

Optional parameters.

EVENT: Type of modification event on the target table to be monitored by this table monitor. Supported values:
- INSERT: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
- UPDATE: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
- DELETE: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
The default value is INSERT.
MONITOR_ID: ID to use for this monitor instead of a randomly generated one
DATASINK_NAME: Name of an existing data sink to send change data notifications to
DESTINATION: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'.
KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if destination in is specified and is a Kafka broker
INCREASING_COLUMN: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
EXPRESSION: Filter expression to limit records for notification
REFRESH_METHOD: Method controlling when the table monitor reports changes to the . Supported values:
- ON_CHANGE: Report changes as they occur.
- PERIODIC: Report changes periodically at rate specified by refresh_period.
The default value is ON_CHANGE.
REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which changes are reported.
REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which changes are reported. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.

The default value is an empty Dictionary.

Definition at line 519 of file CreateTableMonitor.cs.

Property Documentation

IDictionary<string, string> kinetica.CreateTableMonitorRequest.options

getset

Optional parameters.

EVENT: Type of modification event on the target table to be monitored by this table monitor. Supported values:
- INSERT: Get notifications of new record insertions. The new row images are forwarded to the subscribers.
- UPDATE: Get notifications of update operations. The modified row count information is forwarded to the subscribers.
- DELETE: Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.
The default value is INSERT.
MONITOR_ID: ID to use for this monitor instead of a randomly generated one
DATASINK_NAME: Name of an existing data sink to send change data notifications to
DESTINATION: Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'.
KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if destination in is specified and is a Kafka broker
INCREASING_COLUMN: Column on subscribed table that will increase for new records (e.g., TIMESTAMP).
EXPRESSION: Filter expression to limit records for notification
REFRESH_METHOD: Method controlling when the table monitor reports changes to the . Supported values:
- ON_CHANGE: Report changes as they occur.
- PERIODIC: Report changes periodically at rate specified by refresh_period.
The default value is ON_CHANGE.
REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which changes are reported.
REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which changes are reported. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.

The default value is an empty Dictionary.

Definition at line 392 of file CreateTableMonitor.cs.

string kinetica.CreateTableMonitorRequest.table_name

getset

Name of the table to monitor, in [schema_name.

]table_name format, using standard name resolution rules.

Definition at line 278 of file CreateTableMonitor.cs.

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

Kinetica/Protocol/CreateTableMonitor.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation