/clear/tablemonitor

URL: http://<db.host>:<db.port>/clear/tablemonitor

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

Input Parameter Description

NameTypeDescription
topic_idstringThe topic ID returned by /create/tablemonitor.
optionsmap 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:

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

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

NameTypeDescription
topic_idstringValue of input parameter topic_id.
infomap of string to stringsAdditional information.

Empty string in case of an error.