23/11/17 TIL __ 시퀄라이즈 마이그레이션 수정 sequelize migration

 

 

🧐 상황 

sequelize-cli 와, aws rds를 이용해 개인과제를 진행하던 중,

이미 만든 테이블을 수정하고 싶었다.

birth_year, birth_day, birth_month, 이 세가지의 컬럼을 삭제하고,

birth_date 라는 컬럼을 추가하며, 타입도 date로 바꾸고 싶었다.

 

 

 

🚗 액션

Sequelize 공식문서를 찾아보니,  아래의 명령어를 통해 수정 파일을 만들 수 있다고 한다.

npx sequelize-cli migration:generate --name 파일이름적기-테이블명

예시 
npx sequelize-cli migration:generate --name modify-user

 

 

그럼 아래와 같은 파일이 생성되는데, up에는 새로 추가하거나 삭제할 내용을 작성하면 된다.

down 에서는 undo를 이용해 마이그레이션을 되돌릴때 수행할 로직을 작성하면 된다.

module.exports = {
  up: (queryInterface, Sequelize) => {
    return queryInterface.createTable('Person', {
      name: Sequelize.DataTypes.STRING,
      isBetaMember: {
        type: Sequelize.DataTypes.BOOLEAN,
        defaultValue: false,
        allowNull: false
      }
    });
  },
  down: (queryInterface, Sequelize) => {
    return queryInterface.dropTable('Person');
  }
};

 

 

 

내 경우 테이블 구조가 user, product 2개였고,

product 테이블에서 user_id 라는 컬럼이 user 테이블에서 가져온 외래키였기 때문에,

user 테이블이 먼저 존재 한 뒤 product 테이블이 있어야만 했다.

 

테이블을 다시 하려면 undo 명령어를 통해 돌린 뒤에 다시 만져야 한다는 글을 봐서

두개의 테이블을 undo 할거면, 그냥 drop 해야하나 고민했지만,

일단은 modify 마이그레이션 파일에서 컬럼 삭제 및 추가를 진행해 보기로 했다.

 

 

 

먼저 기존 테이블에 내용물을 다 삭제해 주고 빈 테이블로 만들어 주었다.

그리고 수정 마이그레이션 파일을 생성한 뒤,

내 경우에는 up에만 작성해 주었다.

 

'use strict';

/** @type {import('sequelize-cli').Migration} */
module.exports = {
	async up(queryInterface, Sequelize) {
		await queryInterface.removeColumn('User', 'birth_year');
		await queryInterface.removeColumn('User', 'birth_month');
		await queryInterface.removeColumn('User', 'birth_day');

		await queryInterface.addColumn('User', 'birth_date', {
			type: Sequelize.DATE
		});
	},
	async down(queryInterface, Sequelize) {
	}
};

 

 

이렇게 작성한 후에, 모델 파일도 동일하게 수정을 해주어야 한다.

이후  아래 명령어를 통해서  테이블을 다시 생성해 주면 된다.

npx sequelize db:migrate

 

 

 

 

 

 

 

사실 up은 알겠는데 down은 그래서 어떻게 사용하는건지 이해가 안갔다.

되돌리는 기능을 어떻게 사용해야 할지 몰라서 나중에 다시 찾아보니,

down 함수는  up 함수에서 수행한 변경 작업을 역순으로 되돌리는 역할을 한다.
up 함수에서 수행한 작업을 역으로 되돌리는 구문을 down 함수에 구현하여 이전 상태로 되돌릴 수 있다.

반드시 정의할 필요는 없으며,
실제 프로덕션 환경에서 데이터베이스 스키마 변경에 실패한 경우 이전상태로 쉽게 롤백 할 수 있다.
만약 정의하지 않는다면, 수동으로 되돌려야 하며, 실수 확률이 높아진다.

 

당장은 필요하지 않지만,

좀더 안전하게 관리하고, 컨틀롤 하기 위해서는 사용하는게 좋겟다는 생각이 들었다.

 

 

 

 

참고한 사이트

https://sequelize.org/docs/v6/other-topics/migrations/

Migrations | Sequelize