Skip to main content
clear_tables(table_names=[], options=)[source]

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.

Parameters

table_names (list of str) –

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 list ( [] ). The user can provide a single element (which will be automatically promoted to a list internally) or a list.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • 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. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

tables (dict of str to str) –

For each table in input parameter table_names, any error from the clear operation, or an empty string if successful.

info (dict of str to str) –

Additional information.