Creates a monitor that watches for a single table modification event type
(insert, update, or delete) on a particular table (identified by input
parameter table_name) and forwards event notifications to subscribers via
ZMQ. After this call completes, subscribe to the returned output parameter
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 output parameter type_schema. The monitor will continue to
run (regardless of whether or not there are any subscribers) until deactivated
with /clear/tablemonitor.For more information on table monitors, see
Table Monitors.
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.
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.
A comma-separated list of tables (optionally with aliases) to include in the join. The monitored table input parameter 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.
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.
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.
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
