고(Go) 개발자를 위한 필수템! 데이터베이스 마이그레이션, '구스(Goose)'로 쉽고 빠르게! (핵심 기능 총정리)

고(Go) 개발자를 위한 필수템! 데이터베이스 마이그레이션, '구스(Goose)'로 쉽고 빠르게! (핵심 기능 총정리)

---

구스(Goose)가 뭐길래 이렇게 핫할까요? 핵심 기능 파헤치기!

구스(Goose)는 데이터베이스의 구조(스키마라고 부릅니다)를 마치 레고 블록 쌓듯이, 단계별로 차근차근 변경하고 관리할 수 있게 도와주는 아주 멋진 도구입니다.

우리가 흔히 사용하는 SQL 명령어를 직접 사용하거나, 더 복잡한 작업이 필요할 때는 고(Go) 언어로 직접 함수를 만들어서 데이터베이스를 변경할 수도 있는데요.

마치 연장통에 다양한 공구가 들어있는 것처럼, 구스도 명령줄 인터페이스(CLI)와 라이브러리 형태, 두 가지 방식으로 사용할 수 있어서 상황에 맞게 유연하게 활용 가능하답니다.

구스가 자랑하는 특별한 능력들!

구스는 개발자들이 사랑할 수밖에 없는 여러 가지 매력적인 기능들을 가지고 있는데요.

1. 웬만한 데이터베이스는 다 OK! (다중 데이터베이스 지원)
   포스트그레스(Postgres), 마이SQL(MySQL), SQLite, YDB, 클릭하우스(ClickHouse), MSSQL, 버티카(Vertica) 등 정말 다양한 종류의 데이터베이스와 함께 사용할 수 있습니다.
   
   마치 만능 리모컨처럼, 어떤 데이터베이스를 사용하든 구스 하나로 마이그레이션 작업을 처리할 수 있다는 건 정말 큰 장점이죠.
   
   
2. SQL로 부족하다면, 고(Go) 코드로 직접! (Go 마이그레이션 지원)
   단순한 SQL 명령어만으로는 표현하기 어려운 복잡한 데이터베이스 변경 작업이 필요할 때가 있습니다.
   
   이럴 때 구스는 고(Go) 언어로 직접 함수를 작성해서 마이그레이션을 수행할 수 있도록 지원합니다.
   
   마치 레고 기본 블록으로 만들기 힘든 모양을 특수 블록으로 만드는 것과 비슷하다고 생각하면 됩니다.
   
   
3. 프로그램 안에 마이그레이션 파일을 쏙! (임베디드 마이그레이션)
   마이그레이션 파일들을 우리가 만든 고(Go) 프로그램 실행 파일 안에 쏙 집어넣을 수 있는 기능도 제공합니다.
   
   이렇게 하면 프로그램을 배포하거나 다른 사람에게 전달할 때 훨씬 간편해지겠죠?.
   
   마치 도시락에 반찬까지 다 챙겨주는 것처럼 편리합니다.
   
   
4. 순서가 꼬여도 괜찮아! (순서 없는 마이그레이션 지원)
   가끔 실수로 마이그레이션을 빼먹거나 순서가 뒤바뀌는 경우가 생길 수도 있는데요.
   
   구스는 이런 상황에서도 유연하게 대처할 수 있도록 순서에 맞지 않게 적용된 마이그레이션도 처리할 수 있는 기능을 지원합니다.
   
   
5. 초기 데이터, 테스트 데이터도 손쉽게! (데이터 시딩)
   데이터베이스를 처음 만들거나 테스트를 할 때 필요한 초기 데이터를 손쉽게 넣어주는 기능(데이터 시딩)도 제공합니다.
   
   
6. 환경에 따라 똑똑하게 설정 변경! (환경 변수 대체)
   SQL 마이그레이션 파일 안에서 환경 변수를 사용할 수 있게 해줘서, 개발 환경이나 실제 운영 환경에 따라 설정을 유연하게 바꿀 수 있도록 도와줍니다.
   
   

구스(Goose), 내 컴퓨터에도 설치해볼까요?

구스(Goose)를 사용하려면 먼저 설치부터 해야겠죠? 구스 CLI(명령줄 인터페이스)를 설치하는 방법은 아주 간단합니다.

터미널이나 명령 프롬프트 창을 열고 다음 명령어를 입력하기만 하면 되는데요.

