[📌 Feature] Flyway DB Schema 버젼 관리

[Sunja-An]

Warning

이슈와 프로젝트(Project) 연결 시 반드시 주의하세요.
이는 업무 효율도를 위해서 사용하는 것이지 때문에 협조 부탁드립니다

Tip

새로운 기능이나 개선사항을 추가할 때 작성하세요.
요구사항과 기대 동작을 명확히 적어 팀원과 PM이 이해하기 쉽게 합니다.

1️⃣ 기능 요약 (Summary)

• Flyway 도입

2️⃣ 목적 / 이유 (Goal / Motivation)

• Flyway DB Schema 버젼 관리를 위한 Flyway 도입

3️⃣ 요구 사항 (Requirements)

• Flyway DB 도입�

[Sunja-An]

Flyway DB 설치

jobmanri 에서 사용할 flyway 버젼은 '11.19.0' 으로 가장 최신 버젼을 사용하였습니다.

• build.gradle 추가 내용

runtimeOnly "org.flywaydb:flyway-gradle-plugin:${flywayVersion}"
implementation "org.flywaydb:flyway-mysql:${flywayVersion}"

다른 개발자분들이 Flyway 를 사용하실 때, 염두에 두실 내용들을 아래에 작성해놓겠습니다!

참고해서 사용주시면 감사하겠습니다 😎

flyway:
  enabled: true
  locations:
    - classpath:db/migration
  baseline-on-migrate: true
  baseline-version: 0
  clean-disabled: false

• flyway.enable: Flyway 를 적용하기 위한 application 문구입니다.
• flyway.locations: Flyway 에서 Version 을 적용할 SQL문들을 넣어놓습니다.
  • 저는 migration 에 V1__init.sql 이라는 파일을 설정해놨는데, Jobmanri 의 첫 DB Schema File 로 설정해놓았습니다.
  • 추가적으로 파일명을 작성할 때, 아래와 같이 Convention 에 맞춰서 적어야합니다. ( 참고로 under bar 가 2개에요! )
  • 여러 File Directory 를 설정할 수 있습니다.

• flyway.baseline-on-migrate: 기존 DB 에서 처음으로 Flyway 를 도입할 때, Baseline 을 적용할 것인가? 에 대한 문구입니다.
  • 저희 jobmanri 에서 처음 도입을 시도함으로, 이 부분에 대해서 true 로 설정하였습니다.
  • 추가적으로 운영 DB 에 대해서도 도입을 시도할 때, true 를 설정하여줍니다.
    • True 를 설정할 경우, DB Table 하나가 생성이 됩니다. ( 아래는 테스트 당시 생성된 Table )

• flyway.baseline-version: Baseline 의 Version 번호를 0 으로 설정한다는 의미입니다.
  • 현재 DB 의 상태를 0 으로 기록하고, flyway.locations 에 설정된 디렉토리를 확인하여서 버젼이 적용된 Schema 문 ( SQL파일 ) 을 확인해서 version 을 생성합니다.
  • 조금 신기한 부분은 다른 분들의 Blog 를 보았을 때, baseline-on-migrate 를 설정했을 때, 바로 version 1 부터 적용이 되더라구요. 근데 baseline-version: 0 으로 설정을 하게 될 경우에, baseline 과 관련해서 version 이 생길 줄 알고, 0 으로 설정을 했는데, 저도 동일하게 record 가 만들어졌습니다. ( 아래 파일 첨부 )

• flyway.clean-disabled: 모든 테이블을 삭제하는 명령어입니다!!
  • 저희가 DB 를 사용함에 있어서, 변경된 사항이 있음에도 불구하고, 원래 Table 들이 남아있을 때, flyway 가 정상적으로 작동하지 않을 수 있습니다.
  • 그럴 때에 위와 같은 명령어를 사용하는데, 절대 운영 환경에서는 사용하지마세요!

이상으로 Flyway 도입기를 마치도록 하겠습니다 😆
질문있으시면 언제든지 Comment 달아주세요!

Reference

Flyway DB 설치 및 도입
Flyway DB 설치에 대해 채택한 Reference
Flyway Gradle Dependency