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

Retrieves information about a schema (or all schemas), as specified in input parameter schema_name.

Parameters

schema_name (str) –

Name of the schema for which to retrieve the information. If blank, then info for all schemas is returned.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • no_error_if_not_exists – If false will return an error if the provided input parameter schema_name does not exist. If true then it will return an empty result if the provided input parameter schema_name does not exist. 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.

schema_names (list of str) –

A list of all schema names for which information is returned.

schema_tables (list of lists of str) –

An array of arrays containing a list of tables in each of the respective output parameter schema_names.

additional_info (list of dicts of str to str) –

Additional information about the respective tables in output parameter schema_names.

info (dict of str to str) –

Additional information.