Flyway를 활용한 DB 마이그레이션 기법 완전정복 ~ Dev.

1. 데이터베이스 마이그레이션과 Flyway의 이해

데이터베이스 마이그레이션은 데이터베이스의 구조와 데이터를 변경, 관리, 동기화하는 프로세스입니다. 이 기술을 사용하면 DB 엔지니어들은 소프트웨어 개발 생명주기 동안 데이터베이스의 판올림과 변경 사항을 더욱 효과적으로 관리할 수 있습니다. Flyway는 이러한 작업을 간소화하고 더욱 편리하게 만드는 오픈 소스 DB 마이그레이션 툴입니다.

1.1 데이터베이스 마이그레이션의 필요성

데이터베이스 마이그레이션은 다음과 같은 이유로 중요합니다.

데이터베이스 스키마 개선과 정비: 데이터베이스 구조를 개선하거나 데이터의 표현을 더욱 효율적으로 만들기 위해 필요합니다.
데이터베이스 관리 시스템(DBMS)의 변경: 기업은 성능, 비용, 안정성 등의 이유로 다른 데이터베이스 관리 시스템으로 전환할 필요가 있을 수 있습니다.
데이터 변환: 다양한 어플리케이션과 플랫폼 간 데이터 호환성을 유지하기 위해 필요합니다.
백업과 복원 시 데이터 무결성 유지: 실수로 지운 데이터를 복원하거나 새로운 환경에 데이터를 백업할 때 데이터 무결성을 유지하는 것이 필수적입니다.

1.2 Flyway란?

Flyway는 Axel Fontaine에 의해 개발된 오픈 소스 DB 마이그레이션 도구로, 현재 Redgate Software에서 관리하고 있습니다. 이 도구는 버전 관리 및 마이그레이션 스크립트를 작성 및 적용하며, 변경 사항을 추적하여 데이터베이스 마이그레이션을 쉽게 처리할 수 있게 해줍니다.

Flyway의 주요 기능은 다음과 같습니다.

SQL과 Java 기반 마이그레이션: Flyway는 SQL 스크립트를 사용하거나 Java 라이브러리로 작성한 마이그레이션을 지원합니다.
플랫폼 독립적: Flyway는 다양한 데이터베이스 시스템과 호환 가능하며, 동일한 마이그레이션 스크립트로 여러 데이터베이스를 관리할 수 있습니다.
프로그래밍 언어에 독립적: 게시자가 제공하는 API를 사용하거나 명령줄 도구를 통해 사용할 있습니다.
안정적이고 빠른 마이그레이션: Flyway는 데이터베이스 변경 사항을 안전하게 적용하고, 적용 과정에 문제가 발생한 경우 자동으로 롤백합니다.

2. Flyway의 기본 개념 및 구성요소

데이터베이스 마이그레이션을 이해하기 전에, Flyway의 기본 개념과 구성 요소를 알아봅시다. 이 장에서는 Flyway의 주요 구성 요소와 기능을 설명합니다.

2.1 소개

Flyway는 다음과 같은 주요 구성 요소로 구성되어 있습니다:

마이그레이션 스크립트: 데이터베이스 변경 사항을 적용하는 SQL 또는 Java 기반 스크립트입니다.
스키마 버전 테이블: 데이터베이스에서 마이그레이션 스크립트의 현재 버전 상태를 추적하는 테이블입니다.
Flyway 클라이언트: 마이그레이션 명령을 실행하는 도구로, API 또는 명령줄 도구로 사용할 수 있습니다.

2.2 마이그레이션 스크립트 작성

마이그레이션 스크립트는 데이터베이스 변경 사항을 적용하는 데 사용되며, SQL 또는 Java 기반으로 작성할 수 있습니다. 각 스크립트는 버전 번호와 설명으로 구성되어 있습니다.

Flyway는 지원하는 파일 포맷을 정확히 따라야 합니다. 일반적인 패턴은 다음과 같습니다.

V<버전숫자>__<설명>.sql

예를 들어, "V1__Initial_schema.sql"은 버전 1의 초기 스키마를 생성하는 스크립트이며, "V2__Add_Indexes.sql"은 버전 2에서 인덱스를 추가하는 스크립트입니다.

2.3 스키마 버전 테이블

Flyway는 데이터베이스 변경 사항을 추적하기 위해 스키마 버전 테이블을 사용합니다. 테이블에는 다음 정보가 포함됩니다:

