8.6 sequelize-auto 모듈 사용하기

오랜만에 다시 글을 쓰게 됩니다. Sequelize를 쓸 일이 갑자기 생기게 되었네요~ 

이전까지는 sequelize를 이용해 define 된 테이블 정보를 가지고 진행을 했었는데, 만약 Models 디렉토리에 제가 정의하지 않은 테이블이 있다면 그 테이블을 sequelize를 통해 사용할 수 있을까요?

흔히 말하는 DML구문은 sequelize 에서는 Model 객체에서만 있는 메소드 입니다. 이 말은 즉, models 디렉토리에 테이블 정보 파일이 있을 때 findOne이나 update 등과 같은 메소드를 사용할 수 있습니다.

근데 내부 DB에는 있는데 제 models 디렉토리에 그 테이블에 대한 js 파일이 없다면 결국 그 테이블은 조작이 불가능합니다.

예를들면 models  디렉토리안에 이 두개의 파일이 있다고 가정해보겠습니다. index.js 파일은 테이블에 대한 파일이 아니니까 제쳐두고, 이렇게 따지면 sequelize 모듈을 통해 제어할 수 있는 테이블은 mytable이라는 한 개 뿐입니다.

만약 제 DB에 user라는 테이블이 실제 있었다고 해도, 제 models 디렉토리안에 그 DB에 대한 파일이 없다면 제어가 불가능합니다. 사실 기준이 되는건 진짜 물리적인 로컬 DB인데 sequelize 문법 따로, SQL문 따로 테이블을 정의하는게 굉장히 비효율적이죠.

그래서 맨 위의 그림과 같이 로컬 DB에 있는 정보를 Sequelize 문법으로 자동 변환해주어서 테이블을 정의해주는 모듈이 있습니다. 참 다행이죠~

$ npm install sequelize-auto 
이 명령어르 통해 해당 모듈을 설치해줍니다.

만약 제가 이와같은 테이블을 하나 가지고있다고 가정하겠습니다. 

이 테이블을 sequelize 모듈을 이용해서 사용하려면 Model 객체를 얻어야합니다. 즉 이 테이블을 sequelize 문법으로 define한 js 파일이 필요한 것이죠. auto 모듈은 이걸 한번에 해결해줍니다.

//app.js
const Sequelize = require('sequelize');
const SequelizeAuto = require('sequelize-auto');
const auto = new SequelizeAuto('test','root','123',{
  host:'localhost',
  port:'3306'
});
auto.run((err)=>{
  if(err) throw err;
})

굉장히 짧지만 핵심은 run 메서드입니다. 저 메서드가 정상실행시에 models 디렉토리 안에 mytables.js 파일이 자동 생성됩니다. 해당 파일의 내용은 다음과 같습니다.

/* jshint indent: 1 */

module.exports = function(sequelize, DataTypes) {
	return sequelize.define('mytable', {
		id: {
			type: DataTypes.INTEGER(11),
			allowNull: false,
			primaryKey: true,
			autoIncrement: true
		},
		name: {
			type: DataTypes.STRING(10),
			allowNull: false
		}
	}, {
		tableName: 'mytable'
	});
};

이렇게 만들어지면 기존에 했던 것과 같이 models.mytable.findOne 과 같이 메서드를 사용할 수 있게 되겠죠. 모든 테이블이 정확한 구문으로 만들어 지는 지는 아직 완벽하게 테스트해보진 못했지만, 제가 굳이 테이블 정의 파일을 만들지 않아도 된다는 것이 매우 편리한 모듈입니다.