/clear/tablemonitor

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/clear/tablemonitor

Deactivates a table monitor previously created with /create/tablemonitor.

Input Parameter Description

Name Type Description
topic_id string The topic ID returned by /create/tablemonitor.
options map of string to strings

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

Supported Parameters (keys) Parameter Description
keep_autogenerated_sink

If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. The default value is false. The supported values are:

  • true
  • false
clear_all_references

If true, all references that share the same input parameter topic_id will be cleared. The default value is false. The supported values are:

  • true
  • false

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:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'clear_table_monitor_response' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /clear/tablemonitor endpoint:

Name Type Description
topic_id string Value of input parameter topic_id.
info map of string to strings Additional information.

Empty string in case of an error.