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

Update migrations.md #573

Merged
merged 1 commit into from
Dec 11, 2024
Merged

Update migrations.md #573

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
4 changes: 2 additions & 2 deletions docs/contributing/project-details/migrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

There are some important considerations to make when adding a feature with a db migration.

* DB Migrations also require publishing a new API version as the migrations also need to be applied there.
* DB Migrations will require publishing a new API version as the migrations also need to be applied there.

* The AQL Schema file will likely need to be updated to match any table changes.

* You must place your migration file in the `loot-core/migrations` folder, with a strict naming convention.

* The naming convention is as follows: `TIMESTAMP_name.sql`. for example. `1694438752000_add_goal_targets.sql`

* It is strongly discouraged to try to remove columns and tables, This makes reverting changes impossible and introduces unnecessary risk when we can simply stop using them in code.
* It is strongly discouraged to try to remove columns and tables. This makes reverting changes impossible and introduces unnecessary risk when we can simply stop using them in code.

* You should be very deliberate with your migration. When adding a feature, try to think about future scenarios and options that may be desired later, so we can minimize the number of migrations.
Loading