tyler/cyclone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(backend): update db.py docstring to reflect migrations-first order

Browse Source
This commit is contained in:
Tyler
2026-06-19 21:36:26 -06:00
parent 5be6299b3a
commit 0fdb760bc1
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/src/cyclone/db.py
+4 -3
View File
@@ -2,9 +2,10 @@
`init_db()` is called from `cyclone.__main__:serve` before uvicorn starts. `init_db()` is called from `cyclone.__main__:serve` before uvicorn starts.
It reads `CYCLONE_DB_URL` (default `sqlite:///~/.local/share/cyclone/cyclone.db`), It reads `CYCLONE_DB_URL` (default `sqlite:///~/.local/share/cyclone/cyclone.db`),
creates the engine, runs `Base.metadata.create_all`, then runs the migration creates the engine, runs the migration runner, then runs `Base.metadata.create_all`
runner. Calling `init_db()` is idempotent — calling it twice on the same URL as a safety net (which is a no-op when the migration is current). Calling
re-uses the same engine. `init_db()` is idempotent — calling it twice on the same URL re-uses the
same engine.
""" """
from __future__ import annotations from __future__ import annotations