awswrangler.catalog.create_database

awswrangler.catalog.create_database(name: str, description: str | None = None, catalog_id: str | None = None, exist_ok: bool = False, database_input_args: dict[str, Any] | None = None, boto3_session: Session | None = None) → None

Create a database in AWS Glue Catalog.

Note

This function has arguments which can be configured globally through wr.config or environment variables:

  • catalog_id

Check out the Global Configurations Tutorial for details.

Parameters:

  • name (str) – Database name.

  • description (str | None) – A description for the Database.

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

  • exist_ok (bool) – If set to True will not raise an Exception if a Database with the same already exists. In this case the description will be updated if it is different from the current one.

  • database_input_args (dict[str, Any] | None) – Additional metadata to pass to database creation. Supported arguments listed here: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/glue.html#Glue.Client.create_database

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

Return type:

None

Examples

>>> import awswrangler as wr
>>> wr.catalog.create_database(
...     name='awswrangler_test'
... )