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

Retrieves the user provided metadata for the specified tables.

Parameters

table_names (list of str) –

Names of tables whose metadata will be fetched, in [schema_name.]table_name format, using standard name resolution rules. All provided tables must exist, or an error is returned. 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. The default value is an empty dict ( ).

Returns

A dict with the following entries–

table_names (list of str) –

Value of input parameter table_names.

metadata_maps (list of dicts of str to str) –

A list of maps which contain the metadata of the tables in the order the tables are listed in input parameter table_names. Each map has (metadata attribute name, metadata attribute value) pairs.

info (dict of str to str) –

Additional information.