/clear/tables

URL: http://<db.host>:<db.port>/clear/tables

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

Name

Type

Description

table_names

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 be prevented by default via gpudb.conf parameter 'disable_clear_all'. The default value is an empty array ( [] ).

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

'clear_tables_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 /clear/tables endpoint:

Name	Type	Description
tables	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.
info	map of string to strings	Additional information.

Empty string in case of an error.