Migrations

• Commands
• Versioned Migrations
  • Explanation
  • Naming Scheme
    • Requirements
    • Examples
• Repeatable Migrations
  • Explanation
  • Requirements
  • Examples

Commands

To migrate your local database using your root .env, you can simply run:

just migrate

Versioned Migrations

Note

Versioned migrations are applied to all databases

Explanation

• Versioned migrations will only run once.
• You can use these migrations to define tables, schemas, columns (otherwise known as DDL) OR define insertions/updates/deletes of certain columns (otherwise known as DML).

  If you need to generate mock data that does not need to be in production, please look at the docs on repeatable migrations.

Naming Scheme

Requirements

V00{number}__{description}.SQL

1. Name must be prefixed with a V.
2. Version numbers must be sequential and unique.
   • Version numbers must be 4 digits wide. You may pad the left-side with 0s until you reach that goal.
3. Double underscores (__) separate the version from the description
4. Use underscores (_) instead of spaces in descriptions
5. Files must have .sql (or .SQL) extension

Examples

V0005__Add_user_table.SQL
V0642__Insert_new_tag_enums.SQL
V9999__Delete_user_table.SQL

Repeatable Migrations

Note

Repeatable migrations are only applied to local & CI databases.
Repeatable migrations are NOT applied to the production & staging database.

Explanation

1. Instead of being run just once, repeatable migrations are (re-)applied to a database on migrate every time their checksum changes.
2. Our main use for repeatable migrations are to generate mock data to use locally and in our CI database, but is not needed for our production or staging database.

Requirements

1. Name must be prefixed with an R__Mock
2. Version numbers must be sequential and unique
3. Use underscores (_) instead of spaces in descriptions
4. Files must have .sql (or .SQL) extension

Examples

R__Mock_V0005_Insert_mock_users.SQL
R__Mock_V0011_Add_old_leaderboards.SQL
R__Mock_V9999_Delete_old_mock_users_and_insert_new_users.SQL