A set of string constants for the parameter options. 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	MAX_CONSECUTIVE_FAILURES = "max_consecutive_failures"
	Maximum number of consecutive failed notification attempts before suspending the stream. More...

const string	FAILED_NOTIFICATIONS_TABLE_NAME = "failed_notifications_table_name"
	Name of a table to which failed stream notifications are written when the stream is suspended. 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	JOIN_TABLE_NAMES = "join_table_names"
	A comma-separated list of tables (optionally with aliases) to include in the join. More...

const string	JOIN_COLUMN_NAMES = "join_column_names"
	A comma-separated list of columns or expressions to include from the joined tables. More...

const string	JOIN_EXPRESSIONS = "join_expressions"
	Filter or join expressions to apply when combining the tables. 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

A set of string constants for the parameter options.

Optional parameters.

Definition at line 36 of file CreateTableMonitor.cs.

Member Data Documentation

◆ DATASINK_NAME

const string CreateTableMonitorRequest.Options.DATASINK_NAME = "datasink_name"

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

Definition at line 87 of file CreateTableMonitor.cs.

◆ DELETE

const string CreateTableMonitorRequest.Options.DELETE = "delete"

Get notifications of delete operations.

The deleted row count information is forwarded to the subscribers.

Definition at line 78 of file CreateTableMonitor.cs.

◆ DESTINATION

const string 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 110 of file CreateTableMonitor.cs.

◆ EVENT

const string 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 63 of file CreateTableMonitor.cs.

◆ EXPRESSION

const string CreateTableMonitorRequest.Options.EXPRESSION = "expression"

Filter expression to limit records for notification.

Definition at line 123 of file CreateTableMonitor.cs.

◆ FAILED_NOTIFICATIONS_TABLE_NAME

const string CreateTableMonitorRequest.Options.FAILED_NOTIFICATIONS_TABLE_NAME = "failed_notifications_table_name"

Name of a table to which failed stream notifications are written when the stream is suspended.

The database will attempt to send notifications persisted in this table when the stream is resumed. The table has the following columns: rank (long), job_id (long), uuid (uuid), timestamp (timestamp), error_msg (string), payload (bytes). Leave this option empty to disable persisting failed notification events.

Definition at line 104 of file CreateTableMonitor.cs.

◆ INCREASING_COLUMN

const string CreateTableMonitorRequest.Options.INCREASING_COLUMN = "increasing_column"

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

Definition at line 119 of file CreateTableMonitor.cs.

◆ INSERT

const string CreateTableMonitorRequest.Options.INSERT = "insert"

Get notifications of new record insertions.

The new row images are forwarded to the subscribers.

Definition at line 68 of file CreateTableMonitor.cs.

◆ JOIN_COLUMN_NAMES

const string CreateTableMonitorRequest.Options.JOIN_COLUMN_NAMES = "join_column_names"

A comma-separated list of columns or expressions to include from the joined tables.

Column references can use table names or aliases defined in 'join_table_names'. Each column can optionally be aliased using 'as'. The selected columns will also appear in the notification output.

Definition at line 140 of file CreateTableMonitor.cs.

◆ JOIN_EXPRESSIONS

const string CreateTableMonitorRequest.Options.JOIN_EXPRESSIONS = "join_expressions"

Filter or join expressions to apply when combining the tables.

Expressions are standard SQL-style conditions and can reference any table or alias listed in 'join_table_names'. This corresponds to the WHERE clause of the underlying join, and can include conditions to filter the delta rows.

Definition at line 148 of file CreateTableMonitor.cs.

◆ JOIN_TABLE_NAMES

const string CreateTableMonitorRequest.Options.JOIN_TABLE_NAMES = "join_table_names"

A comma-separated list of tables (optionally with aliases) to include in the join.

The monitored table table_name must be included, representing only the newly inserted rows (deltas) since the last notification. Other tables can be any existing tables or views. Aliases can be used with the 'table_name as alias' syntax.

Definition at line 132 of file CreateTableMonitor.cs.

◆ KAFKA_TOPIC_NAME

const string 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 115 of file CreateTableMonitor.cs.

◆ MAX_CONSECUTIVE_FAILURES

const string CreateTableMonitorRequest.Options.MAX_CONSECUTIVE_FAILURES = "max_consecutive_failures"

Maximum number of consecutive failed notification attempts before suspending the stream.

A value of -1 (default) disables auto-suspend. This value is by rank and not overall.

Definition at line 93 of file CreateTableMonitor.cs.

◆ MONITOR_ID

const string CreateTableMonitorRequest.Options.MONITOR_ID = "monitor_id"

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

Definition at line 82 of file CreateTableMonitor.cs.

◆ ON_CHANGE

const string CreateTableMonitorRequest.Options.ON_CHANGE = "on_change"

Report changes as they occur.

Definition at line 170 of file CreateTableMonitor.cs.

◆ PERIODIC

const string CreateTableMonitorRequest.Options.PERIODIC = "periodic"

Report changes periodically at rate specified by REFRESH_PERIOD.

Definition at line 174 of file CreateTableMonitor.cs.

◆ REFRESH_METHOD

const string 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 167 of file CreateTableMonitor.cs.

◆ REFRESH_PERIOD

const string CreateTableMonitorRequest.Options.REFRESH_PERIOD = "refresh_period"

When REFRESH_METHOD is PERIODIC, specifies the period in seconds at which changes are reported.

Definition at line 180 of file CreateTableMonitor.cs.

◆ REFRESH_START_TIME

const string 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 188 of file CreateTableMonitor.cs.

◆ UPDATE

const string CreateTableMonitorRequest.Options.UPDATE = "update"

Get notifications of update operations.

The modified row count information is forwarded to the subscribers.

Definition at line 73 of file CreateTableMonitor.cs.

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

Kinetica/Protocol/CreateTableMonitor.cs

Public Attributes