com.gpudb.protocol

Class CreateTableMonitorRequest.Options

java.lang.Object

com.gpudb.protocol.CreateTableMonitorRequest.Options

Enclosing class:

CreateTableMonitorRequest

public static final class CreateTableMonitorRequest.Options
extends Object

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

Field Summary

Fields

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

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT

public static final String 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.

See Also:

Constant Field Values

INSERT

public static final String INSERT

Get notifications of new record insertions. The new row images are forwarded to the subscribers.

See Also:

Constant Field Values

UPDATE

public static final String UPDATE

Get notifications of update operations. The modified row count information is forwarded to the subscribers.

See Also:

Constant Field Values

DELETE

public static final String DELETE

Get notifications of delete operations. The deleted row count information is forwarded to the subscribers.

See Also:

Constant Field Values

MONITOR_ID

public static final String MONITOR_ID

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

See Also:

Constant Field Values

DATASINK_NAME

public static final String DATASINK_NAME

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

See Also:

Constant Field Values

DESTINATION

public static final String DESTINATION

Destination for the output data in format 'destination_type://path[:port]'. Supported destination types are 'http', 'https' and 'kafka'.

See Also:

Constant Field Values

KAFKA_TOPIC_NAME

public static final String KAFKA_TOPIC_NAME

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

See Also:

Constant Field Values

INCREASING_COLUMN

public static final String INCREASING_COLUMN

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

See Also:

Constant Field Values

EXPRESSION

public static final String EXPRESSION

Filter expression to limit records for notification

See Also:

Constant Field Values

REFRESH_METHOD

public static final String REFRESH_METHOD

Method controlling when the table monitor reports changes to the tableName. 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.

See Also:

Constant Field Values

ON_CHANGE

public static final String ON_CHANGE

Report changes as they occur.

See Also:

Constant Field Values

PERIODIC

public static final String PERIODIC

Report changes periodically at rate specified by refresh_period.

See Also:

Constant Field Values

REFRESH_PERIOD

public static final String REFRESH_PERIOD

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

See Also:

Constant Field Values

REFRESH_START_TIME

public static final String 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'.

See Also:

Constant Field Values