​

Field Details

• ​

  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

• ​

  MAX_CONSECUTIVE_FAILURES

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

  See Also:

  • Constant Field Values

• ​

  FAILED_NOTIFICATIONS_TABLE_NAME

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

  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

• ​

  JOIN_TABLE_NAMES

  public static final String JOIN_TABLE_NAMES

  A comma-separated list of tables (optionally with aliases) to include in the join. The monitored table tableName 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.

  See Also:

  • Constant Field Values

• ​

  JOIN_COLUMN_NAMES

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

  See Also:

  • Constant Field Values

• ​

  JOIN_EXPRESSIONS

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

  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