Writing upgrade scripts
- Don't modify an existing script once it's committed, flyway calculates checksum for scripts so any change in existing script will result in a migration error.
- Don't link tables between migration modules. Modules are considered to be standalone and constraints between them are likely to cause problems.
- Be very careful when doing updates to database content. Other than registering new bundles to portti_bundle almost any content-related updated should be done in an application module. F.ex. adding bundles to views etc are application specific updates.
- Make sure the upgrade scripts have proper error handling. Database environments may vary as the content in the database. It's always better to check things instead of assuming.
- Keep upgrade scripts small. The smaller they are the less can go wrong.
File naming is important since migration scripts are located and versioned by naming conventions:
- the names should start with capital
- followed by
versionnumber that is greater than any existing script version and based on the Oskari/module/application version
- version and description is separated by double-underscore
- for SQL scripts the file extension is
.sqland saved in a folder
- for Java upgrades the package needs to be
flyway.[module] where core Oskari upgrades are
In a basic maven setup this will result in files like these:
Existing scripts can be found in Github:
- SQL: https://github.com/oskariorg/oskari-server/tree/develop/content-resources/src/main/resources/flyway
- Java: https://github.com/oskariorg/oskari-server/tree/develop/content-resources/src/main/java/flyway
Application-specific upgrade example:
- Java: https://github.com/arctic-sdi/oskari-server-extensions/tree/develop/server-extension/src/main/java/flyway/asdi
Note the script locations can be changed by configuration as described in the Upgrading document.
For more information:
- Upgrading document
- Flyway documentation: http://flywaydb.org/
- The database migration is triggered in class fi.nls.oskari.map.servlet.OskariContextInitializer (under oskari-server/servlet-map).
Last modified: Mon May 24 2021 18:10:51 GMT+0300 (Eastern European Summer Time)