Integrations — Aquilia Documentation
Comprehensive guide and documentation for Integrations in the Aquilia framework. View API reference, examples, and implementation patterns.
Integrations aquilia.integrations — typed subsystem configuration dataclasses Every subsystem in Aquilia is configured through a typed @dataclass — one class per concern. Each integration is passed to Workspace.integrate(), has __post_init__ validation, full IDE autocompletion, and a .to_dict() method that serialises into the format the runtime expects. How integrations work Import the typed dataclasses from aquilia.integrations and pass instances to .integrate(). The Workspace builder inspects the _integration_type field on each dataclass to route it to the correct subsystem. All available integrations Class Module Purpose ))} DatabaseIntegration Accepts either a url string or a typed config object (SqliteConfig, PostgresConfig). Controls the connection pool, auto-migration, and model scanning directories. Field Default Description )} AuthIntegration Configures JWT token signing, store backend, and session security policy. SessionIntegration Composable session config — a policy object defines TTL and idle behaviour, a store backend determines persistence, and a transport handles cookie or header delivery. All three default to sensible values when omitted. CacheIntegration Selects the cache backend and tunes the key settings, eviction policy, and optional two-tier (composite) caching. MailIntegration Supports SMTP, AWS SES, SendGrid, file-based, and console (dev) providers. MailAuth.plain() handles credentials; MailAuth.oauth2() handles OAuth2 flows. TasksIntegration Configures the background task worker pool — concurrency, retry policy, scheduler tick rate, and dead-letter queue size. OpenAPIIntegration Drives automatic OpenAPI spec generation and serves Swagger UI at /docs and ReDoc at /redoc. Security integrations CORS, CSRF, CSP, and rate-limiting are each separate integrations so you can tune them independently or disable any one without touching the others. TemplatesIntegration AdminIntegration Other integrations VectorDatabaseIntegration New in 1.4.0b3. Declares the elips-backed vector stores a workspace opens at boot. stores maps an alias to that store's settings, and an alias is what a VectorModel 's Meta.store names. Workspace.vectordb(...) is builder shorthand for the same thing. Outer values are defaults, not overrides Integration-level dimension, metric, index, gpu, embedder and quantization exist so the common case is declared once. A store that sets one explicitly wins. Declaring no stores at all but setting dimension builds a single default store from the outer values. path is a directory prefix rather than a URL — elips is embedded and single-writer per directory. Two stores cannot share a directory, and one store cannot serve two dimensions: elips holds dimension and metric database-global. ))} )
Go to Homepage