We currently use CockroachDB as our database, In order to facilate our database migrations we have opted to use go-migrate. This allows us to keep schema changes in an ordered manner.
$ make
help: Show help for each of the Makefile recipes
migration: Create a new migration file [name: required]
seed: Create new seed file [name: required]
test-db: Runs a test db used for the API tests In order to create a new migration run:
make migration name=$MIGRATION_NAMEA small note on this command, as we use docker and docker volumes to generate this, there is a good change the files will be created in a read only mode (specifically if you are using a linux machine). You will need to save them with sudo or admin
You will find a new migration file in the migrations directory. Please make sure to create the UP and DOWN (rollback) migrations as well as keep in mind that all migrations should try to be idempotent and backwards compatible
In order to create a new seed run:
make seed name=$MIGRATION_NAMEA small note on this command, as we use docker and docker volumes to generate this, there is a good change the files will be created in a read only mode (specifically if you are using a linux machine). You will need to save them with sudo or admin
You will find a new seed file in the seeds directory. Please be mindful to fill in the UP and DOWN files, UP should create the seed and DOWN should delete the seeds.