Note

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

Clear Table

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

Name

Type

Description

table_name

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 be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is ''.

authorization

string

No longer used. User can pass an empty string. The default value is ''.

options

map of string to strings

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

Supported Parameters (keys)

Parameter Description

no_error_if_not_exists

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

Name	Type	Description
table_name	string	Value of input parameter table_name for a given table, or 'ALL CLEARED' in case of clearing all tables.
info	map of string to strings	Additional information.