docs: add complete alembic integration example - #1741
Open
pctablet505 wants to merge 2 commits into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
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
eecaa52 to
393859e
Compare
August 21, 2026 15:19
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
1 participant
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 metadata comes 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 shared metadata into alembic/env.py. I ran alembic revision --autogenerate and alembic upgrade head against both layouts and built the docs with mkdocs build to make sure everything works.