Skip to main content
drop_schema(schema_name=None, options=)[source]

Drops an existing SQL-style schema, specified in input parameter schema_name.

Parameters

schema_name (str) –

Name of the schema to be dropped. Must be an existing schema.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • no_error_if_not_exists – If true and if the schema specified in input parameter schema_name does not exist, no error is returned. If false and if the schema specified in input parameter schema_name does not exist, then an error is returned. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • cascade – If true, all tables within the schema will be dropped. If false, the schema will be dropped only if empty. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

schema_name (str) –

Value of input parameter schema_name.

info (dict of str to str) –

Additional information.