tylerthome
commented
3 months ago Related to #607 Recommend moving to ice box until Incubator integration established, the parameters for this solution will hinge on implementation details coordinated with ops/incubator admins
Dependencies
Overview
The API
alembicdatabase migrations are not run when starting up the API docker container. Without database migrations, future database developments could break when new API changes are introduced and tested using docker compose and existing data.alembicis a database migration tool. It is an API core dependency and included in your Python virtual environment.A database migration is a necessary step in the API deployment to allow existing data to continue to be available in an updated database schema. For example, say the
usertable contains existing data and a new version of the API creates new tablesguest,coordinator, andhosttables. These new tables will need to be populated with IDs of existing users. This is where an alembic migration script comes into play. When the new version of the API is developed, an alembic migration script should also be included to populate the new tables with existing data. During the docker API startup, the alembic database migration tool ought to be used to run the migration script to update the existing database, if any, so that the new version of the API can continue to use the existing data correctly.This issue will use knowledge about Docker, alembic, SQLAlchemy, PostgreSQL.
Action Items
alembicdatabase migration tool and where database migration scripts are stored in the API code.Dockerfileas necessary to perform database migrations in the Postgres database container.READMEfiles.Resources/Instructions
alembicis a database migration tool. It is an API core dependency and included in your Python virtual environment. After entering a Python virtual environment containing the API's dependencies. Thealembictool can be run from the command line.https://alembic.sqlalchemy.org/en/latest/ https://docs.docker.com/engine/reference/builder/