Clears (drops) one or all tables in the database cluster. The operation is
synchronous meaning that the table will be cleared before the function returns.
The response payload returns the status of the operation along with the name of
the table that was cleared.
Input Parameter Description
string
Name of the table to be cleared, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table. Empty string clears all available tables, though this behavior is prevented by default via system configuration parameter disable_clear_all.The default value is ”.
string
No longer used. User can pass an empty string.The default value is ”.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
If true and if the table specified in input parameter table_name does not exist no error is returned. If false and if the table specified in input parameter table_name 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_table_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /clear/table endpoint:
Show data_str
string
Value of input parameter table_name for a given table, or ‘ALL CLEARED’ in case of clearing all tables.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.