awswrangler.catalog.add_column

awswrangler.catalog.add_column(database: str, table: str, column_name: str, column_type: str = 'string', column_comment: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = None, catalog_id: Optional[str] = None) → Any

Add a column in a AWS Glue Catalog 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.

  • column_name (str) – Column name

  • column_type (str) – Column type.

  • column_comment (str) – Column Comment

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

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

Returns

None

Return type

None

Examples

>>> import awswrangler as wr
>>> wr.catalog.add_column(
...     database='my_db',
...     table='my_table',
...     column_name='my_col',
...     column_type='int'
... )