데이터베이스 마이그레이션 도우미
이 스킬은 프로젝트의 ORM 규칙과 명명 패턴에 맞는 데이터베이스 마이그레이션 파일을 만드는 데 도움을 줍니다.
이 스킬을 사용해야 할 때
- 사용자가 데이터베이스 마이그레이션 생성을 요청할 때
- 새 테이블이나 컬럼을 데이터베이스에 추가할 때
- 기존 데이터베이스 스키마를 수정할 때
- 인덱스, 제약 조건 또는 관계를 생성할 때
- 사용자가 "마이그레이션", "스키마 변경", "데이터베이스 업데이트"를 언급할 때
지침
1. ORM/마이그레이션 도구 감지
먼저 프로젝트에서 사용하는 ORM 또는 마이그레이션 도구를 식별합니다:
- Prisma:
prisma/schema.prisma또는 package.json의@prisma/client확인 - Sequelize:
.sequelizerc또는 package.json의sequelize-cli확인 - Knex:
knexfile.js또는 package.json의knex확인 - TypeORM:
ormconfig.json또는 package.json의typeorm확인 - Alembic (Python):
alembic.ini또는alembic/디렉토리 확인 - Django:
manage.py및*/migrations/경로의 Django 마이그레이션 확인 - Active Record (Rails):
db/migrate/디렉토리 확인 - Flyway:
flyway.conf또는db/migration/확인 - Liquibase:
liquibase.properties또는 체인지로그 파일 확인
Glob을 사용하여 이러한 표시 파일을 검색합니다.
2. 기존 마이그레이션 확인
기존 마이그레이션 파일을 읽어 다음 사항을 이해합니다:
- 명명 규칙 (타임스탬프 형식, 설명 형식)
- 디렉토리 구조
- 마이그레이션 파일 형식 (SQL, JavaScript, TypeScript, Python 등)
- 코딩 패턴 (up/down 함수, forwards/rollback 등)
Grep을 사용하여 최근 마이그레이션을 찾습니다. 일반적인 디렉토리:
prisma/migrations/db/migrate/migrations/또는database/migrations/alembic/versions/
3. 마이그레이션 파일 생성
감지된 ORM에 따라 적절한 마이그레이션 파일을 생성합니다:
Prisma
npx prisma migrate dev --name <설명>실행 또는prisma/migrations/<타임스탬프>_<이름>/migration.sql에 수동으로 마이그레이션 SQL 생성
Sequelize
- 생성:
npx sequelize-cli migration:generate --name <설명> - 그런 다음 up/down 함수에 스키마 변경 내용을 작성
Knex
- 생성:
npx knex migrate:make <설명> exports.up및exports.down함수를 작성
TypeORM
- 생성:
npm run typeorm migration:create src/migrations/<이름> up()및down()메서드 구현
Alembic
- 생성:
alembic revision -m "<설명>" upgrade()및downgrade()함수를 작성
Django
- 실행:
python manage.py makemigrations - 또는
<앱>/migrations/에 수동으로 마이그레이션 생성
Rails
- 생성:
rails generate migration <클래스이름> change메서드 (또는 복잡한 마이그레이션의 경우 up/down)를 작성
4. 명명 규칙 준수
일관되고 설명적인 이름을 사용합니다:
- 좋은 예:
add_user_email_index,create_products_table,add_payment_status_to_orders - 나쁜 예:
migration1,update,fix
프로젝트 패턴에 따라 형식 지정:
- 타임스탬프 접두사:
20231215120000_add_email_to_users - 순차적:
001_create_users,002_add_indexes
5. Up 및 Down/Rollback 모두 포함
지원되는 경우 항상 두 방향을 모두 제공합니다:
- Up/Upgrade/Forward: 스키마 변경 적용
- Down/Downgrade/Rollback: 스키마 변경 되돌리기
가역적 작업을 사용하는 ORM(Rails, 일부 Sequelize)의 경우 단일 change 메서드로 충분할 수 있습니다.
6. 마이그레이션 내용 가이드라인
테이블 생성:
- 적절한 유형으로 모든 컬럼 정의
- 적절한 위치에 NOT NULL 제약 조건 설정
- 기본 키 추가
- 프로젝트에서 사용하는 경우 타임스탬프(created_at, updated_at) 포함
- 동일한 마이그레이션에 외래 키 및 인덱스 추가하거나 프로젝트 선호도에 따라 별도로 추가
테이블 변경:
- 구체적으로 작성:
ADD COLUMN,DROP COLUMN,MODIFY COLUMN - 기존 데이터를 적절히 처리 (기본값, 백필)
- 역호환성 고려
인덱스 추가:
- 인덱스 이름을 명확하게 지정:
idx_users_email,idx_orders_user_id_created_at - 적절한 인덱스 유형 사용 (B-tree, Hash, GIN 등)
- 큰 테이블의 경우 부분 인덱스 고려
데이터 마이그레이션:
- 가능하면 스키마 마이그레이션과 데이터 마이그레이션을 분리
- 대규모 데이터셋에 주의 (일괄 작업)
- 실제적인 데이터 볼륨으로 롤백 테스트
7. 마이그레이션 안전성 검증
최종 확정 전에 다음 사항을 확인:
- 가역성: 마이그레이션을 롤백할 수 있습니까?
- 데이터 손실: 데이터가 손실됩니까? 사용자에게 경고!
- 다운타임: 테이블이 잠깁니까? 큰 테이블의 경우 온라인 마이그레이션 고려
- 의존성: 먼저 실행해야 하는 의존 마이그레이션이 있습니까?
8. 테스트 권장 사항
사용자에게 제안:
- 먼저 개발 데이터베이스에서 마이그레이션 실행
- 롤백 기능 테스트
- 프로덕션의 경우: 스테이징 환경에서 테스트
- 생성된 SQL 검토 (자동 생성하는 ORM의 경우)
ORM별 템플릿
templates/ 디렉토리의 템플릿을 참조:
prisma-migration.sql- Prisma 마이그레이션 예제sequelize-migration.js- Sequelize 마이그레이션 예제knex-migration.js- Knex 마이그레이션 예제typeorm-migration.ts- TypeORM 마이그레이션 예제alembic-migration.py- Alembic 마이그레이션 예제rails-migration.rb- Rails 마이그레이션 예제
모범 사례
- 마이그레이션당 하나의 목적: 관련 없는 변경 사항을 혼합하지 마십시오.
- 설명적인 이름: 이름은 마이그레이션의 작업을 설명해야 합니다.
- 타임스탬프: 순서 지정을 위해 ORM의 타임스탬프 형식을 사용합니다.
- 가능하면 멱등성: 여러 번 실행해도 안전해야 합니다.
- 롤백 테스트: down/rollback이 올바르게 작동하는지 확인합니다.
- 복잡한 로직 문서화: 명확하지 않은 작업에는 주석을 추가합니다.
- 대규모 작업 일괄 처리: 많은 행에 영향을 미치는 데이터 마이그레이션의 경우.
- 트랜잭션 사용: 지원되는 경우 작업을 트랜잭션으로 묶습니다.
지원 파일
templates/: 다양한 ORM을 위한 마이그레이션 템플릿reference.md: 명명 규칙 및 마이그레이션 패턴