@0ti.me/postgres-db-versioning 中文文档教程

Question

PostgresDB Versioning

如果关系数据库的数据和表要随着时间的推移正确迁移，则必须对其进行版本控制。 该项目旨在生成一个 NPM 模块，该模块使用依赖于该模块的任何内容提供的配置和版本数据来完成繁重的工作。

Configuration

{
  "connectionConfig": {
    "user": "postgres",
    "password": "postgres",
    "host": "localhost",
    "database": "postgres",
    "port": 54231
  },
  "dryRun": false
  "eventHandler": (...eventArgs) => console.error(event),
  "migrations": [
    {"version": 1, "description": "create the table a_table", "sql": "CREATE TABLE a_table (id INT);"},
    {"version": 2, "description": "add the table another_table", "sql": "CREATE TABLE another_table (id INT);"}
  ],
  "pool": {
    query: sqlString => console.error(sqlString)
  },
  "requestedVersion": 2,
  "scratch": [
    "CREATE TABLE table_name"
  ],
  "tableNameForVersions": "DatabaseVersion",
  "version": 1
}

Connection Config

如果此模块应管理连接，则使用此 API 传入配置对象：https://node-postgres.com/api/client/。

Dry Run

启用此功能后，将要执行的步骤将作为事件发送到事件处理程序。

Event Handler

如果设置了此项，它将发出事件（用于查询的字符串或从将应用于查询函数调用的 (...args) 制作的数组。

例如，如果使用多个参数调用 eventHandler，例如: 'SELECT * FROM x WHERE xy = ?;' 和 ['fred']，那么当计划执行时，它会执行如下内容：

pool.query('SELECT * FROM x WHERE x.y = ?;', ['fred']);

如果仅使用字符串调用 eventHandler，例如 'SELECT * FROM x;' ，它会执行这样的事情：

pool.query('SELECT * FROM x');

Migrations

迁移应该是一个包含版本号的对象数组，一个可选的更改描述，以及应该执行的 sql。

Pool

如果包含，这将被盲目地用于向 DB 发送查询。假设它实现了这个 API：https://node-postgres.com/api/pool/。这个选项优先于 "connectionConfig"，所以不要提供 " pool" 如果您想使用 "connectionConfig"。

Requested Version

如果提供，它将停止尝试迁移到请求的版本。这将禁用使用 如果 "version" 大于 "options"."requestedVersion"，则从头开始。

如果未提供，则 "options"."version" 和 "options"."migrations" 中最高 "version" 的最大值将会被使用。

Scratch

如果提供，scratch 数组将用于在 "tableNameForVersions" 表尚不存在时填充数据库。 "version" 大于 "options"."version" 的迁移也将通过假设 "options"."version"< /code>版本已经实现。

如果未提供，将使用迁移数组。

Table Name for Versions

这允许您更改用于跟踪数据库版本的名称。

Version

这应该与 "scratch" 创建的版本相同。