API Reference#
Auto-generated documentation from source code docstrings. Private methods and attributes are excluded.
Getting Started#
Main entry point for SQLSpec. Configure databases and manage sessions.
Base config classes: AsyncDatabaseConfig, SyncDatabaseConfig, NoPoolConfig.
Database Layer#
Adapter implementations for PostgreSQL, SQLite, DuckDB, MySQL, Oracle, and more.
Base driver classes and mixins for sync/async database operations.
Query Building#
Fluent API for building SQL queries: SELECT, INSERT, UPDATE, DELETE, DDL.
Immutable multi-statement execution with native pipelines.
Custom sqlglot dialects for pgvector, ParadeDB, and Spanner extensions.
Core Infrastructure#
Statement processing, parameters, results, filters, cache, and query modifiers.
Load and cache SQL files with named statement support.
Full exception hierarchy with SQLSTATE mapping.
Operations#
Migration runners, commands, trackers, loaders, and squashing.
Storage pipelines, backends, and Arrow table export/import.
Telemetry, logging, diagnostics, and Prometheus integration.
Integrations#
Integration modules for Litestar, FastAPI, Flask, Starlette, and Google ADK.
Type aliases, metadata types, feature flags, and driver protocols.
Type guards, environment parsing, UUIDs, module loading, and sync/async helpers.
