/show/tablemonitors

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/show/tablemonitors

Show table monitors and their properties. Table monitors are created using /create/tablemonitor. Returns detailed information about existing table monitors.

Input Parameter Description

NameTypeDescription
monitor_idsarray of stringsList of monitors to be shown. An empty list or a single entry with an empty string returns all table monitors.
optionsmap of string to stringsOptional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb 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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_table_monitors_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/tablemonitors endpoint:

NameTypeDescription
monitor_idsarray of stringsList of monitor IDs.
table_namesarray of stringsList of source tables being monitored for the respective output parameter monitor_ids.
eventsarray of stringsList of notification events for the respective output parameter monitor_ids.
increasing_columnsarray of stringsList of columns used on the respective tables in output parameter table_names that will increase for new records.
filter_expressionsarray of stringsList of filter expressions used on the respective tables in output parameter table_names to limit records for notifications.
refresh_methodarray of stringsList of refresh methods used on the respective tables in output parameter table_names.
refresh_periodarray of stringsList of refresh periods used on the respective tables in output parameter table_names.
refresh_start_timearray of stringsList of refresh start times used on the respective tables in output parameter table_names.
datasink_namesarray of stringsList of datasink names for the respective output parameter monitor_ids if one is defined.
additional_infoarray of maps of string to strings

Additional information about the respective monitors in output parameter monitor_ids.

Possible List EntriesDescription
map of string to strings

The default value is an empty map ( {} ).

Possible Parameters (keys)Parameter Description
monitor_typeNotification type for the respective output parameter monitor_ids and output parameter table_names. The default value is ''.
type_schemaNotification type schemas for the respective output parameter monitor_ids and output parameter table_names. The default value is ''.
materialized_view_for_change_detectorMaterialized view that implements the change detector
materialized_view_for_filterMaterialized views created for the output parameter filter_expressions. The default value is ''.
referencesReference count on the respective output parameter monitor_ids. The default value is ''.
datasink_jsonDatasink info in JSON format for the respective output parameter monitor_ids if one is defined. The default value is ''.
infomap of string to stringsAdditional information.

Empty string in case of an error.