awswrangler.catalog.get_columns_comments¶
- awswrangler.catalog.get_columns_comments(database: str, table: str, transaction_id: str | None = None, query_as_of_time: str | None = None, catalog_id: str | None = None, boto3_session: Session | None = None) Any ¶
Get all columns comments.
Note
If reading from a governed table, pass only one of transaction_id or query_as_of_time.
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.
transaction_id (str, optional) – The ID of the transaction (i.e. used with GOVERNED tables).
query_as_of_time (str, optional) – The time as of when to read the table contents. Must be a valid Unix epoch timestamp. Cannot be specified alongside transaction_id.
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”}.
- Return type:
Dict[str, str]
Examples
>>> import awswrangler as wr >>> pars = wr.catalog.get_columns_comments(database="...", table="...")