승인된 스크립트의 버전: 실행된 마이그레이션 스크립트의 버전입니다.
진행상황: 스크립트가 성공적으로 실행되었는지, 실패하거나 중단되었는지의 상태입니다.
응용 프로그램과 사용자 정보: 마이그레이션을 실행한 애플리케이션과 사용자에 대한 정보입니다.
타임스탬프: 마이그레이션 스크립트가 실행된 날짜와 시간입니다.

2.4 Flyway 클라이언트

Flyway 클라이언트는 API 또는 명령줄 도구로 사용할 수 있습니다. 클라이언트는 여러 가지 기능을 제공하지만, 가장 일반적인 기능은 다음과 같습니다:

마이그레이션: 실행되지 않은 마이그레이션 스크립트를 순차적으로 적용합니다.
롤백: 이전 버전의 스키마로 데이터베이스를 되돌리는 작업입니다.
상태 조회: 현재 데이터베이스와 스크립트의 상태를 확인합니다.
검증: 스키마 버전 테이블과 파일 시스템 내의 스크립트를 비교하여 차이점을 확인합니다.

3. Flyway 사용법: 설치 및 마이그레이션 프로세스

Flyway를 성공적으로 사용하려면 도구를 설치하고 마이그레이션 프로세스를 수행해야 합니다. 이 장에서는 Flyway를 다운로드하고 설치한 후 마이그레이션을 진행하는 방법을 안내합니다.

3.1 설치

Flyway는 다양한 도구와 통합되어 독립 실행 파일로 제공됩니다. 각 플랫폼에 맞게 다운로드하여 설치할 수 있으며, 공식 문서에서 자세한 방법을 확인할 수 있습니다(Flyway 공식 문서 참조).

  Flyway를 사용할 수 있는 플랫폼:
  - Windows
  - macOS
  - Linux

3.2 설정 파일 구성

Flyway를 구동하려면 설정 파일을 작성해야 합니다. 기본적으로 "flyway.conf"라는 이름의 파일에 설정값을 작성합니다. 설정 파일에는 데이터베이스 연결 정보와 마이그레이션 스크립트 위치 등이 포함됩니다. 예를 들어:

  // 데이터베이스 연결 정보
  flyway.url=jdbc:mysql://localhost:3306/my_database
  flyway.user=my_user
  flyway.password=my_password

  // 마이그레이션 스크립트 위치 (기본값: classpath:/db/migration)
  flyway.locations=filesystem:./sql_migrations

3.3 마이그레이션 작업 수행

Flyway를 설치하고 설정 파일을 작성한 후, 다음 단계는 마이그레이션 작업을 수행하는 것입니다. 아래 명령을 사용하여 마이그레이션을 실행할 수 있습니다.

  flyway migrate

위 명령을 실행하면, Flyway는 설정 파일에서 지정한 위치에서 마이그레이션 스크립트를 찾고, 스키마 버전 테이블을 기반으로 아직 실행되지 않은 스크립트를 차례대로 실행합니다. 이 과정에서 오류가 발생하면, 롤백 작업을 수행하여 데이터베이스의 상태를 이전 상태로 되돌립니다.

3.4 추가 기능

Flyway는 다양한 기능을 제공합니다. 가장 일반적인 몇 가지 명령은 다음과 같습니다:

상태 조회: flyway info
검증: flyway validate
스키마 버전 테이블 초기화: flyway baseline
수동 롤백: flyway undo (Flyway Pro 및 Enterprise 에디션에서만 사용 가능)

프로젝트에 맞춰 Flyway를 사용하고 설정을 최적화하면, 데이터베이스 마이그레이션을 더욱 효과적으로 수행할 수 있습니다.

4. Flyway 통합: 다양한 프레임워크 및 도구와의 연동

Flyway는 여러 프레임워크와 도구와 통합되어 개발 환경에 쉽게 적용할 수 있습니다. 이 장에서는 일반적인 프레임워크와 도구를 사용하여 Flyway를 통합하는 방법에 대해 설명합니다.

4.1 Spring Boot

Spring Boot에서 Flyway를 사용하려면 먼저 프로젝트의 Maven 또는 Gradle 빌드 파일에 의존성을 추가해야 합니다. 예를 들면:

Maven

<dependencies>
  <dependency>
    <groupId>org.flywaydb</groupId>
    <artifactId>flyway-core</artifactId>
    <version>7.15.0</version>
  </dependency>
</dependencies>

Gradle

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

