Flyway: DB migration

Flyway?

• DB 변경사항 형상관리 오픈소스
• community 무료버전과 유료버전이 있다.

7 Commands

• Migrate, Clean, Info, Validate, Undo, Baseline, Repair 라는 7개의 명령어를 지원한다.
• Migrate: DB의 스키마를 최신 버전으로 변경한다.
• Clean: 스키마의 내용을 삭제한다. (운영 DB에서 사용하면 안된다)
• Info: migration 과 관련된 상태외 상세정보를 보여준다.
• Validate: 현재 적용된 부분과 일치하는지 알려준다.
• Undo: 가장 최신에 적용된 migration을 되돌리기 한다.
• Baseline: baselineVersion을 제외하고 migration 한다.
• Repair: DB flyway 내역을 수정한다.

Migrate 필요성

기존상황

• JPA 와 같은 ORM 을 사용하면 코드로 DB의 생성을 관리할 수 있다.
• ddl-auto=create 명령어로 객체의 내용대로 변경되는 대로 DB의 테이블을 다시 만들 수 있으나, 개발 단계에서만 사용한다.
• 실제 서버에서 DB 테이블이 바뀐다면 CLI 명령어로 하나씩 바꿔주어야 할 것이다.

flyway 도입하면

• flyway를 사용하면 변경되는 내용을 파일을 사용해 관리할 수 있다.
• git 처럼 히스토리를 관리할 수 있다.
• 현 상태의 DB 내용을 한 곳에서 관리할 수 있다.
• flyway 를 적용한다면, 실수 없이 항상 같은 조건의 DB 설정을 유지할 수 있다.

도입

• Flyway를 적용하는 여러가지 방법이 있지만, 적용한 내용은 gradle, SQL-based 를 사용하는 migrate 방법이다.

Gradle

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

application.properties

• DB 설정에 더불어 flyway 설정을 추가해준다.

#flyway 설정
spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
spring.flyway.enabled=true
spring.jpa.generate-ddl=false

#Spring boot 2 이상의 경우 아래 설정 추가
spring.flyway.baselineOnMigrate = true

초기파일설정

• resources/db/migration/V1__init.sql 경로에 init 파일을 만든다.
• 내용은 DB의 DDL 이다.

버전관리

• 버전관리는 V 이후의 숫자가 커지는 것이 가장 최신파일이 되며, 최신 내용으로 적용된다.
  • V + 숫자 + __ + 설명.sql
  • V1, V1.3 또는 V날짜 등으로 관리할 수 있다.
  • 버전 뒤에는 언더스코어 2개가 꼭 필요하다. 그 이후에 설명을 적는다.
• 추가변경되는 내용의 DDL만 이후 버전에 적어주면 된다.

DB

• DB 에 flyway_schema_history 테이블이 생기며, 여기에 히스토리가 남게된다.
• DB 에서 migration 기록 및 성공 여부 등을 확인 가능하다.

참고링크

• 코기의 Flyway
• Flyway 공식문서