/alter/tablemonitor - Kinetica Docs

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

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

Input Parameter Description

string

The topic ID returned by /create/tablemonitor.

map of string to strings

Map containing the properties of the table monitor to be updated. Error if empty.

Show monitor_updates_map

Updates the schema name. If schema_name doesn’t exist, an error will be thrown. If schema_name is empty, then the user’s default schema will be used.

Updates the maximum number of consecutive failures before suspending the stream. A value of ‘-1’ to disables auto-suspend. This value is by rank and not overall.

Updates the state of the monitor.The default value is an empty map ( {} ).The supported values are:

resume
suspend

map of string to strings

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

Output Parameter Description

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

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘alter_table_monitor_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

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

Show data_str

string

Value of input parameter topic_id.

map of string to strings

Additional information.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description