Extensions Reference¶
API reference for SQLSpec's framework plugins, Google ADK stores, real-time event channels, OpenTelemetry tracing, and Prometheus metrics. For setup examples and architectural walkthroughs, see the Integrations Guide.
Extension Modules¶
| Public Import Path | Reference Page | Summary |
|---|---|---|
sqlspec.extensions.litestar |
Litestar Extension | SQLSpecPlugin, CommitMode, CorrelationMiddleware, BaseSQLSpecStore, and SQLSpecChannelsBackend. |
sqlspec.extensions.adk |
Google ADK Extension | SQLSpecSessionService, SQLSpecMemoryService, SQLSpecArtifactService, base stores, and maintenance helpers. |
sqlspec.extensions.events |
Events & Channels Extension | SyncEventChannel, AsyncEventChannel, EventMessage, SyncTableEventQueue, AsyncTableEventQueue, and BaseEventQueueStore. |
sqlspec.extensions.fastapi |
FastAPI Extension | SQLSpecPlugin, provide_filters, FilterConfig, and DependencyDefaults. |
sqlspec.extensions.starlette |
Starlette Extension | SQLSpecPlugin, SQLSpecAutocommitMiddleware, SQLSpecManualMiddleware, and request session helpers. |
sqlspec.extensions.flask |
Flask Extension | SQLSpecPlugin and FlaskConfigState for WSGI request-scoped sessions and async portal bridging. |
sqlspec.extensions.sanic |
Sanic Extension | SQLSpecPlugin, SanicConfigState, and request context session helpers. |
sqlspec.extensions.otel |
OpenTelemetry Extension | enable_tracing helper for configuring ObservabilityConfig with OpenTelemetry spans. |
sqlspec.extensions.prometheus |
Prometheus Extension | PrometheusStatementObserver and enable_metrics for statement counter and histogram export. |