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 Table Monitor.
For more information on table monitors, see Table Monitors.
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
table_name | string | Name of the table to monitor. Must not refer to a collection. | ||||||||||||
options | map of string to strings | Optional parameters. The default value is an empty map ( {} ).
|
Name | Type | Description |
---|---|---|
topic_id | string | The ZMQ topic ID to subscribe to for inserted records. |
table_name | string | Value of input parameter table_name. |
type_schema | string | JSON Avro schema of the table, for use in decoding published records. |
info | map of string to strings | Additional information. |