docs: ADR for alembic migrations #56
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @Ian2012! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
Ian2012
force-pushed
the
cag/alembic-migrations
branch
3 times, most recently
from
fb15024
to
78a3462
Compare
| Context | ||
| ******* | ||
|
|
||
| Alembic is a migration tool for SQLAlchemy. It is used to manage the clickhouse database |
| Alembic is a migration tool for SQLAlchemy. It is used to manage the clickhouse database | ||
| schema for the Aspects project. | ||
|
|
||
| Alembic has support for branching migrations and multiple databases, it creates a migrations |
There was a problem hiding this comment.
Can we add that it supports migration rollbacks too?
| the order in which migrations were created and executed. | ||
| #. Migrations cannot be modified once they are released to production. If a migration | ||
| needs to be modified, a new migration should be created with a new sequential ID. | ||
| #. The alembic migrations table is highly couple with the xAPI database, for this the |
There was a problem hiding this comment.
What do you think about adding different Alembic project for other databases (with their own co-located migrations table) like the event sink and vector?
nit: "highly couple" -> "highly coupled"
nit: "for this the" -> "for this reason the"
There was a problem hiding this comment.
I like it, it's better than my approach and would reflect the project's progress better
| ************ | ||
|
|
||
| * Users should not run migrations manually. They should be run automatically by Tutor | ||
| when the LMS is started. |
There was a problem hiding this comment.
nit: Maybe "when init is run, and at upgrade time"?
| Rejected Alternatives | ||
| ********************* | ||
|
|
||
| **Clickhouse SQL Alchemy Models** |
There was a problem hiding this comment.
We also rejected Django for this
Ian2012
force-pushed
the
cag/alembic-migrations
branch
from
78a3462
to
0841aea
Compare
|
@bmtcril ready |
Ian2012
force-pushed
the
cag/alembic-migrations
branch
from
0841aea
to
ad5ca03
Compare
|
@Ian2012 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Description
This PR adds documentation about the alembic migrations tool