PKG打包Node.js应用时Knex数据库迁移路径错误问题

问题根源 #

PKG打包后，migrations文件夹和knexfile.js会被嵌入到二进制文件的虚拟文件系统中，而非直接生成/app目录下的物理文件夹。Knex默认从当前工作目录查找migrations，自然找不到实际不存在的路径。同时你的PKG配置可能未正确纳入迁移文件，或者路径配置未适配打包环境。

具体解决步骤 #

1. 修正PKG打包配置 #

把migrations文件夹的所有文件同时加入scripts和assets字段，确保JS脚本和其他迁移资源都被打包，修改package.json中的pkg配置：

"pkg": {
  "scripts": ["knexfile.js", "migrations/**/*.js"],
  "assets": ["migrations/**/*"],
  "targets": ["linux-x64"]
}

• scripts：指定需要编译的JS迁移脚本
• assets：兜底包含迁移文件夹下的所有文件（比如SQL模板、其他资源）

2. 调整Knex迁移路径配置 #

修改knexfile.js，通过环境判断动态设置迁移目录，适配PKG打包后的运行环境：

const path = require('path');

// 判断是否处于PKG打包后的运行环境
const isPackaged = typeof process.pkg !== 'undefined';

module.exports = {
  // 你的数据库连接配置示例
  production: {
    client: 'postgres',
    connection: process.env.DATABASE_URL
  },
  // 动态适配的迁移配置
  migrations: {
    directory: isPackaged 
      ? path.join(path.dirname(process.execPath), 'migrations') 
      : path.join(__dirname, 'migrations')
  }
};

• process.execPath：PKG打包后指向二进制文件路径，用path.dirname获取其所在的/app目录
• 非打包环境下，用__dirname指向项目根目录下的原生migrations文件夹

3. 确保代码显式引用Knex配置 #

在启动应用或执行迁移的代码中，手动传入Knex配置，避免依赖默认路径查找：

const knex = require('knex');
const knexConfig = require('./knexfile');

const db = knex(knexConfig.production);

// 启动时自动执行迁移示例
db.migrate.latest()
  .then(() => console.log('数据库迁移完成'))
  .catch(err => console.error('迁移失败:', err));

验证流程 #

1. 重新执行PKG打包：pkg .
2. 将生成的二进制文件放到/app目录
3. 运行二进制文件，检查迁移错误是否消失

内容的提问来源于stack exchange，提问作者ybalcanci