Merged
Conversation
Closed
agorajek
approved these changes
Oct 13, 2022
Member
agorajek
left a comment
agorajek
left a comment
There was a problem hiding this comment.
One nit and one question in-line. Thanks @betodealmeida this PR will be very helpful for me.
CONTRIBUTING.rst
Outdated
| Database migrations | ||
| =================== | ||
|
|
||
| We use `Alembic <https://alembic.sqlalchemy.org/en/latest/index.html>`_ to manage schema migrations. If a PR introduces new models are changes existing ones a migration must be created. |
| @@ -0,0 +1,203 @@ | |||
| """Update schema types | |||
Member
There was a problem hiding this comment.
What's the goal of this update?
Member
Author
There was a problem hiding this comment.
I just ran alembic revision --autogenerate without any changes to the model. All the changes you see here are because of the upgrade in sqlmodel. This way, when we add a new migration (and I'm planning to because of #193) we'll see only relevant changes.
youngman-droid
pushed a commit
to youngman-droid/dj
that referenced
this pull request
Aug 26, 2023
docs: DB migration docs
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.
Summary
This PR adds documentation on how to create new DB migrations.
I also created a new migration (following the process outlined in the docs) to update the DB schema to the DJ models, after upgrading
sqlmodelin #220.Test Plan
make checkpassesmake testshows 100% unit test coverageDeployment Plan
Needs a DB migration.