Flyway 의존성을 추가한 후, Spring Boot 애플리케이션의 설정 파일(application.properties 또는 application.yml)에 데이터베이스 연결 정보와 마이그레이션 스크립트 위치를 지정하면 Flyway가 자동으로 마이그레이션을 수행합니다.

spring.datasource.url=jdbc:mysql://localhost:3306/my_database
spring.datasource.username=my_user
spring.datasource.password=my_password

# 마이그레이션 스크립트 위치
spring.flyway.locations=classpath:db/migration

4.2 다른 프레임워크 및 도구

Flyway는 다른 프레임워크와 도구와의 통합도 지원합니다. 예를 들어:

Quarkus: Flyway는 Quarkus와 함께 사용할 수 있으며, 연동 가이드를 통해 설정을 마련할 수 있습니다( Quarkus 공식 문서 참조).
JHipster: JHipster를 사용하여 생성된 애플리케이션에 Flyway가 포함되어 있습니다. JHipster를 사용해서 프로젝트를 시작하면, 데이터베이스 마이그레이션과 관련된 초기 설정이 이미 완료되어 있습니다.
JDBC 사용: Flyway 개체를 직접 생성하고 설정한 후, Flyway 클래스의 API를 사용하여 마이그레이션을 수행할 수도 있습니다. 이를 통해 데이터베이스 관련 작업을 직접 컨트롤할 수 있습니다.

이외에도 다양한 통합 방법이 있으며, Flyway 공식 문서에서 자세한 사용 방법을 찾을 수 있습니다 (Flyway 공식 문서 참조).

5. Flyway 활용 시 주의사항 및 모범 사례

Flyway를 효과적으로 사용하려면 주의사항을 숙지하고 모범 사례를 따라야 합니다. 이 장에서는 Flyway를 사용할 때 알아두어야 할 주의사항과 모범 사례를 공유합니다.

5.1 주의사항

환경 일치: 개발, 테스트 및 운영 환경 사이의 데이터베이스 스키마 버전 불일치를 방지하려면, 모든 환경에서 동일한 마이그레이션 스크립트를 사용해야 합니다.
데이터 손실: 마이그레이션을 수행할 때 데이터 손실이 발생할 수 있으므로, 중요 데이터에 대한 백업 및 복구 계획을 마련하고 테스트해야 합니다.
품질 관리: 마이그레이션 스크립트는 실수로 인해 데이터베이스 오류를 일으킬 수 있습니다. 스크립트를 병합하기 전에 코드 리뷰를 수행하고, 테스트를 거쳐 품질을 관리하는 것이 중요합니다.

5.2 모범 사례

단위 테스트: 마이그레이션 스크립트를 제대로 테스트하려면, 변경 사항에 대한 단위 테스트를 작성하고 실행해야 합니다. 이를 통해 향후 문제를 방지할 수 있습니다.
버전 관리: 마이그레이션 스크립트를 버전 관리 시스템에 저장해야 합니다. 이를 통해 이전 버전의 스크립트에 접근할 수 있고, 코드의 변경 이력과 관련된 문제를 해결할 수 있습니다.
스크립트 작성 원칙: 마이그레이션 스크립트는 가독성이 좋아야 하며, 재사용 가능한 코드를 작성하는 것이 좋습니다. 또한, 적절한 커밋 메시지를 포함하여 작업 내용을 명확하게 설명해야 합니다. 이로써 협업 시 문제를 줄이고, 유지 보수를 용이하게 할 수 있습니다.
로컬 개발 환경: 개발자는 로컬 환경에서 데이터베이스 마이그레이션을 테스트해야 합니다. 이를 통해 실수를 줄이고, 실제 환경에서 발생할 문제를 미리 확인할 수 있습니다.
자동화된 배포 파이프라인: 가능하다면 CI/CD 파이프라인에 Flyway 마이그레이션을 자동화하여, 운영 환경에 쉽게 적용할 수 있게 해야 합니다. 이를 통해 배포 과정에서의 오류를 방지하고, 더 빠르게 변경 사항을 반영할 수 있습니다.

위의 주의사항과 모범 사례를 숙지하고 실천하면, 데이터베이스 마이그레이션을 더욱 효과적으로 수행할 수 있습니다. Flyway를 사용하여 데이터베이스 작업을 원활하게 진행하고, 프로젝트의 성공에 기여할 수 있습니다.

Wednesday, August 9, 2023

Flyway를 활용한 DB 마이그레이션 기법 완전정복