docs: add complete alembic integration example - #1741
Open
pctablet505 wants to merge 5 commits into
Open
pctablet505 wants to merge 5 commits into
pctablet505 wants to merge 5 commits into
Conversation
pctablet505
marked this pull request as ready for review
July 17, 2026 12:47
Expand the migrations/Alembic docs with a working, end-to-end example: - Explain where the SQLAlchemy MetaData comes from in ormar and how to expose it for Alembic. - Add a sample project layout with my_project/models.py, alembic.ini, and alembic/env.py. - Show how to handle models split across multiple apps/packages by importing all models before Alembic reads the metadata. - Keep the existing compare_type and include_object tips intact. Fixes ormar-orm#1400
pctablet505
force-pushed
the
fix-1400-alembic-docs-example
branch
from
August 21, 2026 15:19
eecaa52 to
393859e
Compare
collerek
requested changes
Aug 27, 2026
pctablet505
force-pushed
the
fix-1400-alembic-docs-example
branch
from
September 3, 2026 06:07
4d4ca5b to
b495465
Compare
…ing, and package layouts - Trim duplicate model definitions in 'Where does metadata come from?' - Extract runnable models to docs_src/models/docs019.py via snippet syntax - Include standard logging sections in alembic.ini to prevent KeyError: 'formatters' - Add callout and driver comparison table explaining async vs sync URLs and alembic init -t async - Drop redundant prepend_sys_path from alembic.ini (env.py handles sys.path) - Pin db.sqlite path in alembic.ini using %(here)s to avoid cwd dependency - Add missing __init__.py files in multi-app package layout - Add noqa: E402 annotations to env.py snippets after sys.path manipulation - Retain explanatory comment on user_module_prefix matching sqlalchemy_module_prefix and normalize quotes
pctablet505
force-pushed
the
fix-1400-alembic-docs-example
branch
from
September 11, 2026 06:43
b495465 to
3da069a
Compare
Author
|
Hi @collerek, thanks for the review! All 7 points have been addressed in the branch:
Branch is rebased onto the latest |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1400.
The current Alembic docs skip too many steps for anyone new to ormar — imports, where
metadatacomes from, and how to handle models split across apps. I added a complete, working example based on the FastAPI-template reference linked in the issue.It covers a single-file layout, a multi-app layout, a minimal
alembic.ini, and wiring the sharedmetadataintoalembic/env.py. I ranalembic revision --autogenerateandalembic upgrade headagainst both layouts and built the docs withmkdocs buildto make sure everything works.