awswrangler.catalog.get_table_types

awswrangler.catalog.get_table_types(database: str, table: str, catalog_id: str | None = None, boto3_session: Session | None = None) dict[str, str] | None

Get all columns and types from a table.

Note

This function has arguments which can be configured globally through wr.config or environment variables:

  • catalog_id

  • database

Check out the Global Configurations Tutorial for details.

Parameters:
  • database (str) – Database name.

  • table (str) – Table name.

  • catalog_id (str, optional) – The ID of the Data Catalog from which to retrieve Databases. If none is provided, the AWS account ID is used by default.

  • boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.

Returns:

If table exists, a dictionary like {‘col name’: ‘col data type’}. Otherwise None.

Return type:

Optional[Dict[str, str]]

Examples

>>> import awswrangler as wr
>>> wr.catalog.get_table_types(database='default', table='my_table')
{'col0': 'int', 'col1': double}