Migrasi Database dengan Jalur Terbang

1. Perkenalan

Artikel ini menjelaskan konsep utama Flyway dan bagaimana kita dapat menggunakan framework ini untuk terus merombak skema database aplikasi kita dengan andal dan mudah. Di bagian akhir, kami akan menyajikan contoh pengelolaan database H2 dalam memori menggunakan plugin Maven Flyway.

Flyway memperbarui database dari satu versi ke versi berikutnya menggunakan migrasi. Kami dapat menulis migrasi baik dalam SQL dengan sintaks khusus database atau di Java untuk transformasi basis data lanjutan.

Migrasi dapat diversi atau diulang. Yang pertama memiliki versi unik dan diterapkan tepat satu kali. Yang terakhir tidak memiliki versi. Sebaliknya, mereka (kembali) diterapkan setiap kali checksum mereka berubah.

Dalam satu migrasi yang dijalankan, migrasi berulang selalu diterapkan terakhir, setelah migrasi versi tertunda telah dijalankan. Migrasi berulang diterapkan dalam urutan deskripsinya. Untuk migrasi tunggal, semua pernyataan dijalankan dalam satu transaksi database.

Pada artikel ini, kami terutama berfokus pada bagaimana kami dapat menggunakan plugin Maven untuk melakukan migrasi database.

2. Plugin Flyway Maven

Untuk menginstal plugin Flyway Maven, mari tambahkan definisi plugin berikut ke pom.xml kami :

 org.flywaydb flyway-maven-plugin 4.0.3 

Kami dapat memeriksa versi terbaru dari plugin yang tersedia di Maven Central.

Plugin Maven ini dapat dikonfigurasi dengan empat cara berbeda. Silakan merujuk ke dokumentasi untuk mendapatkan daftar semua properti yang dapat dikonfigurasi.

2.1. Konfigurasi Plugin

Kami dapat mengkonfigurasi plugin secara langsung melalui tag dalam definisi plugin pom.xml kami :

 org.flywaydb flyway-maven-plugin 4.0.3  databaseUser databasePassword  schemaName  ...  

2.2. Properti Maven

Kami juga dapat mengkonfigurasi plugin dengan menentukan properti yang dapat dikonfigurasi sebagai properti Maven di pom kami:

 ...  databaseUser databasePassword schemaName ...  ... 

2.3. File Konfigurasi Eksternal

Kami juga dapat menyediakan konfigurasi plugin dalam file .properties terpisah :

flyway.user=databaseUser flyway.password=databasePassword flyway.schemas=schemaName ...

Nama file konfigurasi default adalah flyway.properties dan harus berada di direktori yang sama dengan file pom.xml . Encoding ditentukan oleh flyway.encoding (Default -nya UTF-8 ).

Jika Anda menggunakan nama lain (mis. CustomConfig.properties ) sebagai file konfigurasi, maka nama itu harus ditentukan secara eksplisit saat menjalankan perintah Maven:

$ mvn -Dflyway.configFile=customConfig.properties

2.4. Properti sistem

Terakhir, semua properti konfigurasi juga dapat ditetapkan sebagai properti sistem saat menjalankan Maven pada baris perintah:

$ mvn -Dflyway.user=databaseUser -Dflyway.password=databasePassword -Dflyway.schemas=schemaName

Berikut adalah urutan prioritas saat konfigurasi ditentukan dengan lebih dari satu cara:

  1. Properti sistem
  2. File konfigurasi eksternal
  3. Properti Maven
  4. Konfigurasi plugin

3. Contoh Migrasi

Di bagian ini, kami memandu langkah-langkah yang diperlukan untuk memigrasi skema database ke database H2 dalam memori menggunakan plugin Maven. Kami menggunakan file eksternal untuk mengkonfigurasi Jalur Terbang.

3.1. Perbarui POM

Pertama, mari tambahkan H2 sebagai ketergantungan:

 com.h2database h2 1.4.196 

Kami dapat, sekali lagi, memeriksa versi terbaru dari driver yang tersedia di Maven Central. Kami juga akan menambahkan plugin Flyway seperti yang dijelaskan sebelumnya.

3.2. Konfigurasi Jalur Terbang Menggunakan File Eksternal

Selanjutnya, kita membuat properti myFlywayConfig.properties di $ PROJECT_ROOT dengan konten berikut:

flyway.user=databaseUser flyway.password=databasePassword flyway.schemas=app-db flyway.url=jdbc:h2:mem:DATABASE flyway.locations=filesystem:db/migration

Konfigurasi di atas menetapkan bahwa skrip migrasi kami terletak di direktori db / migrasi . Ini terhubung ke instance H2 dalam memori menggunakan databaseUser dan databasePassword .

Skema database aplikasi adalah app-db .

Tentu saja, kami mengganti flyway.user, flyway.password, dan flyway.url dengan nama pengguna database kami sendiri, kata sandi database, dan URL database dengan tepat.

3.3. Tentukan Migrasi Pertama

Flyway mematuhi konvensi penamaan berikut untuk skrip migrasi:

__. sql

