awswrangler.catalog.get_table_types

awswrangler.catalog.get_table_types(database: str, table: str, catalog_id: str | None = None, filter_iceberg_current: bool = False, 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 | None) – The ID of the Data Catalog from which to retrieve Databases. If None is provided, the AWS account ID is used by default.

  • filter_iceberg_current (bool) – If True, returns only current iceberg fields (fields marked with iceberg.field.current: true). Otherwise, returns the all fields. False by default (return all fields).

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

Return type:

dict[str, str] | None

Returns:

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

Examples

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