go install github.com/pressly/goose/v3/cmd/goose@latest

이 명령어를 실행하면, goose라는 실행 파일이 여러분의 $GOPATH/bin 디렉터리에 설치될 겁니다.

맥(macOS)을 사용하시는 분들은 홈브루(Homebrew)라는 패키지 관리자를 통해서도 구스를 쉽게 설치할 수 있습니다.

brew install goose

혹시라도 실행 파일의 크기를 줄이고 싶다면, 사용하지 않는 데이터베이스 드라이버를 제외하고 빌드하는 방법도 있습니다.

예를 들어, 포스트그레스, 마이SQL, SQLite3, YDB 드라이버가 필요 없다면 이렇게 빌드할 수 있는데요.

go build -tags='no_postgres no_mysql no_sqlite3 no_ydb' -o goose ./cmd/goose

제외할 수 있는 빌드 태그에는 no_clickhouse, no_libsql, no_mssql, no_mysql, no_postgres, no_sqlite3, no_vertica, no_ydb 등이 있으니, 필요에 맞게 선택해서 사용하시면 됩니다.

구스(Goose) 사용법, 핵심 명령어만 쏙쏙!

구스를 설치했다면 이제 직접 사용해볼 차례입니다! 구스는 데이터베이스 스키마를 관리하기 위한 몇 가지 핵심적인 명령어들을 제공하는데요.

새로운 마이그레이션 파일 만들기

데이터베이스 구조를 변경하고 싶을 때, 가장 먼저 해야 할 일은 새로운 마이그레이션 파일을 만드는 것입니다.

• SQL 마이그레이션 파일 만들기:
  
  
  이 명령어를 실행하면, AddSomeColumns라는 이름과 현재 시간을 나타내는 숫자가 붙은 새로운 SQL 마이그레이션 파일이 뿅 하고 만들어집니다.
  
  
• goose create AddSomeColumns sql
• Go 마이그레이션 파일 만들기:
  
  
  이 명령어는 고(Go) 코드로 마이그레이션을 작성할 수 있는 새로운 Go 마이그레이션 파일을 만들어주는데요, 기본적인 코드 틀도 함께 생성해줘서 편리합니다.
  
  
• goose create AddSomeColumns go

마이그레이션 적용하기 (데이터베이스 업데이트!)

만들어진 마이그레이션 파일들을 실제 데이터베이스에 적용해서 구조를 변경하려면 다음 명령어를 사용합니다.

goose up

이 명령어는 아직 적용되지 않은 모든 마이그레이션들을 최신 버전까지 순서대로 적용시켜줍니다.

마이그레이션 되돌리기 (실수했다면 이전으로!)

만약 마이그레이션을 적용했는데 뭔가 잘못되었거나 이전 상태로 되돌리고 싶다면 다음 명령어를 사용합니다.

goose down

이 명령어는 가장 최근에 적용된 마이그레이션 하나를 되돌립니다.

마이그레이션 상태 확인하기

지금까지 어떤 마이그레이션들이 적용되었고, 또 어떤 마이그레이션들이 대기 중인지 한눈에 확인하고 싶다면 이 명령어를 사용해보세요.

goose status

현재 데이터베이스 버전 확인하기

현재 데이터베이스가 어떤 마이그레이션 버전까지 적용되어 있는지 궁금하다면 다음 명령어를 사용합니다.

goose version

마이그레이션 파일, 어떻게 작성하는 걸까요? (SQL vs Go)

구스는 SQL 또는 고(Go) 언어, 두 가지 방식으로 마이그레이션 파일을 작성할 수 있도록 지원합니다.

SQL 마이그레이션 작성 예시

SQL 마이그레이션 파일은 보통 이런 모습을 하고 있습니다.

-- +goose Up
-- 위로 마이그레이션할 때 (새로운 변경 사항 적용) 실행될 SQL 명령어들
CREATE TABLE post (
    id INT NOT NULL,
    title TEXT,
    body TEXT,
    PRIMARY KEY(id)
);

-- +goose Down
-- 아래로 마이그레이션할 때 (변경 사항 되돌리기) 실행될 SQL 명령어들
DROP TABLE post;

여기서 중요한 것은 -- +goose Up과 -- +goose Down이라는 특별한 주석인데요.

