Installation¶
Install the core package when you need the in-memory queue backend, immediate execution, local workers, task registration, and Litestar plugin lifecycle support:
pip install litestar-queues
Optional Backends¶
Install backend extras only for the integrations an application uses:
Extra |
Enables |
Notes |
|---|---|---|
|
SQLSpec queue persistence |
Installs SQLSpec with the Aiosqlite extra. Install additional SQLSpec adapter drivers in the application when you use them. |
|
Advanced Alchemy queue persistence |
Uses application-owned SQLAlchemy configuration or session makers. |
|
Redis queue persistence |
Imports the Redis client only when opening the Redis backend without an injected client. |
|
Valkey queue persistence |
Imports the Valkey client only when opening the Valkey backend without an injected client. |
|
Cloud Run execution |
Dispatches persisted queue records to Cloud Run Jobs. |
pip install litestar-queues[sqlspec]
pip install litestar-queues[advanced-alchemy]
pip install litestar-queues[redis]
pip install litestar-queues[valkey]
pip install litestar-queues[cloudrun]
Extras can be combined when a deployment needs multiple integrations:
pip install "litestar-queues[sqlspec,cloudrun]"
Optional Import Boundaries¶
The package registers optional backend names without importing their external client libraries from package root or shared backend import paths. Opening an optional backend requires either the matching extra or an injected client/config object supplied by the application.
This keeps a core installation usable for tests and simple local workers while allowing production deployments to choose SQLSpec adapters, Advanced Alchemy, Redis, Valkey, or Cloud Run independently.