Objection.js 在 MSSQL 中实现 Upsert 操作的解决方案

背景介绍

在数据库操作中，Upsert（Update or Insert）是一种常见的需求，它指的是当记录存在时更新，不存在时插入。许多现代数据库如PostgreSQL、MySQL和SQLite都原生支持这种操作。然而在MSSQL环境中，实现这一功能却面临诸多挑战。

问题分析

Objection.js作为基于Knex的ORM框架，虽然为PostgreSQL、MySQL和SQLite提供了原生的onConflict方法来实现Upsert，但在MSSQL中这一功能却不可用。这主要是因为：

1. MSSQL的MERGE语句存在已知的性能问题和潜在风险
2. MSSQL没有提供与PostgreSQL的ON CONFLICT类似的简洁语法
3. 需要处理主键冲突错误(错误代码2627)的特殊情况

解决方案实现

针对MSSQL环境，我们可以通过扩展Objection.js的BaseModel类来实现一个自定义的insertMerge方法。这种方法的核心思路是：

1. 首先尝试执行普通插入操作
2. 捕获主键冲突错误(错误代码2627)
3. 将待插入数据分为需要插入的新数据和需要更新的现有数据
4. 分别执行插入和更新操作

以下是实现代码示例：

static async insertMerge(trx, created) {
  await this.query(trx)
    .insert(created)
    .onError(async (error, _query) => {
      if (error.number === 2627) {
        const createdIDs = created.map(l => l.id);
        const conflicts = await this.query(trx).whereIn('id', createdIDs);
        const inserts = _.differenceBy(created, conflicts, 'id');
        const updates = _.differenceBy(created, inserts, 'id');

        if (inserts.length > 0) {
          await this.query(trx).insert(inserts);
        }

        if (updates.length > 0) {
          for (const x of updates) {
            const updateData = _.omit(x, ['id', ...其他需要忽略的列]);
            await this.query(trx).where('id', x.id).patch(updateData);
          }
        }
      } else {
        return Promise.reject(error);
      }
    });
}

实现细节说明

1. 错误处理：通过onError回调捕获插入操作中的错误，特别处理主键冲突错误(2627)

2. 数据分离：使用lodash的differenceBy方法将数据分为需要插入和需要更新的两部分

3. 批量处理：先处理所有需要插入的记录，再逐个处理需要更新的记录

4. 字段过滤：更新时使用omit方法排除主键ID和其他不应更新的字段（如创建时间戳等）

注意事项

1. 事务管理：确保在事务中执行此操作，以保持数据一致性

2. 性能考虑：对于大量数据，可能需要考虑分批处理

3. 错误处理：除了主键冲突外，其他错误应正常抛出

4. 字段排除：根据业务需求，明确哪些字段在更新时应该被排除

替代方案

除了上述方法外，还可以考虑：

1. 修改Knex的MSSQL编译器，添加对onConflict的支持
2. 使用存储过程处理复杂的Upsert逻辑
3. 在应用层实现更复杂的冲突解决策略

总结

在MSSQL环境中实现Upsert操作确实比在其他数据库中更为复杂。通过扩展Objection.js的BaseModel并实现自定义的insertMerge方法，我们可以在保持代码整洁的同时解决这一问题。这种方法虽然不如原生支持优雅，但在当前技术限制下提供了一个可靠的工作解决方案。