Discharge7443/fleet
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

Docs editor pass - Contributing - Migrations (#5959)

Browse Source 
This has been edited for content and copy.
This commit is contained in:
Desmi-Dizney
2022-05-31 09:50:18 -04:00
committed by GitHub
parent 283302c595
commit b12a942cc1
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Contributing/Migrations.md
+7 -7
View File
@@ -6,13 +6,13 @@
## Adding/Updating tables
Database schemas are managed by a series of migrations defined in go code. We use a customized version of the Goose migrations tool to handle these migrations.
We manage database schemas by a series of migrations defined in go code. We use a customized version of the Goose migrations tool to handle these migrations.
Note: Once committed to the Fleet repo, table migrations should be considered immutable. Any changes to an existing table should take place in a new migration executing ALTERs.
Note: Table migrations should be considered immutable once committed to the Fleet repo. Any changes to an existing table should occur in a new migration executing ALTERs.
Also note that we don't use the `Down` part of the migrations anymore (older migrations did implement them). The `Down` function should just `return nil`, as we use forward-only migrations.
Also, note that we don't use the `Down` part of the migrations anymore (older migrations did implement them). The `Down` function should just `return nil`, as we use forward-only migrations.
From the project root run the following shell command:
From the project root, run the following shell command:
``` bash
make migration name=NameOfMigration
@@ -31,11 +31,11 @@ make fleet
Note: This pattern will soon be changing. Please check with @zwass if you think you need to write a data migration.
Populating built in data is also performed through migrations. All table migrations are performed before any data migrations.
Populating built-in data is also performed through migrations. All table migrations are performed before any data migrations.
Note: Data migrations can be mutable. If tables are altered in a way that would render a data migration invalid (columns changed/removed), data migrations should be updated to comply with the new schema. Data migrations will not be re-run when they have already been run against a database, but they must be updated to maintain compatibility with a fresh DB.
From the project root run the following shell command:
From the project root, run the following shell command:
``` bash
make migration name=NameOfMigration
@@ -45,4 +45,4 @@ Move the migration file from [server/datastore/mysql/migrations/tables/](../../s
Proceed as for table migrations, editing and running the newly created migration file.
<meta name="pageOrderInSection" value="300">
<meta name="pageOrderInSection" value="300">