작업 개요

운영 환경 DB 스키마 마이그레이션 및 스키마 버전 관리를 위한 flyway 를 적용했습니다.

Flyway 소개

자세한 설명은 아래의 링크로 대체합니다.

참고자료: Spring boot 프로젝트에 Flyway 도입하기 (feat. 기존 데이터가 있을 경우) [티스토리]

사용 방법

아래에서는 엔티티가 이미 존재하는 상황을 전제로 작성합니다.

1. 엔티티 변경

바꾸고자 하는 엔티티에 컬럼을 추가합니다.

@Getter
@NoArgsConstructor
@Entity
@Slf4j
@Table(name = "challenge")
public class Challenge extends BaseTime {

    @Column(nullable = false)
    private int feePerAbsence;

+   @Column(nullable = false)
+   private int totalAbsenceFee;

}

2. SQL 파일 생성

src/main/resources/db/migration 경로에 SQL 파일을 생성합니다.

파일 네이밍 규칙은 아래와 같습니다.

V[YYYYMMDDHHMM]__[Changes].sql

V 는 버전을 의미합니다. 버전은 버전 변경이 일어난 일시를 쉽게 확인하기 위해 '연월일시분' 형식으로 생성합니다.
- 예시: V202410162119
[Changes] 의 가장 첫 단어는 대문자로 시작합니다. 단어는 언더스코어 1개로 구분합니다.
- 예시: Add_totalAbsenceFee_in_challenge
버전과 작업 내용 사이에는 언더스코어 2개(__)를 사용합니다.
- 예시: V202410162038__Add_totalAbsenceFee_in_challenge

유의사항

새로운 엔티티를 추가할 때도 SQL 파일에 쿼리를 작성해서 생성해주어야 합니다. 그렇지 않으면 운영 서버에 반영되지 않습니다.
로컬 환경에서도 Flyway 를 사용합니다. 이는 실제 운영 서버와 최대한 같은 환경을 유지하기 위해서입니다. 즉, 엔티티 변경 사항이 있으면 반드시 SQL 파일을 작성해야 합니다.

적용 확인

운영 서버에도 정상적으로 적용되었습니다.

Flyway history 테이블 생성

컬럼 추가

참고자료

[springboot] flyway 로 DB 마이그레이션 하기 [shwan-dev]
Flyway를 통한 Postgres 형상관리 적용 [티스토리]

HabitPay / backend

[feat] db 마이그레이션 및 버전 관리를 위한 flyway 도입#278 #279