prefect_sqlalchemy.credentials

Credential classes used to perform authenticated interactions with SQLAlchemy

Classes

AsyncDriver ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/credentials.py#L10" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Known dialects with their corresponding async drivers.

Attributes:

• POSTGRESQL_ASYNCPG: postgresql+asyncpg
• SQLITE_AIOSQLITE: sqlite+aiosqlite
• MYSQL_ASYNCMY: mysql+asyncmy
• MYSQL_AIOMYSQL: mysql+aiomysql
• ORACLE_ORACLEDB_ASYNC: oracle+oracledb_async

SyncDriver ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/credentials.py#L35" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Known dialects with their corresponding sync drivers.

Attributes:

• POSTGRESQL_PSYCOPG2: postgresql+psycopg2
• POSTGRESQL_PG8000: postgresql+pg8000
• POSTGRESQL_PSYCOPG2CFFI: postgresql+psycopg2cffi
• POSTGRESQL_PYPOSTGRESQL: postgresql+pypostgresql
• POSTGRESQL_PYGRESQL: postgresql+pygresql
• MYSQL_MYSQLDB: mysql+mysqldb
• MYSQL_PYMYSQL: mysql+pymysql
• MYSQL_MYSQLCONNECTOR: mysql+mysqlconnector
• MYSQL_CYMYSQL: mysql+cymysql
• MYSQL_OURSQL: mysql+oursql
• MYSQL_PYODBC: mysql+pyodbc
• SQLITE_PYSQLITE: sqlite+pysqlite
• SQLITE_PYSQLCIPHER: sqlite+pysqlcipher
• ORACLE_CX_ORACLE: oracle+cx_oracle
• ORACLE_ORACLEDB: oracle+oracledb
• MSSQL_PYODBC: mssql+pyodbc
• MSSQL_MXODBC: mssql+mxodbc
• MSSQL_PYMSSQL: mssql+pymssql

ConnectionComponents ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/credentials.py#L88" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/integrations/prefect-sqlalchemy/prefect_sqlalchemy/credentials.py#L130" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

create_url(self) -> URL

Create a fully formed connection URL.

Returns:

• The SQLAlchemy engine URL.