Skip to main content

v2 Database Migration

Vendure v2 introduces a number of breaking changes to the database schema, some of which require quite complex migrations in order to preserve existing data. To make this process as smooth as possible, we have created a migration tool which will handle the hard parts for you!

warning

Important! It is critical that you back up your production data prior to attempting this migration.

Note for MySQL/MariaDB users: transactions for migrations are not supported by these databases. This means that if the migration fails for some reason, the statements that have executed will not get rolled back, and your DB schema can be left in an inconsistent state from which is it can be hard to recover. Therefore, it is doubly critical that you have a good backup that you can easily restore prior to attempting this migration.

  1. Make sure all your Vendure packages to the latest v2 versions.

  2. Use your package manager to install the v2 migration tool: npm install @vendure/migrate-v2

    • Note, if you run into the error "Cannot find module '@ardatan/aggregate-error'", delete node_modules and the lockfile and reinstall.

  3. Add the MigrationV2Plugin to your plugins array:

    import { MigrationV2Plugin } from '@vendure/migrate-v2';

    //...
    const config: VendureConfig = {
      //..
      plugins: [
        MigrationV2Plugin,
      ]
    }

    The sole function of this plugin is to temporarily remove some "NOT NULL" constraints from certain columns, which allows us to run the next part of the migration.

  4. Generate a new migration file, npm run migration:generate v2

  5. Edit the newly-created migration file by following the comments in these examples:

    In your migrations files, you'll import the vendureV2Migrations from @vendure/migrate-v2.

  6. Run the migration with npm run migration:run.

  7. Upon successful migration, remove the MigrationV2Plugin from your plugins array, and generate another migration. This one will add back the missing "NOT NULL" constraints now that all your data has been successfully migrated.