Dimana:

  • – Default prefix is V, which may be configured in the above configuration file using the flyway.sqlMigrationPrefix property.
  • – Migration version number. Major and minor versions may be separated by an underscore. The migration version should always start with 1.
  • – Textual description of the migration. The description needs to be separated from the version numbers with a double underscore.

Example: V1_1_0__my_first_migration.sql

So, let's create a directory db/migration in $PROJECT_ROOT with a migration script named V1_0__create_employee_schema.sql containing SQL instructions to create the employee table:

CREATE TABLE IF NOT EXISTS `employee` ( `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY, `name` varchar(20), `email` varchar(50), `date_of_birth` timestamp )ENGINE=InnoDB DEFAULT CHARSET=UTF8;

3.4. Execute Migrations

Next, we invoke the following Maven command from $PROJECT_ROOT to execute database migrations:

$ mvn clean flyway:migrate -Dflyway.configFile=myFlywayConfig.properties

This should result in our first successful migration.

The database schema should now be depicted as follows:

employee: +----+------+-------+---------------+ | id | name | email | date_of_birth | +----+------+-------+---------------+

We can repeat definition and execution steps to do more migrations.

3.5. Define and Execute Second Migration

Let's see what a second migration looks like by creating a second migration file with name V2_0_create_department_schema.sql containing the following two queries:

CREATE TABLE IF NOT EXISTS `department` ( `id` int NOT NULL AUTO_INCREMENT PRIMARY KEY, `name` varchar(20) )ENGINE=InnoDB DEFAULT CHARSET=UTF8; ALTER TABLE `employee` ADD `dept_id` int AFTER `email`;

We'll execute a similar migration like we did the first time.

And now, our database schema has changed to add a new column to employee and a new table:

employee: +----+------+-------+---------+---------------+ | id | name | email | dept_id | date_of_birth | +----+------+-------+---------+---------------+
department: +----+------+ | id | name | +----+------+

We may now verify that both migrations were indeed successful by invoking the following Maven command:

$ mvn flyway:info -Dflyway.configFile=myFlywayConfig.properties

4. Disabling Flyway in Spring Boot

Sometimes we may need to disable Flyway migrations under certain circumstances.

For example, it's a common practice to generate database schema based on the entities during tests. In such a situation, we can disable Flyway under the test profile.

Let's see how easy it is in Spring Boot.

4.1. Spring Boot 1.x

All we need to do is to set the flyway.enabled property in our application-test.properties file:

flyway.enabled=false

4.2. Spring Boot 2.x

In the more recent versions of Spring Boot, this property has been changed to spring.flyway.enabled:

spring.flyway.enabled=false

4.3 Empty FlywayMigrationStrategy

If we only want to disable automatic Flyway migration on startup, but still be able to trigger the migration manually, then using the properties described above isn't a good choice.

That's because in such a situation Spring Boot will not auto-configure the Flyway bean anymore. Consequently, we'd have to provide it on our own which isn't very convenient.

So if this is our use case, we can leave Flyway enabled and implement an empty FlywayMigrationStrategy:

@Configuration public class EmptyMigrationStrategyConfig { @Bean public FlywayMigrationStrategy flywayMigrationStrategy() { return flyway -> { // do nothing }; } }

This will effectively disable Flyway migration on application startup.

But we'll still be able to trigger the migration manually:

@RunWith(SpringRunner.class) @SpringBootTest public class ManualFlywayMigrationIntegrationTest { @Autowired private Flyway flyway; @Test public void skipAutomaticAndTriggerManualFlywayMigration() { flyway.migrate(); } }

5. How Flyway Works

To keep track of which migrations have already been applied, when and by whom, it adds a special bookkeeping table to your schema. This metadata table also tracks migration checksums and whether or not the migrations were successful.

The framework performs the following steps to accommodate evolving database schemas:

  1. It checks a database schema to locate its metadata table (SCHEMA_VERSION by default). If the metadata table does not exist, it will create one
  2. It scans an application classpath for available migrations
  3. It compares migrations against the metadata table. If a version number is lower or equal to a version marked as current, it is ignored
  4. It marks any remaining migrations as pending migrations. These are sorted based on version number and are executed in order
  5. As each migration is applied, the metadata table is updated accordingly

6. Commands

Flyway supports the following basic commands to manage database migrations.

  • Info: Prints current status/version of a database schema. It prints which migrations are pending, which migrations have been applied, what is the status of applied migrations and when they were applied.
  • Migrate: Migrates a database schema to the current version. It scans the classpath for available migrations and applies pending migrations.
  • Baseline: Baselines an existing database, excluding all migrations, including baselineVersion. Baseline helps to start with Flyway in an existing database. Newer migrations can then be applied normally.
  • Validasi : Memvalidasi skema database saat ini terhadap migrasi yang tersedia.
  • Perbaikan : Memperbaiki tabel metadata.
  • Bersihkan : Menjatuhkan semua objek dalam skema yang dikonfigurasi. Semua objek database dijatuhkan. Tentu saja, Anda tidak boleh menggunakan clean pada database produksi apa pun.

7. Kesimpulan

Dalam artikel ini, kami telah menunjukkan cara kerja Flyway dan bagaimana kami dapat menggunakan kerangka kerja ini untuk merombak database aplikasi kami dengan andal.

Kode yang menyertai artikel ini tersedia di GitHub.