kajenn-db documentation

kajenn-db provides the database handlers of the kajenn ASGI server. A handler connects a database library to kajenn: each call (request, task, message) gets its own database session, and kajenn closes it when the call ends.

kajenn itself never imports a database driver. A site declares its databases with a handler class; this package provides those classes.

Handler	Library	Sync routes	Async routes	Migrations	Status
AsqueelDbHandler	asqueel 0.9	yes	yes	yes	supported
SqlAlchemyDbHandler	SQLAlchemy 2	yes	yes	no	probe
DjangoDbHandler	Django 4.2+	yes	no	yes	probe

• supported: the handler meant for real applications.

• probe: a handler written to check that kajenn’s handler contract works on a library other than asqueel. It implements the contract and nothing more, and its limits are deliberate. Each backend guide lists them.

New here? Start with Getting started, then read How a handler works.

Getting started

• Getting started
  • Install
  • Declare the tables
  • Create the tables
  • Declare the site
  • Run it
  • Next
• How a handler works
  • One handler per class
  • Database names
  • One object per name per call
  • Release at the end of the call
  • Async routes
  • Migrations
  • Probes

Backend guides

• Backend guides
  • asqueel
  • SQLAlchemy
  • Django

API reference

• API reference
  • kajenn_db.asqueel
  • kajenn_db.sqlalchemy
  • kajenn_db.django

Project

• Contributing
• Changelog

Indices and tables

• Index

• Module Index

• Search Page