Skip to content

Commit

Permalink
Update migrations.md (#573)
Browse files Browse the repository at this point in the history
punctuation
  • Loading branch information
bpaulien authored Dec 11, 2024
1 parent b590d68 commit d23eb40
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/contributing/project-details/migrations.md
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.

0 comments on commit d23eb40

Please sign in to comment.