Skip to main content
alter_schema(schema_name=None, action=None, value=None, options=)[source]

Used to change the name of a SQL-style schema, specified in input parameter schema_name.

Parameters

schema_name (str) –

Name of the schema to be altered.

action (str) –

Modification operation to be applied. Allowed values are:

  • add_comment – Adds a comment describing the schema.

  • rename_schema – Renames a schema to input parameter value. Has the same naming restrictions as tables.

value (str) –

The value of the modification, depending on input parameter action. For now the only value of input parameter action is rename_schema. In this case the value is the new name of the schema.

options (dict of str to str) –

Optional parameters. 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.