Clears (drops) tables in the database cluster. The operation is synchronous
meaning that the tables will be cleared before the function returns. The
response payload returns the status of the operation for each table requested.
Input Parameter Description
array of strings
Names of the tables to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be existing tables. Empty list clears all available tables, though this behavior is prevented by default via system configuration parameter disable_clear_all.The default value is an empty array ( [] ).
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If true and if a table specified in input parameter table_names does not exist no error is returned. If false and if a table specified in input parameter table_names does not exist then an error is returned.The default value is false.The supported values are:
true
false
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
‘clear_tables_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /clear/tables endpoint:
Show data_str
map of string to strings
For each table in input parameter table_names, any error from the clear operation, or an empty string if successful.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.