콘텐츠로 이동

DB와 마이그레이션

스키마의 원본은 Flyway 마이그레이션 SQL이에요. cowork는 server/src/main/resources/db/migration/에 SQL 파일을 두고, 서버가 시작할 때 Flyway가 아직 적용하지 않은 파일을 차례로 실행해요. jOOQ 코드는 실행 중인 DB 없이 같은 SQL에서 생성해요. 그래서 스키마와 코드가 어긋나면 컴파일이 실패해요.

build.gradle의 jooq 블록이 jOOQ의 DDLDatabase로 마이그레이션 SQL을 읽어 표 모델을 만들어요. 생성물은 build/generated-sources/jooq/에만 두고 커밋하지 않아요. 원본을 두 벌로 만들지 않기 위해서예요.

server/build.gradle
/*
* jOOQ 코드 생성: 실행 중인 데이터베이스 없이 마이그레이션 SQL 에서 직접 생성한다.
* 빌드가 외부 상태에 의존하지 않으며, 스키마와 코드가 어긋나면 컴파일이 실패한다.
* 생성물은 build/ 아래에만 두고 커밋하지 않는다 — 단일 원본을 두 벌로 만들지 않기 위해서다.
*/
jooq {
configuration {
generator {
database {
name = 'org.jooq.meta.extensions.ddl.DDLDatabase'
// …
executions {
main {
configuration {
generator {
database {
properties {
property {
key = 'scripts'
value = 'src/main/resources/db/migration/*.sql'
// …

compileJava가 jOOQ 생성에 기대므로, 서버를 빌드하면 생성이 먼저 돌아요. 생성은 마이그레이션 폴더가 바뀔 때만 다시 해요. 생성한 파일은 손으로 고치지 않아요.

jOOQ의 파서가 읽지 못하거나 표 모델에 필요 없는 것(외래 키, 색인, 처음 넣는 행)은 SQL 안에서 [jooq ignore] 표시 사이에 둬요. Flyway는 이 부분도 실행하고, jOOQ 생성만 건너뛰어요.

server/src/main/resources/db/migration/V1__schema.sql
-- …
, legacy_shared boolean DEFAULT false NOT NULL
-- [jooq ignore start]
, FOREIGN KEY(user_id) REFERENCES users(user_id)
, CHECK(length(trim(name)) BETWEEN 1 AND 64)
-- [jooq ignore stop]
);
  1. 새 마이그레이션 파일을 더해요. 이미 공유 환경에 적용된 파일은 고치지 않고 다음 버전(V2__….sql)을 만들어요. 기존 행을 어떻게 채울지, 제약을 언제 걸지도 이 파일에서 정해요.

  2. server/에서 빌드해요. 생성 코드가 새 열을 담아 다시 만들어져요.

    터미널 창
    ./gradlew compileJava
  3. 저장소(Jooq…Repository)와 조회(Jooq…Query)를 고쳐요. 스키마와 맞지 않는 곳은 컴파일 오류로 드러나요.

  4. 테스트를 돌려요. 테스트는 빈 DB 파일에 마이그레이션을 처음부터 적용한 뒤 실행해요.

    터미널 창
    ./gradlew test integrationTest

운영 데이터를 지우거나 되돌리기 어렵게 바꾸는 마이그레이션은 사용자가 승인한 범위인지 먼저 확인해요. 백업을 만들었다는 것과 복구를 확인했다는 것은 다른 일이에요.

SQL과 jOOQ 타입은 모듈의 infrastructure에만 둬요. 서비스와 도메인은 jOOQ를 모르고, 저장소 인터페이스(domain)와 조회 포트(application)를 거쳐요. 조회 포트는 같은 피처의 application에 …Query로 두고, 구현은 infrastructure의 package-private Jooq…Query에 둬요. 필터·정렬·페이지·건수는 DB가 정하고, 서비스는 정해진 결과를 조립해요.