Skip to main content

prefect_sqlalchemy.credentials

Credential classes used to perform authenticated interactions with SQLAlchemy

Classes

AsyncDriver

Known dialects with their corresponding async drivers. Attributes:

SyncDriver

Known dialects with their corresponding sync drivers. Attributes:

ConnectionComponents

Parameters to use to create a SQLAlchemy engine URL. Attributes:
  • driver: The driver name to use.
  • database: The name of the database to use.
  • username: The user name used to authenticate.
  • password: The password used to authenticate.
  • host: The host address of the database.
  • port: The port to connect to the database.
  • query: A dictionary of string keys to string values to be passed to the dialect and/or the DBAPI upon connect.
Methods:

create_url

create_url(self) -> URL
Create a fully formed connection URL. Returns:
  • The SQLAlchemy engine URL.