Database Adapters¶
Curated API reference for all SQLSpec database adapters (sqlspec.adapters.*). Each adapter page documents its own configuration class(es), TypedDict connection and pool parameter schemas, DriverFeatures flags, driver adapter class(es), and extension stores (litestar, adk, events) while linking inherited execution methods directly to SyncDriverAdapterBase and AsyncDriverAdapterBase.
PostgreSQL & CockroachDB¶
| Adapter Module | Reference Page | Config Classes | Driver Classes | Setup Guide |
|---|---|---|---|---|
sqlspec.adapters.asyncpg |
asyncpg | AsyncpgConfig |
AsyncpgDriver |
PostgreSQL (asyncpg) |
sqlspec.adapters.psycopg |
psycopg | PsycopgSyncConfig, PsycopgAsyncConfig |
PsycopgSyncDriver, PsycopgAsyncDriver |
PostgreSQL (psycopg) |
sqlspec.adapters.psqlpy |
psqlpy | PsqlpyConfig |
PsqlpyDriver |
PostgreSQL (psqlpy) |
sqlspec.adapters.cockroach_asyncpg |
cockroach-asyncpg | CockroachAsyncpgConfig |
CockroachAsyncpgDriver |
CockroachDB |
sqlspec.adapters.cockroach_psycopg |
cockroach-psycopg | CockroachPsycopgSyncConfig, CockroachPsycopgAsyncConfig |
CockroachPsycopgSyncDriver, CockroachPsycopgAsyncDriver |
CockroachDB |
SQLite, MySQL & MariaDB¶
| Adapter Module | Reference Page | Config Classes | Driver Classes | Setup Guide |
|---|---|---|---|---|
sqlspec.adapters.sqlite |
sqlite | SqliteConfig |
SqliteDriver |
SQLite |
sqlspec.adapters.aiosqlite |
aiosqlite | AiosqliteConfig |
AiosqliteDriver |
SQLite |
sqlspec.adapters.asyncmy |
asyncmy | AsyncmyConfig |
AsyncmyDriver |
MySQL & MariaDB |
sqlspec.adapters.aiomysql |
aiomysql | AiomysqlConfig |
AiomysqlDriver |
MySQL & MariaDB |
sqlspec.adapters.pymysql |
pymysql | PyMysqlConfig |
PyMysqlDriver |
MySQL & MariaDB |
sqlspec.adapters.mysqlconnector |
mysqlconnector | MysqlConnectorSyncConfig, MysqlConnectorAsyncConfig |
MysqlConnectorSyncDriver, MysqlConnectorAsyncDriver |
MySQL & MariaDB |
Enterprise & Relational Databases¶
| Adapter Module | Reference Page | Config Classes | Driver Classes | Setup Guide |
|---|---|---|---|---|
sqlspec.adapters.oracledb |
oracledb | OracleSyncConfig, OracleAsyncConfig |
OracleSyncDriver, OracleAsyncDriver |
Oracle Database |
sqlspec.adapters.mssql_python |
mssql-python | MssqlPythonConfig |
MssqlPythonDriver |
SQL Server |
sqlspec.adapters.pymssql |
pymssql | PymssqlConfig |
PymssqlDriver |
SQL Server |
sqlspec.adapters.sybase |
sybase | SybaseConfig |
SybaseDriver |
Sybase ASE |
sqlspec.adapters.sqlanywhere |
sqlanywhere | SqlanywhereConfig |
SqlanywhereDriver |
SAP SQL Anywhere |
sqlspec.adapters.snowflake |
snowflake | SnowflakeConfig |
SnowflakeDriver |
Snowflake |
sqlspec.adapters.db2 |
db2 | Db2SyncConfig, Db2AsyncConfig |
Db2SyncDriver, Db2AsyncDriver |
IBM Db2 |
sqlspec.adapters.teradata |
teradata | TeradataConfig |
TeradataDriver |
Teradata Vantage |
Cloud, Analytics & Arrow Connectors¶
| Adapter Module | Reference Page | Config Classes | Driver Classes | Setup Guide |
|---|---|---|---|---|
sqlspec.adapters.duckdb |
duckdb | DuckDBConfig |
DuckDBDriver |
DuckDB |
sqlspec.adapters.bigquery |
bigquery | BigQueryConfig |
BigQueryDriver |
BigQuery |
sqlspec.adapters.spanner |
spanner | SpannerSyncConfig, SpannerAsyncConfig |
SpannerSyncDriver, SpannerAsyncDriver |
Cloud Spanner |
sqlspec.adapters.adbc |
adbc | AdbcConfig |
AdbcDriver |
ADBC |
sqlspec.adapters.arrow_odbc |
arrow-odbc | ArrowOdbcConfig |
ArrowOdbcDriver |
Arrow ODBC |