-- +goose Up 아래에는 데이터베이스를 최신 상태로 업데이트할 때 실행될 SQL 명령어들을, -- +goose Down 아래에는 변경 사항을 이전 상태로 되돌릴 때 실행될 SQL 명령어들을 적어주면 됩니다.

Go 마이그레이션 작성 예시

고(Go) 언어로 마이그레이션을 작성하는 방법은 다음과 같습니다.

package main // 실제로는 마이그레이션 파일이 위치한 패키지명으로 변경될 수 있습니다.

import (
    "database/sql"
    "fmt"
)

// 마이그레이션 적용 함수 (Up)
// 함수 이름은 보통 "Up_" 다음에 마이그레이션 파일 생성 시각을 붙입니다.
func Up_20130106222315(txn *sql.Tx) error { // 반환 타입에 error 추가 (실패 시 에러 반환)
    fmt.Println("마이그레이션 20130106222315 Up 실행 중입니다!")
    // 여기에 실제 데이터베이스 변경 로직을 작성합니다.
    // 예: _, err := txn.Exec("CREATE TABLE example (id INT)")
    // if err != nil {
    //     return err
    // }
    return nil // 성공 시 nil 반환
}

// 마이그레이션 되돌리기 함수 (Down)
// 함수 이름은 보통 "Down_" 다음에 마이그레이션 파일 생성 시각을 붙입니다.
func Down_20130106222315(txn *sql.Tx) error { // 반환 타입에 error 추가
    fmt.Println("마이그레이션 20130106222315 Down 실행 중입니다!")
    // 여기에 데이터베이스 변경을 되돌리는 로직을 작성합니다.
    // 예: _, err := txn.Exec("DROP TABLE example")
    // if err != nil {
    //     return err
    // }
    return nil // 성공 시 nil 반환
}

Up_YYYYMMDDHHMMSS 형태의 함수는 마이그레이션을 적용할 때, Down_YYYYMMDDHHMMSS 형태의 함수는 마이그레이션을 되돌릴 때 각각 실행됩니다.

함수 안에는 *sql.Tx 타입의 트랜잭션 객체를 받아서, 이 객체를 통해 데이터베이스 작업을 수행하게 됩니다.

이렇게 고(Go) 코드를 직접 사용하면, 단순 SQL로는 처리하기 어려운 복잡한 로직이나 외부 라이브러리 연동 등 다양한 작업을 수행할 수 있습니다.

마무리하며: 구스(Goose)와 함께라면 데이터베이스 관리도 문제없어요!

지금까지 고(Go) 어플리케이션에서 데이터베이스 마이그레이션을 손쉽게 관리할 수 있도록 도와주는 강력하고 유연한 도구, 구스(Goose)에 대해 자세히 알아봤습니다.

다양한 데이터베이스 지원, SQL 및 Go 마이그레이션 지원, 임베디드 마이그레이션, 순서 없는 마이그레이션 처리 등 구스가 제공하는 풍부한 기능들은 개발자들이 데이터베이스 스키마를 효과적으로 유지하고 발전시키는 데 큰 도움을 줄 텐데요.

데이터베이스 관리가 어렵게 느껴졌던 분들이라도, 구스와 함께라면 이제 더 이상 두려워할 필요가 없을 겁니다!

더 자세한 정보나 고급 설정 방법이 궁금하시다면, 구스 깃허브(GitHub) 저장소나 공식 문서를 참고해보시는 것을 추천합니다.

자주 묻는 질문 (FAQs)

1. 구스(Goose)는 어떤 데이터베이스들을 지원하나요?
   구스는 포스트그레스(Postgres), 마이SQL(MySQL), SQLite, MSSQL, 클릭하우스(ClickHouse), YDB 등 정말 다양한 데이터베이스와 함께 사용할 수 있습니다.
   
   
2. 구스(Goose)를 사용해서 새로운 SQL 마이그레이션 파일은 어떻게 만드나요?
   goose create <마이그레이션_이름> sql 명령어를 사용하면 새로운 SQL 마이그레이션 파일을 간단하게 만들 수 있습니다.
   
   
3. 구스(Goose)는 SQL 대신 고(Go) 언어로 작성된 마이그레이션도 처리할 수 있나요?
   네, 물론입니다! 구스는 복잡한 변경 사항을 처리하기 위해 고(Go) 함수로 작성된 마이그레이션도 완벽하게 지원합니다.