awswrangler.athena.generate_create_query

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

Generate the query that created a table(EXTERNAL_TABLE) or a view(VIRTUAL_TABLE).

Analyzes an existing table named table_name to generate the query that created it.

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:

  • table (str) – Table name.

  • database (str | None) – Database 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:

str

Returns:

The query that created the table or view.

Examples

>>> import awswrangler as wr
>>> view_create_query: str = wr.athena.generate_create_query(table='my_view', database='default')