https://github.com/serlo/db-migrations
https://github.com/serlo/db-migrations
database-migrations serlo service
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/serlo/db-migrations
- Owner: serlo
- License: apache-2.0
- Archived: true
- Created: 2023-01-16T20:11:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T11:01:26.000Z (almost 2 years ago)
- Last Synced: 2025-04-05T01:33:49.236Z (about 1 year ago)
- Topics: database-migrations, serlo, service
- Language: TypeScript
- Size: 423 MB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Repo deprecated: code was moved to `serlo/api.serlo.org`
# DB migrations
particularly for the legacy database
## Prerequisites
- [Node.js](https://nodejs.org/) and [yarn cli](https://yarnpkg.com/cli/)
versions from [.tool-versions](.tool-versions)
- You may use [asdf](https://asdf-vm.com/) for the installation.
- Docker and Docker Compose
Note: Also make sure you have `cmake` installed on your machine (e.g.
`sudo apt install cmake`).
## Add a new migration
1. Run `yarn new` to create a new file with the migration timestamp. You can
copy and paste one of the existing migrations as a template for the new one.
Example:
- [`src/20220614111600-make-subjects-in-construction-a-subject.ts`](./src/20220614111600-make-subjects-in-construction-a-subject.ts)
when you just want to execute SQL statements.
- [`src/20210923231900-add-transformation-target-to-equations.ts`](./src/20210923231900-add-transformation-target-to-equations.ts)
when you want to migrate edtr-io plugins
2. You need to build a migration by running
`yarn build src/YYYYMMDDHHMMSS-xyz.ts` in the `src` directory. This creates a
new file in `migrations`. Both files in `migrations` and `src` need to be
added in the PR. _Notice that any changes in other directories that are
imported by the file will be built together!_
## Test a new migration
Start a local version of the mysql database via `yarn start`. There are the
following helper functions:
- `yarn mysql` – Open a shell to MySQL
- `yarn migrate:run [path]` – Run a certain migration (like
`yarn migrate:run src/20201023104526-update-subjects.ts`)
- `yarn migrate:down` – Run the down function of the migrations that were run
- `yarn mysql:rollback` – Rollback database before any applied migrations
- `yarn mysql:list-migrations` – List all migrations which have been already run
- `yarn migrate:ts` – Run all migrations directly from `src` directory (no build
needed)
- `yarn migrate:docker` – Build docker container and run migrations
- `yarn mysql:delete-last-migration` – Delete information that last migration
was already executed (will be thus executed the next time again)
- `yarn mysql:import-anonymous-data` – Import last anonymized dump
### Test on staging
Once it seems to work as desired locally, it can be deployed to staging and will
then be run every night after the new anonymous data import. If you then find an
error and want to deploy a fixed version of the migration, run the `dbsetup` job
on the staging cluster to undo the changes of the erroneous migration first
before deploying the fixed version of `db-migrations`.
### Deployment
Before running `yarn push-image`, make sure that you are authenticated with
gcloud and have run `gcloud auth configure-docker`.