awswrangler.catalog.get_columns_comments¶
- awswrangler.catalog.get_columns_comments(database: str, table: str, catalog_id: str | None = None, boto3_session: Session | None = None) dict[str, str | None] ¶
Get all columns comments.
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, optional) – 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 (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.
- Returns:
Columns comments. e.g. {“col1”: “foo boo bar”, “col2”: None}.
- Return type:
Dict[str, Optional[str]]
Examples
>>> import awswrangler as wr >>> pars = wr.catalog.get_columns_comments(database="...", table="...")