Flyway

목적

• 소스코드를 github로 형상 관리하는 것처럼 DB의 변경사항을 형상관리하는 툴임
1. 예를들어 로컬 DB에 어떤 테이블을 만들고 그다음에 그 테이블을 수정한 것을 형상관리(Migration Script 작성)를 해 놓으면
2. 다른 DB(local에서 하다가 운영에 배포)에 해당 스키마들을 세팅할 때, Flyway가 알아서 차례대로 Migration Script DDL을 수행하여 똑같은 형태로 table을 생성해줌

동작 원리

• flyway_schema_history 라는 테이블을 만들어서 거기에서 아래와 같이 관리한다고 함. 자세한건 링크 참고

적용 방법

최신 버전으로 Migration 자동으로 할 수 있도록 설정

implementation 'org.flywaydb:flyway-core:8.5.12'
implementation 'org.flywaydb:flyway-mysql:8.5.12'

- classpath:db/migration

Migration script 작성

• prefix - version - description - suffix 순서임
• 예시 : V1_0_1__add_member.sql

• prefix
• V는 버전 마이그레이션, R은 반복 마이그레이션 용 접두사(반드시 V또는 R로 시작해야함)
반복 마이그레이션은 어떠한 부작용도 없이 반복적으로 실행 가능한 migration을 말함

-- migration.sql

-- Create a stored procedure to calculate the total sales for a given product
CREATE OR REPLACE PROCEDURE calculate_total_sales(product_id INT)
AS
BEGIN
  DECLARE total_sales DECIMAL(10,2);
  
  -- Calculate the total sales for the product and store it in the 'total_sales' variable
  SELECT SUM(sales_amount) INTO total_sales FROM sales WHERE product_id = product_id;
  
  -- Display the result
  DBMS_OUTPUT.PUT_LINE('Total sales for product ' || product_id || ': ' || total_sales);
END;
/

• version
• 버전 마이그레이션에서만 명시함.
• 숫자와 Dot, underscore 조합으로 구성함
• version과 description사이에는 언더바 2개 반드시 있어야 함

• description
• schema_version 테이블에 저장 시 설명으로 사용

• suffix
• 확장자 기본은 .sql

• Versioned migrations are typically used for: [ Docs 참고 ]
• Creating/altering/dropping tables/indexes/foreign keys/enums/UDTs/…
• Reference data updates
• User data corrections

spring:
	flyway:
	  baseline-on-migrate:true

Migration, clean 등 조금 더 세밀하게 관리 → plugin, CLI ..

plugins {
	id "org.flywaydb.flyway" version "8.2.0"
}

dependencies {
	implementation 'org.flywaydb:flyway-core:8.5.12'
  implementation 'org.flywaydb:flyway-mysql:8.5.12'
}

flyway {
    url = "jdbc:mysql://localhost:3306/tenwonmoa?serverTimezone=UTC&characterEncoding=UTF-8"
    user = "root"
    password = "root1234"
}

Configurations

• mixed : whether to allow mixing transactional and non-transactional statements within the same migration. 이걸 가능케 하면 모든 migration들이 transaction 없이 실행될 수가 있음 [ 참고 ]

TroubleShooting

CREATE PROCEDURE [dbo].[spProcBlockList]
@i_type			INT,
@i_ip			VARCHAR(22),
@i_reason		INT,
@o_ret			INT OUTPUT
AS
BEGIN
	SET NOCOUNT ON;
	SET @o_ret = 0;

	IF @i_Type = 0
	BEGIN
		SELECT IP FROM block_list
	END

	ELSE IF @i_Type = 1
	BEGIN
		INSERT INTO block_list(ip, reason, create_time) VALUES(@i_ip, @i_reason, GETDATE());
		SELECT @i_ip
	END
	RETURN;
END;


CREATE OR ALTER PROCEDURE [dbo].[spGetSceneInfo]
@o_ret			INT OUTPUT
AS
BEGIN
	SET NOCOUNT ON;
	SET @o_ret = 0;

	SELECT id, room_type, scene_id, max_user_cnt FROM md_scene_info
	RETURN;
END;

• INSERT INTO (col1, col2 ..) values (val1, val2, …), (val1, val2, …) 와 같이 여러 값을 동시에 삽입하는 게 정상동작 안함. 한개씩 INSERT 구문 실행해주어야 함

• Non-transactional query(eg. CREATE INDEX) 를 실행시킬시 계속 hang 걸리는 현상 [ 참고 ]