Sequelize入门

本文翻译自 Sequelize 的官方文档
原文链接 getting-started
本文由本人独立完成翻译，转载请注明出处 lsbbd's blog

简介

Sequelize 是一个基于 promise 的适用于 Node.js 和 io.js 的 ORM（译者注： Object-Relational Mapping 把关系数据库的表结构映射到对象）。支持的数据库有：PostgreSQL, MySQL, MariaDB, SQLite 以及 MSSQL。

示例用法

var Sequelize = reqire('sequelize');
const sequelize = new Sequelize('database', 'username', 'password');

var User = sequelize.define('user', {
  username: Sequelize.STRING,
  birthday: Sequelize.Date
});

sequelize.sync().then(function () {
  return User.create({
    username: 'janedoe',
    birthday: new Date(1980, 6, 20)
  }).then(function () {
    console.log(jane.get({
      plain: true
    }));
  })
})

安装

Sequelize 可以通过 NPM 来安装。

$ npm install --save sequelize

# 安装需要的数据库驱动之一
$ npm install --save pg pg-store
$ npm install --save mysql   // 同时支持 mysql 和 mariadb
$ npm install --save sqlite3
$ npm install --save tedious // MSSQL

建立连接

Sequelize 在初始化的时候会建立一个连接池，所以每个数据库只需要建立一个连接实例。

var sequelize = new Sequelize('database', 'username', 'password', {
  host: 'localhost',
  dialect: 'mysql'|'mariadb'|'sqlite'|'postgres'|'mssql',

  pool: {
    max: 5,
    min: 0,
    idle: 10000
  },

  // 只适用于 SQLite
  storage: 'path/to/database.sqlite'
});

// 或者可以使用 URL 链接
var sequelize = new Sequelize('postgres://user:[email protected]:5432/dbname');

Sequelize 有一大堆的可选参数，详见 API 参考。

创建你的第一个数据库模型

通过 sequelize.define('name', {atrributes}, {option}) 来定义数据库模型。

var User = new Sequelize.define('user', {
  fistName: {
    type: Sequelize.STRING,
    field: 'first_name' // 这样模型中的属性名为 fistName，而数据库中的列名为 first_name
  },
  lastName: {
    type: sequelize.STRING
  }  
}, {
  freezeTableName: true // 数据库模型的名称和实际数据库名称保持一致
});

User.sync({force: true}).then(function () {
  // 创建表
  return User.create({
    firstName: 'john',
    lastName: 'Hancock'
  });
});

其他的一些可选参数详见模型 API 参考。

应用级别的模型参数

Sequelize 构造函数的 define 参数可以可以为所有模型定义默认的参数。

var sequelize = new Sequelize('connectionUrl', {
  define: {
    timestamp: false  // 默认是 true
  }
});

var User = sequelize.define('user', {}); // 默认使用 timestamp
var Post = sequelize.define('post', {
  timestamp: true // 现在 timestamp 为 true
});

Promises

Sequelize 使用 Promises 来控制异步的流程。如果你对 Promises 还不够熟悉的话，你可能需要复习一下，看看这儿或者这儿。

通常来说，一个 Promise 代表一个会在将来出现的值 -- “我承诺将来会给你一个结果或者错误”。也就是说下面的代码

// 不要这么做
user = User.findOne();

console.log(user.get('firstName'));

不会正常的工作！这是因为 user 是一个 Promise 对象而不是数据库中的数据。正确的使用方式应该像是下面这样：

User.findOne().then(function (user) {
  console.log(usr.get(firstName));
});

等你弄明白了 promises 是什么以及是怎样工作的，使用 bluebird API 参考作为你的工具。事实上，你可能更多的时候会使用 .all。