Sequelize Docs 中文版

此项目同步自 sequelize / sequelize 项目中的 docs. 除特殊情况, 将保持每月一次的同步频率.

更新日志请参阅: CHANGELOG

Sequelize 是一个基于 promise 的 Node.js ORM, 目前支持 Postgres, MySQL, SQLite 和 Microsoft SQL Server. 它具有强大的事务支持, 关联关系, 读取和复制等功能.

文档

• Getting started - 入门
• Model definition - 模型定义
• Model usage - 模型使用
• Querying - 查询
• Instances - 实例
• Associations - 关联
• Transactions - 事务
• Scopes - 作用域
• Hooks - 钩子
• Raw queries - 原始查询
• Migrations - 迁移
• Upgrade to V4 - 升级到 V4
• Upgrade to V5 - 升级到 V5
• Working with legacy tables - 使用遗留表

使用示例

Basic usage - 基本用法

const Sequelize = require('sequelize');
const sequelize = new Sequelize('database', 'username', 'password', {
  host: 'localhost',
  dialect: 'mysql'|'sqlite'|'postgres'|'mssql',

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

  // 仅限 SQLite
  storage: 'path/to/database.sqlite',

  // 请参考 Querying - 查询 操作符 章节
  operatorsAliases: false
});

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

sequelize.sync()
  .then(() => User.create({
    username: 'janedoe',
    birthday: new Date(1980, 6, 20)
  }))
  .then(jane => {
    console.log(jane.toJSON());
  });

请通过 Getting started - 入门 来学习更多相关内容。 如果你想要学习 Sequelize API 请通过 API Reference (英文)。