Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateTableMonitorRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string EVENT = "event"
 Type of modification event on the target table to be monitored by this table monitor. More...
 
const string INSERT = "insert"
 Get notifications of new record insertions. More...
 
const string UPDATE = "update"
 Get notifications of update operations. More...
 
const string DELETE = "delete"
 Get notifications of delete operations. More...
 
const string MONITOR_ID = "monitor_id"
 ID to use for this monitor instead of a randomly generated one More...
 
const string DATASINK_NAME = "datasink_name"
 Name of an existing data sink to send change data notifications to More...
 
const string DESTINATION = "destination"
 Destination for the output data in format 'destination_type://path[:port]'. More...
 
const string KAFKA_TOPIC_NAME = "kafka_topic_name"
 Name of the Kafka topic to publish to if destination in options is specified and is a Kafka broker More...
 
const string INCREASING_COLUMN = "increasing_column"
 Column on subscribed table that will increase for new records (e.g., TIMESTAMP). More...
 
const string EXPRESSION = "expression"
 Filter expression to limit records for notification More...
 
const string REFRESH_METHOD = "refresh_method"
 Method controlling when the table monitor reports changes to the table_name. More...
 
const string ON_CHANGE = "on_change"
 Report changes as they occur. More...
 
const string PERIODIC = "periodic"
 Report changes periodically at rate specified by refresh_period. More...
 
const string REFRESH_PERIOD = "refresh_period"
 When refresh_method is periodic, specifies the period in seconds at which changes are reported. More...
 
const string REFRESH_START_TIME = "refresh_start_time"
 When refresh_method is periodic, specifies the first time at which changes are reported. More...
 

Detailed Description

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. A set of string constants for the parameter options.

Definition at line 159 of file CreateTableMonitor.cs.

Member Data Documentation

const string kinetica.CreateTableMonitorRequest.Options.DATASINK_NAME = "datasink_name"

Name of an existing data sink to send change data notifications to

Definition at line 213 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.DELETE = "delete"

Get notifications of delete operations.

The deleted row count information is forwarded to the subscribers.

Definition at line 204 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.DESTINATION = "destination"

Destination for the output data in format 'destination_type://path[:port]'.

Supported destination types are 'http', 'https' and 'kafka'.

Definition at line 218 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.EVENT = "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.

Definition at line 190 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.EXPRESSION = "expression"

Filter expression to limit records for notification

Definition at line 231 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.INCREASING_COLUMN = "increasing_column"

Column on subscribed table that will increase for new records (e.g., TIMESTAMP).

Definition at line 227 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.INSERT = "insert"

Get notifications of new record insertions.

The new row images are forwarded to the subscribers.

Definition at line 194 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.KAFKA_TOPIC_NAME = "kafka_topic_name"

Name of the Kafka topic to publish to if destination in options is specified and is a Kafka broker

Definition at line 223 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.MONITOR_ID = "monitor_id"

ID to use for this monitor instead of a randomly generated one

Definition at line 208 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.ON_CHANGE = "on_change"

Report changes as they occur.

Definition at line 255 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.PERIODIC = "periodic"

Report changes periodically at rate specified by refresh_period.

Definition at line 259 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.REFRESH_METHOD = "refresh_method"

Method controlling when the table monitor reports changes to the table_name.

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.

Definition at line 252 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.REFRESH_PERIOD = "refresh_period"

When refresh_method is periodic, specifies the period in seconds at which changes are reported.

Definition at line 264 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.REFRESH_START_TIME = "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'.

Definition at line 270 of file CreateTableMonitor.cs.

const string kinetica.CreateTableMonitorRequest.Options.UPDATE = "update"

Get notifications of update operations.

The modified row count information is forwarded to the subscribers.

Definition at line 199 of file CreateTableMonitor.cs.


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