ORM库 Sequelize 简单使用小结

发表于 | 分类于

什么是 ORM 库

先说一下数据库，比如 MySQL 就是。我们可以使用现成的 MySQL 模块来操作数据库，但需要写 SQL 语句来操作数据库，比较麻烦。
所以就有人封装了 ORM 库，就像一个隔离层一样，我们只需要调用某个语法比如 Note.create()，它的底层就会自动生成对应的 SQL 语句。
而 Sequelize 就是一个 ORM 库。
另外，像 MongoDB 和 Mongoose 也是类似的关系。

安装并引入

安装

1
2
3
$ npm install --save sequelize
// 此处也可选择安装mysql或其他，本文以sqlite为例
$ npm install --save sqlite3

引入

1
2
const Sequelize = require('sequelize')
const path = require('path')

建立数据库

1
2
3
4
5
6
7
8
9
10
11
12
13
14
const sequelize = new Sequelize('database', 'username', 'password', {  // 这三个参数也可填 undefined
  host: 'localhost',    // 数据库地址
  dialect: 'sqlite',    // 数据库类型

  pool: {
    max: 5,             // 连接池最大连接数量
    min: 0,             // 连接池最小连接数量
    acquire: 30000,     // 在抛出错误前尝试连接的最大时间为30秒
    idle: 10000         // 如果一个线程超过10秒钟没有被使用过就释放该线程
  },

  // 只有用 SQLite 时要配置此项
  storage: path.join(__dirname, '../database/database.sqlite')  // 假如该目录下没有该文件，会自动创建
});

测试连接

1
2
3
4
5
6
7
8
sequelize
  .authenticate()
  .then(() => {
    console.log('Connection has been established successfully.');
  })
  .catch(err => {
    console.error('Unable to connect to the database:', err);
  });

运行该文件node test.js，连接成功则会 log 成功。

创建 Model

1
2
3
4
5
6
7
8
9
10
11
12
13
// 创建 Model
const Note = sequelize.define('note', {  // 表名为 note
  text: {    // 字段名
    type: Sequelize.STRING    // 字段类型
  }
})

// 创建或同步表
// User.sync() 会返回一个 Promise 对象
// force = true 时会把存在的表先 drop 掉再创建
Note.sync({force: true})

// 现在就可以增删改查了

增删改查

1
2
3
4
5
6
7
8
9
// 增
Note.create({
    text: 'hello'
})

// 查
Note.findAll({raw: true, where: {id: 1}}).then(notes => {
    console.log(notes)
})

小结

至此，一个基本的数据库就完成了。更多用法还是得参考 Sequelize 的官方文档。