Mikro-ORM 迁移过程中查询日志记录的最佳实践

在数据库迁移过程中，开发者经常会遇到复杂的迁移操作需要执行多个SQL查询语句。这些查询可能包括创建/删除索引、约束条件、重命名列等操作。某些查询可能会消耗异常长的时间执行，这时开发者就需要识别并优化这些耗时查询。

Mikro-ORM 框架提供了多种方式来记录和查看迁移过程中执行的SQL查询语句。虽然框架默认不会显示这些查询细节，但通过配置可以轻松实现查询日志的输出。

为什么需要记录迁移查询

1. 性能问题诊断：当迁移过程"卡住"时，能够快速定位到具体是哪个SQL语句导致的问题
2. 迁移验证：确认迁移脚本实际执行的SQL是否符合预期
3. 调试优化：为优化耗时迁移操作提供依据

启用查询日志记录的方法

Mikro-ORM 提供了两种主要方式来启用迁移过程中的查询日志记录：

1. 通过环境变量启用

设置环境变量 MIKRO_ORM_CLI_VERBOSE=1 是最直接的方式。这会在执行迁移命令时输出所有执行的SQL语句。

MIKRO_ORM_CLI_VERBOSE=1 npm exec mikro-orm -- migration:up

2. 通过配置参数启用

在Mikro-ORM配置文件中设置 verbose: true 也可以达到类似效果：

{
  // ...其他配置
  verbose: true
}

自定义迁移类实现日志记录

对于需要更精细控制的场景，可以创建自定义的迁移基类来记录SQL查询：

import { EntityData } from '@mikro-orm/core';
import { Migration, Query } from '@mikro-orm/migrations';

export abstract class VerboseMigration extends Migration {
  execute(
    sql: Query,
    params?: unknown[],
  ): Promise<Array<EntityData<Partial<any>>>> {
    this.logSql(sql);
    return super.execute(sql, params);
  }

  private logSql(query: Query) {
    const sql = typeof query === 'string' ? query : query.toSQL().sql;
    console.log(`> ${sql}`);
  }
}

然后让所有迁移类继承这个自定义类而非默认的Migration类。

注意事项

1. 启用查询日志会增加输出信息量，可能包含框架内部使用的模式查询
2. 在生产环境中应谨慎使用，避免日志信息泄露敏感数据
3. 对于PostgreSQL，还可以通过设置 log_statement=all 参数让数据库记录所有查询

通过合理使用这些日志记录方法，开发者可以更好地理解和优化Mikro-ORM的数据库迁移过程，提高开发效率和系统性能。