flyway-migrations
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseFlyway Migration Patterns
Flyway迁移模式
Naming Convention
命名规范
V{version}__{description}.sql
Examples:
V001__create_environment_table.sql
V002__add_status_column.sql
V003__create_index_on_name.sql
V010__add_labels_jsonb.sql
V011__data_migration_normalize_status.sqlRules:
- Version: Padded numbers (001, 002... or 1.0.0, 1.0.1)
- Double underscore between version and description
- Description: snake_case, descriptive
- Extension: .sql
V{version}__{description}.sql
Examples:
V001__create_environment_table.sql
V002__add_status_column.sql
V003__create_index_on_name.sql
V010__add_labels_jsonb.sql
V011__data_migration_normalize_status.sql规则:
- 版本:使用带前导零的数字(001、002... 或 1.0.0、1.0.1)
- 版本与描述之间用双下划线分隔
- 描述:采用蛇形命名法(snake_case),表述清晰
- 扩展名:.sql
Basic Table Creation
基础表创建
sql
-- V001__create_environment_table.sql
CREATE TABLE environment (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
name VARCHAR(100) NOT NULL,
description TEXT,
status VARCHAR(50) NOT NULL DEFAULT 'PENDING',
owner_id UUID NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
updated_at TIMESTAMP WITH TIME ZONE,
CONSTRAINT uk_environment_name UNIQUE (name),
CONSTRAINT fk_environment_owner FOREIGN KEY (owner_id)
REFERENCES users(id) ON DELETE CASCADE
);
-- Indexes
CREATE INDEX idx_environment_status ON environment(status);
CREATE INDEX idx_environment_owner_id ON environment(owner_id);
CREATE INDEX idx_environment_created_at ON environment(created_at DESC);
-- Comments
COMMENT ON TABLE environment IS 'Orca development environments';
COMMENT ON COLUMN environment.status IS 'PENDING, RUNNING, STOPPED, FAILED';sql
-- V001__create_environment_table.sql
CREATE TABLE environment (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
name VARCHAR(100) NOT NULL,
description TEXT,
status VARCHAR(50) NOT NULL DEFAULT 'PENDING',
owner_id UUID NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
updated_at TIMESTAMP WITH TIME ZONE,
CONSTRAINT uk_environment_name UNIQUE (name),
CONSTRAINT fk_environment_owner FOREIGN KEY (owner_id)
REFERENCES users(id) ON DELETE CASCADE
);
-- Indexes
CREATE INDEX idx_environment_status ON environment(status);
CREATE INDEX idx_environment_owner_id ON environment(owner_id);
CREATE INDEX idx_environment_created_at ON environment(created_at DESC);
-- Comments
COMMENT ON TABLE environment IS 'Orca development environments';
COMMENT ON COLUMN environment.status IS 'PENDING, RUNNING, STOPPED, FAILED';Adding Columns
添加列
sql
-- V002__add_labels_to_environment.sql
ALTER TABLE environment
ADD COLUMN labels JSONB NOT NULL DEFAULT '{}';
-- Add GIN index for JSONB queries
CREATE INDEX idx_environment_labels ON environment USING GIN (labels);
-- Add specific key index if frequently queried
CREATE INDEX idx_environment_labels_team ON environment ((labels->>'team'));sql
-- V002__add_labels_to_environment.sql
ALTER TABLE environment
ADD COLUMN labels JSONB NOT NULL DEFAULT '{}';
-- Add GIN index for JSONB queries
CREATE INDEX idx_environment_labels ON environment USING GIN (labels);
-- Add specific key index if frequently queried
CREATE INDEX idx_environment_labels_team ON environment ((labels->>'team'));Safe Column Modifications
安全修改列
sql
-- V003__change_description_length.sql
-- Safe: increasing length
ALTER TABLE environment
ALTER COLUMN description TYPE VARCHAR(2000);
-- V004__make_description_not_null.sql
-- First: set default for existing nulls
UPDATE environment SET description = '' WHERE description IS NULL;
-- Then: add constraint
ALTER TABLE environment
ALTER COLUMN description SET NOT NULL,
ALTER COLUMN description SET DEFAULT '';sql
-- V003__change_description_length.sql
-- Safe: increasing length
ALTER TABLE environment
ALTER COLUMN description TYPE VARCHAR(2000);
-- V004__make_description_not_null.sql
-- First: set default for existing nulls
UPDATE environment SET description = '' WHERE description IS NULL;
-- Then: add constraint
ALTER TABLE environment
ALTER COLUMN description SET NOT NULL,
ALTER COLUMN description SET DEFAULT '';Enum-like Columns
枚举类列
sql
-- V005__add_environment_type.sql
-- Option 1: VARCHAR with CHECK constraint
ALTER TABLE environment
ADD COLUMN type VARCHAR(20) NOT NULL DEFAULT 'STANDARD'
CONSTRAINT chk_environment_type
CHECK (type IN ('STANDARD', 'PREMIUM', 'ENTERPRISE'));
-- Option 2: PostgreSQL ENUM type
CREATE TYPE environment_type AS ENUM ('STANDARD', 'PREMIUM', 'ENTERPRISE');
ALTER TABLE environment ADD COLUMN type environment_type NOT NULL DEFAULT 'STANDARD';sql
-- V005__add_environment_type.sql
-- Option 1: VARCHAR with CHECK constraint
ALTER TABLE environment
ADD COLUMN type VARCHAR(20) NOT NULL DEFAULT 'STANDARD'
CONSTRAINT chk_environment_type
CHECK (type IN ('STANDARD', 'PREMIUM', 'ENTERPRISE'));
-- Option 2: PostgreSQL ENUM type
CREATE TYPE environment_type AS ENUM ('STANDARD', 'PREMIUM', 'ENTERPRISE');
ALTER TABLE environment ADD COLUMN type environment_type NOT NULL DEFAULT 'STANDARD';Data Migrations
数据迁移
sql
-- V006__migrate_status_values.sql
-- Normalize status values
UPDATE environment
SET status = CASE
WHEN status IN ('pending', 'Pending', 'PENDING') THEN 'PENDING'
WHEN status IN ('running', 'Running', 'RUNNING', 'active') THEN 'RUNNING'
WHEN status IN ('stopped', 'Stopped', 'STOPPED', 'inactive') THEN 'STOPPED'
WHEN status IN ('failed', 'Failed', 'FAILED', 'error') THEN 'FAILED'
ELSE 'PENDING'
END
WHERE status NOT IN ('PENDING', 'RUNNING', 'STOPPED', 'FAILED');sql
-- V006__migrate_status_values.sql
-- Normalize status values
UPDATE environment
SET status = CASE
WHEN status IN ('pending', 'Pending', 'PENDING') THEN 'PENDING'
WHEN status IN ('running', 'Running', 'RUNNING', 'active') THEN 'RUNNING'
WHEN status IN ('stopped', 'Stopped', 'STOPPED', 'inactive') THEN 'STOPPED'
WHEN status IN ('failed', 'Failed', 'FAILED', 'error') THEN 'FAILED'
ELSE 'PENDING'
END
WHERE status NOT IN ('PENDING', 'RUNNING', 'STOPPED', 'FAILED');Creating Related Tables
创建关联表
sql
-- V007__create_environment_tag_table.sql
CREATE TABLE environment_tag (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
environment_id UUID NOT NULL,
key VARCHAR(100) NOT NULL,
value VARCHAR(500) NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
CONSTRAINT fk_tag_environment FOREIGN KEY (environment_id)
REFERENCES environment(id) ON DELETE CASCADE,
CONSTRAINT uk_tag_env_key UNIQUE (environment_id, key)
);
CREATE INDEX idx_tag_environment_id ON environment_tag(environment_id);
CREATE INDEX idx_tag_key_value ON environment_tag(key, value);sql
-- V007__create_environment_tag_table.sql
CREATE TABLE environment_tag (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
environment_id UUID NOT NULL,
key VARCHAR(100) NOT NULL,
value VARCHAR(500) NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW(),
CONSTRAINT fk_tag_environment FOREIGN KEY (environment_id)
REFERENCES environment(id) ON DELETE CASCADE,
CONSTRAINT uk_tag_env_key UNIQUE (environment_id, key)
);
CREATE INDEX idx_tag_environment_id ON environment_tag(environment_id);
CREATE INDEX idx_tag_key_value ON environment_tag(key, value);Idempotent Migrations
幂等迁移
sql
-- V008__add_column_if_not_exists.sql
DO $$
BEGIN
IF NOT EXISTS (
SELECT 1 FROM information_schema.columns
WHERE table_name = 'environment' AND column_name = 'region'
) THEN
ALTER TABLE environment ADD COLUMN region VARCHAR(50);
END IF;
END $$;
-- Create index if not exists
CREATE INDEX IF NOT EXISTS idx_environment_region ON environment(region);
-- Create table if not exists
CREATE TABLE IF NOT EXISTS audit_log (
id BIGSERIAL PRIMARY KEY,
entity_type VARCHAR(50) NOT NULL,
entity_id UUID NOT NULL,
action VARCHAR(20) NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
);sql
-- V008__add_column_if_not_exists.sql
DO $$
BEGIN
IF NOT EXISTS (
SELECT 1 FROM information_schema.columns
WHERE table_name = 'environment' AND column_name = 'region'
) THEN
ALTER TABLE environment ADD COLUMN region VARCHAR(50);
END IF;
END $$;
-- Create index if not exists
CREATE INDEX IF NOT EXISTS idx_environment_region ON environment(region);
-- Create table if not exists
CREATE TABLE IF NOT EXISTS audit_log (
id BIGSERIAL PRIMARY KEY,
entity_type VARCHAR(50) NOT NULL,
entity_id UUID NOT NULL,
action VARCHAR(20) NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT NOW()
);Dropping Columns Safely
安全删除列
sql
-- V009__remove_deprecated_column.sql
-- Step 1: Remove any defaults/constraints first
ALTER TABLE environment ALTER COLUMN legacy_field DROP DEFAULT;
ALTER TABLE environment DROP CONSTRAINT IF EXISTS chk_legacy_field;
-- Step 2: Drop dependent indexes
DROP INDEX IF EXISTS idx_environment_legacy;
-- Step 3: Drop the column
ALTER TABLE environment DROP COLUMN IF EXISTS legacy_field;sql
-- V009__remove_deprecated_column.sql
-- Step 1: Remove any defaults/constraints first
ALTER TABLE environment ALTER COLUMN legacy_field DROP DEFAULT;
ALTER TABLE environment DROP CONSTRAINT IF EXISTS chk_legacy_field;
-- Step 2: Drop dependent indexes
DROP INDEX IF EXISTS idx_environment_legacy;
-- Step 3: Drop the column
ALTER TABLE environment DROP COLUMN IF EXISTS legacy_field;Performance-Sensitive Migrations
性能敏感型迁移
sql
-- V010__add_index_concurrently.sql
-- CONCURRENTLY prevents table locks (requires no transaction)
-- Add to flyway.conf: flyway.postgresql.transactional.lock=false
CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_environment_name_lower
ON environment (LOWER(name));
-- For large data updates, batch them
-- V011__batch_update_large_table.sql
DO $$
DECLARE
batch_size INT := 10000;
affected INT;
BEGIN
LOOP
UPDATE environment
SET normalized_name = LOWER(TRIM(name))
WHERE normalized_name IS NULL
LIMIT batch_size;
GET DIAGNOSTICS affected = ROW_COUNT;
EXIT WHEN affected = 0;
COMMIT;
PERFORM pg_sleep(0.1); -- Small pause to reduce load
END LOOP;
END $$;sql
-- V010__add_index_concurrently.sql
-- CONCURRENTLY prevents table locks (requires no transaction)
-- Add to flyway.conf: flyway.postgresql.transactional.lock=false
CREATE INDEX CONCURRENTLY IF NOT EXISTS idx_environment_name_lower
ON environment (LOWER(name));
-- For large data updates, batch them
-- V011__batch_update_large_table.sql
DO $$
DECLARE
batch_size INT := 10000;
affected INT;
BEGIN
LOOP
UPDATE environment
SET normalized_name = LOWER(TRIM(name))
WHERE normalized_name IS NULL
LIMIT batch_size;
GET DIAGNOSTICS affected = ROW_COUNT;
EXIT WHEN affected = 0;
COMMIT;
PERFORM pg_sleep(0.1); -- Small pause to reduce load
END LOOP;
END $$;Rollback Migrations (Undo)
回滚迁移(撤销)
sql
-- U010__undo_add_region.sql (Flyway Teams/Enterprise)
ALTER TABLE environment DROP COLUMN IF EXISTS region;
DROP INDEX IF EXISTS idx_environment_region;sql
-- U010__undo_add_region.sql (Flyway Teams/Enterprise)
ALTER TABLE environment DROP COLUMN IF EXISTS region;
DROP INDEX IF EXISTS idx_environment_region;Gradle Configuration
Gradle配置
kotlin
// build.gradle.kts
plugins {
id("org.flywaydb.flyway") version "11.11.2"
}
flyway {
url = "jdbc:postgresql://localhost:5432/orca"
user = System.getenv("DB_USER") ?: "orca"
password = System.getenv("DB_PASSWORD") ?: "orca"
schemas = arrayOf("public")
locations = arrayOf("classpath:db/migration")
cleanDisabled = true // Prevent accidental clean in production
validateMigrationNaming = true
}
tasks.named("flywayMigrate") {
dependsOn("processResources")
}kotlin
// build.gradle.kts
plugins {
id("org.flywaydb.flyway") version "11.11.2"
}
flyway {
url = "jdbc:postgresql://localhost:5432/orca"
user = System.getenv("DB_USER") ?: "orca"
password = System.getenv("DB_PASSWORD") ?: "orca"
schemas = arrayOf("public")
locations = arrayOf("classpath:db/migration")
cleanDisabled = true // Prevent accidental clean in production
validateMigrationNaming = true
}
tasks.named("flywayMigrate") {
dependsOn("processResources")
}Best Practices
最佳实践
- Never modify applied migrations - Create new ones instead
- Test migrations - Run against a copy of production data
- Keep migrations small - One logical change per migration
- Use transactions - Flyway wraps each migration in a transaction
- Document - Add comments explaining why, not just what
- Version carefully - Use consistent numbering scheme
- Handle nulls - Set defaults before adding NOT NULL
- Index wisely - Consider CONCURRENTLY for large tables
- 切勿修改已应用的迁移脚本 - 如需变更,创建新的迁移脚本
- 测试迁移脚本 - 在生产数据的副本上运行测试
- 保持迁移脚本粒度小 - 每个迁移对应一个逻辑变更
- 使用事务 - Flyway会将每个迁移脚本包裹在事务中
- 添加文档注释 - 注释应说明为什么要做,而不只是做了什么
- 谨慎管理版本 - 使用一致的编号方案
- 处理空值 - 添加NOT NULL约束前先设置默认值
- 合理创建索引 - 对于大表,考虑使用CONCURRENTLY选项