8.2 Sequelize 환경 setting하기

이 환경설정을 하는데 한참 시간이 걸렸었다 ㅠ 다시한번 차근차근 리뷰해보자..

1. npm 설치

npm install sequelize

npm install mysql

=> 늘 이 단계까지는 너무 순조롭다. sequelize 설치와 내가 사용하려는 mysql을 설치해준다. 

(공식적으로 PostgreSQL, MySQL, MariaDB, SQLite, MS-SQL을 지원한다.) 

설치옵션은 위에는 쓰지 않았지만 --save로 해주는게 좋을 듯 하다.

2. 디렉토리(폴더) 생성

나도 열심히 구글링하면서 따라한 것이라 이런 디렉토리 네이밍이 무조건 맞는지는 모르겠지만 현재 내가 따르고 있는 방법이다.

1) config

=> DB의 정보를 담고 있는 json 파일을 담고있는 디렉토리이다. 해당 디렉토리에 sequelize.json 파일을 생성해준다. 해당 파일의

내용은 이렇다.

{
  "development": {
    "username": "root",
    "password": "1234",
    "database": "test",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "test": {
    "username": "root",
    "password": "1234",
    "database": "scott",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "production": {
    "username": "root",
    "password": "1234",
    "database": "movie",
    "host": "127.0.0.1",
    "dialect": "mysql"
  }
}

내가 노란색으로 칠한 부분이 사용자가 가지고 있는 DB 정보에 따라 달리 작성해줘야 하는 부분이다. 사용언어 부분은 mysql을 쓰기로 했으므로 따로 색칠하지는 않았다. 기본적으로 mysql이 컴퓨터에 설치되어있다고 가정하게 진행하고 있기 때문에 그부분은 생략하고 맨 위부터 차례로 DB 유저명, 유저 패스워드, DB명 순이다.

이렇게해서 일단 DB까지는 접근을 하였다.

2) models 

=> 테이블의 정보를 담고있는 js 파일이 있는 디렉토리이다. 테이블이 생성될 때 해당 디렉토리에 있는 정보를 토대로 테이블을 생성한다. 

일단 내 test DB의 table 정보이다. 보다시피 test라는 DB에 3개의 테이블이 존재하고 그 중에 code 라는 테이블을 이용할 것이다.

바로 이전단계인 config 단계에서 입력한 DB 구조와 일치해야한다. 즉, database 항목에 test라는 DB명을 썻다면 해당 DB가 실제로 존재해야한다는 것이다.

code 테이블의 정보를 담고있는 code.js 파일을 생성하겠다.

module.exports = function (sequelize, DataTypes) {
  const code = sequelize.define('Code', {
      title: {
          field: 'title', type: DataTypes.STRING(10), allowNull: false },
      code: {
          field: 'code', type: DataTypes.STRING(100), allowNull: false },
  }, {
    // don't use camelcase for automatically added attributes but underscore style
    // so updatedAt will be updated_at
    underscored: true,
 
    // disable the modification of tablenames; By default, sequelize will automatically
    // transform all passed model names (first parameter of define) into plural.
    // if you don't want that, set the following
    freezeTableName: true,
 
    // define the table's name
    tableName: 'code'
  });
 
  return code;
};

테이블의 정보를 담고있는 파일로, 여기선 2개의 필드 (title과 code) 를 가진다. 세세한 테이블 정보 (데이터 타입이나 allowNull 과 같은 내용설명은 생략한다.)

조금 익숙치 않은 것들이 처음부터 보인다. 사용자 모듈을 만드는 것인데 결론부터 말하자면 해당 파일이 리턴하는 객체 code를 다른파일에서 쓰기 위함이다. 

define 이라는 메소드로 테이블을 정의하게 된다. define의 매개변수로 들어가는 테이블명 (나는 'Code' 라고 정의) 은 대소문자를 구분하므로 나중에 사용하려 할 때 models에서 정의된 값으로 써줘야한다. 

3. app.js 파일에서 해당 모듈 사용

DB 정의와 테이블 정의까지 끝냈으니 해당 정보를 본인의 웹 어플리케이션에서 사용할 차례이다. 바로 이전에 사용자 모듈이라고 만들었던 것을 사용해야하기 때문에 해당 라인이 필요하다.

var models = require('./models');

require 되어있는 것은 models 라는 디렉토리를 얘기하는 것이다. 

나같은 경우는 위와같이 app.js 파일과 동일한 디렉토리에 models 디렉토리를 만들었기 때문에 ./models 라고 사용한 것이다. 

사용자 모듈을 사용하는 방법이다. 결과로 models 변수에 객체를 전달하게 된다.

그럼 바로 하단에 이 코드를 작성해보자.

models.sequelize.sync()
  .then(() => {
    console.log('✓ DB connection success.');
    console.log('  Press CTRL-C to stop\n');
  })
  .catch(err => {
    console.error(err);
    console.log('✗ DB connection error. Please make sure DB is running.');
    process.exit();
  });

models 변수에 제대로 연결된 DB가 들어가 있다면 success 문이 나올테고 에러가 난다면 catch문에 걸려서 아래의 로그가 찍힐 것이다. 

가장 하단의 2줄이 나오면 일단 DB연결은 성공한 것이다. 위에 나오는 로그들은 위 models 디렉토리에서 테이블을 만들 때 뭔가 좋지 않은 방법으로 만들어서 나오는 경고문? 같다. 일단 여기까지 되었다면 models 디렉토리에 만들었던 테이블들에 접근이 가능하다.

다음 포스팅에서는 흔히 DB 분야에서 말하는 데이터조작어(DDL) 와 데이터정의어(DML) 를 다뤄보도록 하겠다.