Skip to main content
show_table_monitors(monitor_ids=None, options=)[source]

Show table monitors and their properties. Table monitors are created using GPUdb.create_table_monitor(). Returns detailed information about existing table monitors.

Parameters

monitor_ids (list of str) –

List of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors. The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. The default value is an empty dict ( ).

Returns

A dict with the following entries–

monitor_ids (list of str) –

List of monitor IDs.

table_names (list of str) –

List of source tables being monitored for the respective output parameter monitor_ids.

events (list of str) –

List of notification events for the respective output parameter monitor_ids.

increasing_columns (list of str) –

List of columns used on the respective tables in output parameter table_names that will increase for new records.

filter_expressions (list of str) –

List of filter expressions used on the respective tables in output parameter table_names to limit records for notifications.

join_table_names (list of str) –

List of join table names.

join_column_names (list of str) –

List of join column names.

join_expressions (list of str) –

List of join expressions.

refresh_method (list of str) –

List of refresh methods used on the respective tables in output parameter table_names.

refresh_period (list of str) –

List of refresh periods used on the respective tables in output parameter table_names.

refresh_start_time (list of str) –

List of refresh start times used on the respective tables in output parameter table_names.

datasink_names (list of str) –

List of datasink names for the respective output parameter monitor_ids if one is defined.

max_consecutive_failures (list of ints) –

Maximum number of consecutive failures for the respective output parameter monitor_ids before stream is automatically suspended.

failed_notifications_table_names (list of str) –

List of table names that will hold failed notification events when the respective output parameter monitor_ids is suspended.

statuses (list of str) –

Status of stream for the respective output parameter monitor_ids.

additional_info (list of dicts of str to str) –

Additional information about the respective monitors in output parameter monitor_ids. Allowed keys are:

  • monitor_type – Notification type for the respective output parameter monitor_ids and output parameter table_names. The default value is ‘’.

  • type_schema – Notification type schemas for the respective output parameter monitor_ids and output parameter table_names. The default value is ‘’.

  • materialized_view_for_change_detector – Materialized view that implements the change detector.

  • materialized_view_for_filter – Materialized views created for the output parameter filter_expressions. The default value is ‘’.

  • references – Reference count on the respective output parameter monitor_ids. The default value is ‘’.

  • datasink_json – Datasink info in JSON format for the respective output parameter monitor_ids if one is defined. The default value is ‘’.

info (dict of str to str) –

Additional information.