Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keep doc up-to-date with changes #13667

Merged
merged 1 commit into from
Jun 13, 2022
Merged

Keep doc up-to-date with changes #13667

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions airbyte-db/db-lib/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Check `io.airbyte.db.instance.configs` for example.

# How to Write a Migration
- Run the `newMigration` command to create a new migration file in `io.airbyte.db.instance.<db-name>.migrations`.
- Configs database: `./gradlew :airbyte-db:lib:newConfigsMigration`.
- Jobs database: `./gradlew :airbyte-db:lib:newJobsMigration`.
- Configs database: `./gradlew :airbyte-db:db-lib:newConfigsMigration`.
- Jobs database: `./gradlew :airbyte-db:db-lib:newJobsMigration`.
- Write the migration using [`jOOQ`](https://www.jooq.org/).
- Use the `runMigration` command to apply your newly written migration if you want to test it.
- Configs database: `./gradlew :airbyte-db:lib:runConfigsMigration`.
- Jobs database: `./gradlew :airbyte-db:lib:runJobsMigration`.
- Configs database: `./gradlew :airbyte-db:db-lib:runConfigsMigration`.
- Jobs database: `./gradlew :airbyte-db:db-lib:runJobsMigration`.
- Run the `dumpSchema` command to update the database schema.
- Configs database: `./gradlew :airbyte-db:lib:dumpConfigsSchema`
- Jobs database: `./gradlew :airbyte-db:lib:dumpJobsSchema`
- Configs database: `./gradlew :airbyte-db:db-lib:dumpConfigsSchema`
- Jobs database: `./gradlew :airbyte-db:db-lib:dumpJobsSchema`

## Migration Filename
- The name of the file should follow this pattern: `V(version)__(migration_description_in_snake_case).java`.
Expand Down