Sequelize 是一个 Node.js 的 ORM(Object Relational Mapping)库,它支持 MySQL、PostgreSQL、SQLite 和 MSSQL 数据库,让我们可以用 JavaScript 的方式进行数据库操作。Sequelize 让我们可以方便的进行数据库管理和数据建模,但是项目开发过程中,数据库迁移是必不可少的,Sequelize CLI 就是用来解决数据库迁移的工具。本文将详细介绍 Sequelize CLI 的用法。
安装 Sequelize CLI
首先,我们需要安装 Sequelize CLI:
npm install --save-dev sequelize-cli
安装完成后,我们可以在命令行中使用 sequelize 命令,执行 Sequelize CLI 的所有操作。
初始化 Sequelize
在创建项目之前,我们需要先初始化 Sequelize,使用以下命令即可:
sequelize init
执行上面的命令后,Sequelize 会在项目根目录创建一个 config、models 和 seeders 目录和一个 .sequelizerc 配置文件。其中,config 目录用于存放数据库的配置文件,models 目录用于存放数据模型,seeders 目录用于存放数据填充脚本。
创建数据模型
在 models 目录下创建数据模型文件,文件名以 .js 结尾,例如:
-- -------------------- ---- -------
-------------- - -------- ----------- ---------- -
------ ------------------------- -
--- -
----- ------------------
----------- -----
-------------- ----
--
----- -
----- -----------------
---------- -----
--
------ -
----- -----------------
---------- ------
------- ----
--
--------- -
----- -----------------
---------- -----
--
---------- ---------------
---------- --------------
-- -
---------- -------
---
--在上面的示例中,我们定义了一个 users 表、包含 id、name、email、password、createdAt 和 updatedAt 六个字段。其中,id 为主键自增的整型,name、email 和 password 为必填的字符串类型,email 同时设置了唯一性。createdAt 和 updatedAt 分别用来存储数据创建时间和更新时间。
创建迁移文件
数据库迁移是指在数据库架构发生变化时,通过执行一系列数据库操作,将旧的架构改变为新的架构。在 Sequelize 中,我们也需要通过创建迁移文件来进行数据库迁移。使用 Sequelize CLI 创建迁移文件的命令是:
sequelize migration:create --name create-users
执行上面的命令后,在 migrations 目录下会创建一个名为 20211202000000-create-users.js 的文件,文件名的前缀是一个时间戳,用来表示迁移文件的版本。在上面的示例中,我们使用了 create-users 作为迁移文件的名称,表示这个文件是用来创建 users 表的。
在迁移文件中,我们需要编写两个方法:up 和 down。up 方法用来进行数据库的更新或创建,down 方法用来回滚数据库操作。在上面的示例中,我们将创建 users 表的 SQL 语句放在了 up 方法中,把删除 users 表的 SQL 语句放在了 down 方法中:
-- -------------------- ---- -------
---- --------
-------------- - -
--- ----- ---------------- ---------- -- -
------ ----------------------------------- -
--- -
----- ------------------
----------- -----
-------------- ----
--
----- -
----- -----------------
---------- -----
--
------ -
----- -----------------
---------- ------
------- ----
--
--------- -
----- -----------------
---------- -----
--
---------- ---------------
---------- --------------
---
--
----- ----- ---------------- ---------- -- -
------ ----------------------------------
-
--编写完成迁移文件后,我们可以使用以下命令来执行迁移操作:
sequelize db:migrate
执行上面的命令后,Sequelize 会自动将数据库迁移到最新的版本。
如果我们需要撤销迁移操作,可以使用以下命令:
sequelize db:migrate:undo
这个命令会撤销上一个迁移操作。
数据填充
在项目开发过程中,我们有时需要向数据库中插入一些初始数据。这时,就可以使用数据填充功能,使用 Sequelize CLI 创建数据填充文件的命令是:
sequelize seed:generate --name demo-users
执行上面的命令后,Sequelize 会在 seeders 目录下创建一个名为 demo-users.js 的文件,我们可以在这个文件中插入初始数据:
-- -------------------- ---- -------
---- --------
-------------- - -
--- ----- ---------------- ---------- -- -
------ ---------------------------------- --
----- ------
------ ------------------
--------- -----------
---------- --- -------
---------- --- ------
-- -
----- --------
------ --------------------
--------- -----------
---------- --- -------
---------- --- ------
--- ----
--
----- ----- ---------------- ---------- -- -
------ ---------------------------------- ----- ----
-
--编写完成后,我们可以使用以下命令来执行数据填充操作:
sequelize db:seed:all
执行上面的命令后,Sequelize 会自动向数据库中插入初始数据。
如果我们需要清空数据填充的数据,可以使用以下命令:
sequelize db:seed:undo:all
这个命令会清空所有填充的数据。
总结
本文详细介绍了 Sequelize CLI 的用法,包括初始化 Sequelize、创建数据模型、创建迁移文件、执行迁移操作、数据填充等内容。当我们需要对数据库进行管理和迁移时,Sequelize CLI 可以帮助我们完成这些工作,提高了开发效率和代码质量。
Source: FunTeaLearn,Please indicate the source for reprints https://funteas.com/post/646590c6968c7c53b063cf04