awswrangler.catalog.table

awswrangler.catalog.table(database: str, table: str, catalog_id: str | None = None, boto3_session: Session | None = None) → DataFrame

Get table details as Pandas DataFrame.

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.

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

Return type:

DataFrame

Returns:

Pandas DataFrame filled by formatted table information.

Examples

>>> import awswrangler as wr
>>> df_table = wr.catalog.table(database='default', table='my_table')