npm 包 @moped/db-pg-migrations 使用教程

简介

@moped/db-pg-migrations 是一个在 PostgreSQL 中进行数据库迁移的 npm 包。它提供了一个简单易用的工具，可以轻松创建和管理数据库结构的变化。

安装

通过 npm 安装：

npm install @moped/db-pg-migrations

使用

初始化

在项目中使用该包，需要先执行初始化操作，生成相关的配置文件。

node_modules/.bin/db-pg-migrations init

执行成功后，会在项目根目录生成一个名为 db/pg-migrations.json 的配置文件，该文件包含了数据库连接信息和迁移文件存放位置等。需要根据实际情况配置。

创建迁移文件

在 db/migrations 目录下创建一个新的迁移文件，例如 001_init.sql，并编写 SQL 语句。

-- db/migrations/001_init.sql

CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255) NOT NULL
);

执行迁移

执行以下命令来执行所有未执行的迁移文件。

node_modules/.bin/db-pg-migrations migrate

执行成功后，会在数据库中创建 users 表。

如果想要执行指定的迁移文件，可以通过参数 -t 或 --to 指定迁移文件名。

node_modules/.bin/db-pg-migrations migrate -t 001_init.sql

撤销迁移

执行以下命令来撤销最近一次执行的迁移文件。

node_modules/.bin/db-pg-migrations rollback

如果想要指定撤销的迁移次数，可以通过参数 -c 或 --count 指定次数。

node_modules/.bin/db-pg-migrations rollback -c 2

查看迁移状态

执行以下命令来查看迁移文件的执行状态。

node_modules/.bin/db-pg-migrations status

示例

创建一个基于 Express 的 Web 应用，用到了 @moped/db-pg-migrations 包。

1. 初始化

执行以下命令，生成配置文件。

node_modules/.bin/db-pg-migrations init

1. 创建迁移文件

在 db/migrations 目录下创建一个新的迁移文件，例如 001_init.sql，并编写 SQL 语句。

-- db/migrations/001_init.sql

CREATE TABLE users (
  id SERIAL PRIMARY KEY,
  name VARCHAR(255) NOT NULL
);

1. 配置 Express 应用

在 app.js 中，配置 @moped/db-pg-migrations 包的中间件。

const dbPgMigrations = require('@moped/db-pg-migrations');
const config = require('./db/pg-migrations.json');

app.use(dbPgMigrations(config));

1. 启动应用

启动应用后会自动执行未执行的迁移文件。

node app.js

总结

@moped/db-pg-migrations 是一个简单易用的数据库迁移工具。在项目中使用该包能够快速创建并管理数据库结构的变化。通过该教程的学习，我们可以初步了解如何使用该包，通过简单的配置和命令即可完成数据迁移，具有很高的操作性，能够极大地提高开发效率。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedb993b5cbfe1ea06118a1