awswrangler.catalog.get_engine

awswrangler.catalog.get_engine(connection: str, catalog_id: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = None, **sqlalchemy_kwargs: Any) → sqlalchemy.engine.base.Engine

Return a SQLAlchemy Engine from a Glue Catalog Connection.

Only Redshift, PostgreSQL and MySQL are supported.

Parameters
  • connection (str) – Connection 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.

  • sqlalchemy_kwargs – keyword arguments forwarded to sqlalchemy.create_engine(). https://docs.sqlalchemy.org/en/13/core/engines.html

Returns

SQLAlchemy Engine.

Return type

sqlalchemy.engine.Engine

Examples

>>> import awswrangler as wr
>>> res = wr.catalog.get_engine(name='my_connection')