LIN-381 database migration script #704
Merged
Conversation
This file contains 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
joshpoll
changed the title
|
To clarify, where should I put the user-facing docs? In the main readme (and if so where) or somewhere else? |
lionsardesai
reviewed
Jul 5, 2022
lionsardesai
reviewed
Jul 5, 2022
lionsardesai
reviewed
Jul 5, 2022
lionsardesai
reviewed
Jul 5, 2022
…c use our databaseurl. also set the default options on config init instead of waiting for cli to call for defaults.
…ence to the alembic doc for details. [skip ci]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Implements database migration using alembic.
Fixes LIN-381 and LIN-471
(For Lineapy users) To upgrade a Lineapy database
Nothing! When you use a lineapy db it will be upgraded automatically.
(For Lineapy developers) To create a migration
Run
alembic revision -m "<description of change>". This will generate a migration template in thealembic/versionsdirectory.Then implement the migration scripts using the
alembicpackage in the the bodies of theupgradeanddowngradefunctions.See https://alembic.sqlalchemy.org/en/latest/tutorial.html#create-a-migration-script for more information.
Alternately, we can also use alembic's autogeneration feature and run
alembic revision --autogenerate -m "<description of change>". More details at: https://alembic.sqlalchemy.org/en/latest/autogenerate.htmlNote: The alembic version of a DB is stored in the
alembic_versiontable, which has a single column namedversion_num.Type of change
How Has This Been Tested?
Currently I have tested this by running a small example migration that adds a python version to the table, and I have run the CLI to upgrade it. I have not yet created more involved tests.