친절하게도 Sequelize는 한글판 공식 Docs가 있다.

Sequelize 공식 Docs

이 문서의 구성

1. Sequelize란
2. 사용을 위해 필요한 패키지
3. ./models/index.js
4. ./models 디렉터리 내용
5. MySQL을 app.js에 연결하기
6. Sequelize로 모델 정의
7. Sequelize로 관계 정의
8. Sequelize 쿼리

Sequelize란

• MySQL 작업을 쉽게 할 수 있도록 도와주는 라이브러리
• ORM(Object-Relational Mapping) - 자바스크립트 객체와 데이터베이스의 Relation(Table)을 매핑해주는 도구
• MariaDB, PostgreSQL, SQLite, MSSQL 등 SQL 문법을 사용하는 데이터베이스와도 같이 사용할 수 있음
• 자바스크립트 구문을 알아서 SQL 로 바꿔주기 때문에 자바스크립트만으로 MySQL을 조작할 수 있음

사용을 위해 필요한 패키지

• sequelize - npm정보
• mysql2 - npm정보
• sequelize-cli - npm정보

위의 패키지들을 설치하고 해당 디렉터리로 이동하여

$ sequelize init

을 실행하면 express-generator 기본 구조에 config, models, migrations, seeders 폴더가 생성된다.

./models/index.js

• ./models/index.js 는 var name = require(__dirname + '/models) 만으로도 연결이 가능하다. models 디렉토리에 연결하면 자동으로 index.js에 연결된다.

sequelize-cli가 기본으로 생성해주는 models/index.js 의 코드는 다음과 같다.

'use strict';

const fs = require('fs');
const path = require('path');
const Sequelize = require('sequelize');
const basename = path.basename(__filename);
const env = process.env.NODE_ENV || 'development';
const config = require(__dirname + '/../config/config.json')[env];
const db = {};

let sequelize;
if (config.use_env_variable) {
  sequelize = new Sequelize(process.env[config.use_env_variable], config);
} else {
  sequelize = new Sequelize(config.database, config.username, config.password, config);
}

fs
  .readdirSync(__dirname)
  .filter(file => {
    return (file.indexOf('.') !== 0) && (file !== basename) && (file.slice(-3) === '.js');
  })
  .forEach(file => {
    const model = sequelize['import'](path.join(__dirname, file));
    db[model.name] = model;
  });

Object.keys(db).forEach(modelName => {
  if (db[modelName].associate) {
    db[modelName].associate(db);
  }
});

db.sequelize = sequelize;
db.Sequelize = Sequelize;

module.exports = db;

zerocho님 왈, 그대로 사용하면 에러가 발생하고 필요한 없는 부분도 많다고 한다. 따라서 필요없는 부분을 삭제하고 수정하면 해서 다음과 같은 코드를 쓴다. 아마 여러개의 DB에 접근하려면 Sequelize 인스턴스 여러개 생성하고 config에 속성을 여러개 부여해놓아야 할 듯 하다.(배열로 하면 될듯? - 아직 모름)

const path = require('path');
const Sequelize = require('sequelize');

const env = process.env.NODE_ENV || 'development';
const config = require(path.join(__dirname, '..', 'config', 'config.json'))[env];
// env 변수에 맞는 config.json 내의 속성을 가져와서 config 객체 변수에 속성을 저장한다.
// .env로 NODE_ENV를 설정했으면 .env에서 불러오고 아니면 'development'를 사용한다.

const db = {};
// 이건 뭘까. export를 위한 객체 변수인 것 같다.

const sequelize = new Sequelize(config.database, config.username, config.password, config);

db.sequelize = sequelize;
db.Sequelize = Sequelize;
// 이 두 문장을 실행하고 나면 db 객체는 다음과 같이
// property에 seqeulize와 Sequelize 두 property가 추가된다. (ES2015+)
// db = {
//   seqeulize,
//   Seqeulize,
// };

module.exports = db;

./models 디렉터리 내용

models 디렉터리에는 MySQL의 Table과 대응되는 Sequelize의 Model들을 정의해야 한다.

module.exports = (sequelize, DataTypes) => {
  return sequelize.define('table_name' , {
    // column 들의 프로퍼티
    // property.key - 테이블 옵션명 / property.value - 테이블 옵션 설정값
  },
  {
    // 기타 테이블 옵션
  });
};

define 메서드는 다음과 같다.

sequelize.define([table_name], { column 정의 }, { 테이블 옵션 });<br>

1. 첫번째 param은 테이블 명이다.

• 기본적으로 table_name + 's' 로 테이블 명이 설정된다.

2. 두번째 param은 테이블 column에 대한 정의이다.

MySQL 속성	Sequelize 속성명	Sequelize 속성값	내용
id			Sequelize는 알아서 id를 기본 키로 연결, 따로 설정할 필요 없음
	type	DataTypes.	자료형 설정
VARCHAR		STRING	스트링
INT		INTEGER	정수형
TINYINT		BOOLEAN	블리언
DATETIME		DATE	시간
UNSIGNED		.USIGNED	INT 옵션
ZEROFILL		.ZEROFILL	INT 옵션
NOT NULL	allowNull	true / false	null 허용 여부
UNIQUE	unique	true / false	row 중복 허용 여부
DEFAULT	defaultValue	[넣을 값]	기본값 설정

3. 세번째 param은 테이블 옵션이다.

Sequelize 옵션명	속성 값	특징

MySQL을 app.js에 연결하기

Sequelize로 모델 정의

Sequelize로 관계 정의

Sequelize 쿼리