URL: http://<db.host>:<db.port>/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

table_namestringName 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 ''.
authorizationstringNo longer used. User can pass an empty string. The default value is ''.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description

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

statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'clear_table_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /clear/table endpoint:

table_namestringValue of input parameter table_name for a given table, or 'ALL CLEARED' in case of clearing all tables.
infomap of string to stringsAdditional information.

Empty string in case of an error.