Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/alter/tablemonitor

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

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

Input Parameter Description

Name

Type

Description

topic_id

string

The topic ID returned by /create/tablemonitor.

monitor_updates_map

map of string to strings

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

Supported Parameters (keys)	Parameter Description
schema_name	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.

options

map of string to strings

Optional parameters.

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

'alter_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 /alter/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.