awswrangler.catalog.get_tables

awswrangler.catalog.get_tables(catalog_id: str | None = None, database: str | None = None, name_contains: str | None = None, name_prefix: str | None = None, name_suffix: str | None = None, boto3_session: Session | None = None) → Iterator[dict[str, Any]]

Get an iterator of tables.

Note

Please, do not filter using name_contains and name_prefix/name_suffix at the same time. Only name_prefix and name_suffix can be combined together.

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:

  • 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.

  • database (str | None) – Database name.

  • name_contains (str | None) – Select by a specific string on table name

  • name_prefix (str | None) – Select by a specific prefix on table name

  • name_suffix (str | None) – Select by a specific suffix on table name

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

Return type:

Iterator[dict[str, Any]]

Returns:

Iterator of tables.

Examples

>>> import awswrangler as wr
>>> tables = wr.catalog.get_tables()