Sequelize-cli工具的使用一 ——（基础&迁移）

最新推荐文章于 2025-07-29 10:30:00 发布

白菜new

最新推荐文章于 2025-07-29 10:30:00 发布

阅读量2.9k

点赞数 6

CC 4.0 BY-SA版权

分类专栏： sequelize 文章标签： sql 数据库

本文链接：https://blog.csdn.net/qq_43850819/article/details/107234795

sequelize 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了Sequelize-cli工具的使用，包括Sequelize和ORM的概念，Sequelize-cli的安装及数据库操作。重点讲解了如何创建和销毁数据库，以及使用迁移脚本来管理数据库表结构，包括编写up和down方法。此外，还涉及到了配置文件的选项，如env、config等。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Sequelize-cli工具的使用（基础&迁移）

1、Sequelize 与 Sequelize-cli

1-1、Sequelize

Sequelize是一个基于 Node.js 的 ORM 库

1-2、ORM

ORM 全称Object Relational Mapping - 对象关系映射 , 是通过使用描述对象和数据库之间映射的元数据，将面向对象语言程序中的对象自动持久化到关系数据库中。说简单一些，就是操作对象一样去操作数据库，而不是 SQL 。

1-3、Sequelize-cli

Sequelize-cli 是其中一个对立的工具，提供了一些快速操作数据库的功能。比如：创建数据库、创建表等…。比较像 vue 和 vue-cli 的关系

2、 Sequelize-cli

2-1、安装

首先，我们需要安装 Sequelize-cli

npm i -D sequelize-cli

仅仅有这个工具还不够，需要设计到数据库的具体操作，还要安装 Sequelize 。

npm i sequelize

最后，Sequelize 是对 MySQL 、 MSSQL 等数据操作的一种抽象封装，提供了统一的 API ，实际具体的数据库操作需要我们独立安装对应得库，比如，我们要操作得是 MySQL ，那么我们需要安装 mysql2 这个独立得模块。

npm i mysql2

2-1-1、数据库与对应的模块

数据库	模块
MySQL	mysql2@^1.5.2
SQLite	sqlite3@^4.0.0
MariaDB	mariadb
PostgreSQL	pg@^7.0.0
	pg-hstore
MSSQL	tedious@^6.0.0

3、基础概念

首先，我们先了解几个概念，同时通过这几个概念来了解这个工具到底是做什么的。

迁移
种子

3-1、迁移

迁移的功能类似于 Git 。通过它，我们可以追踪数据库的状态以及变更记录，我们会把这些信息存储到指定的文件中，然后执行指定的命令来更新数据库或者恢复到某个原有状态。

3-2、种子

有的时候，我们需要为数据库写入一些测试数据，那么这个时候，我们就可以通过种子来完成这个需求。

4、配置文件

我们在根目录下创建一个文件：.sequelizerc ，这是我们使用 Sequelize-cli 工具的时候读取的配置文件。

const path = require('path');

module.exports = {
    'env':'development',
    'config': path.resolve('src', 'configs/database.json'),
    'seeders-path': path.resolve('src', 'database/seeders'),
    'migrations-path': path.resolve('src', 'database/migrations'),
    'models-path': path.resolve('src', 'database/models'),
    'debug': true
}

4-1、配置选项

4-1-1、 env

设置 Sequelize 的环境变量，默认读取系统的环境变量 NODE_ENV 的值，如果不存在 NODE_ENV 则为 development 。该变量会影响下面config 的读取

4-1-1、 config

Sequelize 数据库配置文件存放目录。

4-1-1、 models-path

数据库模型文件存放目录。

4-1-1、 seeders-path

数据库种子脚本文件存放目录。

4-1-1、 migrations-path

数据库迁移脚本文件存放目录

4-1-1、 debug

是否显示详细的debug信息。

5、数据库配置

按照上面 .sequelizerc 中的配置，我们在 configs 目录下创建一个 database.json 的数据库配置文件，它主要提供链接数据库所需要的一些配置。

{
    "development":{
        //数据库服务器主机
        "host": "127.0.0.1",
        //数据库类型
        "dialect": "mysql",
        //数据库服务器连接用户名
        "username": "root",
        //数据库服务器连接密码
        "password": "",
        //数据库名称
        "database": ""
    },
    "test":{
        // ...
    },
    "production":{
        // ...
    }
}

正如我们看到的，配置文件中默认会有三个不同环境的配置：development 、 test 、 production ，分别对应： 开发环境 、 测试环境 、 生产环境 （我们也可以根据具体情况增减），它会根据 .sequelizerc 中的 env 的值读取不同环境下的配置。

从这里开始执行命令同两种方式

在输入命令前加上 ./node_modules/.bin/sequelize + 命令（举例： db：create）
存到package.json 中的 scripts 对象中（举例： “db:create” : “sequelize db:create”）

6、创建/销毁数据库

做好以上的一些准备工作以后，下面我们就开始来使用 Sequelize-cli 来帮助我们完成第一个工作：创建数据库。

6-1、 sequelize db:create

