TypeORM 마이그레이션

Oneik·2024년 6월 18일

NestJS typeOrm

마이그레이션이 필요한 이유

기존 프로젝트에서는 synchronize: true 설정을 통해서 데이터베이스 스키마를 설정하였다.

문제는 위와 같은 설정을 한다면 애플리케이션이 시작될 때 TypeORM이 엔티티를 검사하고, 현재 데이터베이스 스키마와 비교한 후, 변경된 부분이 있다면 자동으로 수정한다는 것이다.

개발 환경에서는 즉각적인 피드백을 받을 수 있기 때문에, 유용하게 사용할 수 있지만 프로덕션 환경에서는 의도치 않은 데이터 손실이 발생할 수 있기 때문에, 위와 같은 설정은 지양해야만 한다.

마이그레이션의 장점

안정성

프로젝트는 혼자서 작업하는게 아니다. 여러 개발자가 동시에 작업할 때, 마이그레이션을 사용한다면 데이터베이스 관리자를 통해 모든 변경 사항을 사전에 검토하고 승인할 수 있어 안정성을 높일 수 있다.

버전 관리

누가 어떤 변경을 했는지 쉽게 파악할 수 있고, 각 마이그레이션 파일에는 변경된 날짜와 시간이 포함되어 있기 때문에, 이를 통해 변경 사항이 언제 적용되었는지도 확인할 수 있다.

또한 변경 사항을 적용한 후 문제가 발생했을 때, 개발자가 쉽게 이전 상태로 되돌릴 수 있다.

마이그레이션 사용하기

dataSourceOptions 설정하기

// datasource.config.ts
import { DataSource, DataSourceOptions } from 'typeorm';
import { SnakeNamingStrategy } from 'typeorm-naming-strategies';
import * as dotenv from 'dotenv';
import * as path from 'path';

dotenv.config({
  path: process.env.NODE_ENV === 'production' ? '.production.env' : '.development.env',
});

const entityPath = path.join(__dirname, '../entities/*/*.entity.{js,ts}');
const migrationPath = path.join(__dirname, '../migrations/*.{js,ts}');

export const dataSourceOptions: DataSourceOptions = {
  type: 'mysql',
  host: process.env.DB_HOST,
  port: parseInt(process.env.DB_PORT),
  username: process.env.DB_USERNAME,
  password: process.env.DB_PASSWORD,
  database: process.env.DB_DATABASE,
  entities: [entityPath],
  synchronize: false,
  migrationsRun: false,
  namingStrategy: new SnakeNamingStrategy(),
  migrationsTableName: 'migrations',
  migrations: [migrationPath],
  logging: process.env.NODE_ENV === 'production' ? ['error'] : true,
};

export const MysqlDataSource = new DataSource(dataSourceOptions);

기존 설정에서는 서버가 실행될 때, 데이터베이스와 연동할 수 있었기 때문에, 동적으로 환경 변수를 설정하기 위해서 ConfigService를 사용하였다.

그러나, migration을 실행하기 위해서는 서버가 실행되기 전에 typeorm-cli를 통해 적용해야만 했다.

따라서, dotenv를 이용하여 NODE_ENV에 설정되어 있는 값에 따라 환경 변수를 가져와 사용할 수 있도록 하였다.

dataSourceOptions를 통해 데이터베이스와 연동하기

// typeorm.module.ts
@Module({
  imports: [TypeOrmModule.forRoot(dataSourceOptions)]
  ...
})

export class TypeOrmModule {}

기존에 데이터베이스와 연동하기 위해 작성해놓은 코드가 존재했지만, 데이터베이스의 설정을 일관적으로 유지하기 위해 작성해둔 dataSourceOptions를 가져와 적용하였다.