awswrangler.catalog.get_columns_parameters¶
- awswrangler.catalog.get_columns_parameters(database: str, table: str, catalog_id: str | None = None, boto3_session: Session | None = None) dict[str, dict[str, str] | None] ¶
Get all columns parameters.
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
|None
) – The ID of the Data Catalog from which to retrieve Databases. IfNone
is provided, the AWS account ID is used by default.boto3_session (
Session
|None
) – The default boto3 session will be used if boto3_session receiveNone
.
- Return type:
dict
[str
,dict
[str
,str
] |None
]- Returns:
Columns parameters.
Examples
>>> import awswrangler as wr >>> pars = wr.catalog.get_columns_parameters(database="...", table="...")