这条命令可以帮助我们根据当前 env 值找到对应 datbase.json 中的配置，最后根据 database 项创建对应的数据库。

6-2、 sequelize db:drop

这条命令是删除对应数据库的。

7、数据库表结构的操作

有了数据库，下面就需要在数据库中创建我们应用所需要用到的各种表以及表结构（字段）。这个时候就轮到前面提到的迁移脚本上场了！

7-1、创建迁移脚本文件

首先，我们需要在前面定义的迁移脚本目录下创建一些迁移脚本，通常我们会为每一个表每次变更创建一个独立的迁移脚本。我们可以手动直接创建，也可以使用命令来创建。

7-1-1、 sequelize migration:create

./node_modules/.bin/sequelize migration:create --name UserInit

使用这个命令，它可以自动在 migrations 目录下创建一个 时间-迁移文件名.js 的脚本文件。

迁移文件的名称最好能比较直观的体现它的作用和目的。比如UserInit，表示这是一个初始化 User 表的操作。
后续如果对 User 表进行更改，比如增加了一个用户状态的字段，那么可以创建一个 UserAddStatus 的迁移脚本文件。

7-2、编写迁移脚本

脚本其实就是一个Node.js 代码，提供给 sequelize-cli 进行读取执行，每一个脚本通过 module.exports 导出一个包含了 down 和 up 方法的对象

up：执行迁移命令（db:migrate ）的时候调用
down：执行撤销/回滚命令（db:migrate:undo ）的时候调用

7-2-1、queryInterface

Sequelize 提供了一个 queryInterface 对象，该对象下又提供了许多操作数据库结构的各种方法（DDL），如：创建表、字段、索引等。

7-2-1、Sequelize

Sequelize 的核心类，提供了一些数据库相关的常量信息，比如数据类型，也可以进行实例化，用于对数据库中的数据进行操作（DQL 、 DML ）。

7-2-1、up方法

在 up 方法中，我们主要编写创建表结构，或者新增修改表结构的相关代码。

  up: async (queryInterface, Sequelize) => {
    /**
      up 需要返回一个 Promise
      queryInterface.createTable 方法用于创建表
        - 第一个参数是要创建的表的名称
        - 第二个参数是一个对象，用来描述表中包含的字段信息
        - queryInterface.createTable 返回一个 Promise
     */
    return queryInterface.createTable('User',{
      id:{
        //字段类型：数字
        type: Sequelize.INTEGER,
        //设置为主键
        primaryKey:true,
        //自动增长
        autoIncrement:true
      },
      name:{
        //字符串类型（20长度）
        type: Sequelize.STRING(20),
        //值唯一
        unique:true,
        //不允许 null 值
        allowNull: false
      },
      password:{
        //字符串类型（32长度）
        type: Sequelize.STRING(32),
        //不允许 null 值
        allowNull: false
      },
      createdAt: {
        //日期类型
        type: Sequelize.DATE,
        //不允许 null 值
        allowNull: false
      }
    })
  }

type
字段类型，Sequelize 中支持的类型列表，参考后面的 DataTypes
primaryKey
是否为主键
autoIncrement
自动增长
unique
值唯一
allowNull
是否允许Null 值，一般最好不要使用 Null
defaultValue
默认值。
外键

userId: {
    type: Sequelize.INTEGER,
    references: {
        model: 'user',
        key: 'id'
    },
    onUpdate: 'cascade',
    onDelete: 'cascade'
},

7-3 执行迁移脚本

sequelize db:migrate

命令执行成功以后，我们就可以在数据库中看到对应的表以及字段信息了。
操作成功的同时数据库中会有一个叫做 SequelizeMeta 的表，这个表是用来记录我们已经执行过的迁移脚本的。当我们执行迁移命令的时候，它就会把当前执行的迁移脚本记录到该表中，下次执行迁移命令的时候就不会重复的去执行已经执行过的迁移脚本了。

7-4、撤销/回滚

撤销/回滚其实就是编写对应的 down脚本。

7-4-1、 down脚本

down 方法的本质就是 up 方法的一个反向操作。

down: async (queryInterface, Sequelize) => {
	//删除 user 表
    return queryInterface.dropTable('User');
  }

7-4-2、执行down

单次撤销（最近的一次）

sequelize db:migrate:undo

撤销所有

sequelize db:migrate:undo:all

7-5、更新迭代

许多时候，因为项目需求的变更，数据库也需要修改更新。比如，当用户修改信息的时候，我们希望记录下来最后一次修改更新的时间，也就是需要给 user 表新增一个 updateAt 字段。
添加一个新的迁移脚本

sequelize migration:create --name UserAddUpdateAt

脚本

module.exports = {
  up: async (queryInterface, Sequelize) => {
    //给 User 表添加列（字段）: updateAt
    return queryInterface.addColumn('User','updatedAt',{
      type: Sequelize.DATE,
      allowNull:false
    })
  },

  down: async (queryInterface, Sequelize) => {
    //删除 user 表的 updatedAt 列（字段）
    return queryInterface.removeColumn('User','updatedAt');
  }
};