如何在NEST.JS中根据环境变量参数禁用解析器中的迁移？

一、针对TypeORM的场景 #

1. 通过配置文件动态控制迁移 #

利用NestJS的ConfigService读取环境变量，在TypeORM的配置中动态关闭迁移相关选项：

// app.module.ts
import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { ConfigModule, ConfigService } from '@nestjs/config';

@Module({
  imports: [
    ConfigModule.forRoot({ isGlobal: true }),
    TypeOrmModule.forRootAsync({
      useFactory: (configService: ConfigService) => {
        // 读取环境变量并转换为布尔值
        const disableMigrations = configService.get('DISABLE_MIGRATIONS') === 'true';
        
        return {
          type: 'postgres', // 替换为你的数据库类型（mysql/mariadb/sqlite等）
          host: configService.get('DB_HOST'),
          port: configService.get('DB_PORT'),
          username: configService.get('DB_USERNAME'),
          password: configService.get('DB_PASSWORD'),
          database: configService.get('DB_NAME'),
          entities: [__dirname + '/**/*.entity{.ts,.js}'],
          // 禁用迁移时不加载迁移文件
          migrations: disableMigrations ? [] : [__dirname + '/migrations/**/*{.ts,.js}'],
          // 禁用自动运行迁移
          migrationsRun: disableMigrations ? false : true,
          autoLoadEntities: true,
          synchronize: false, // 生产环境务必关闭该选项
        };
      },
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}

2. 控制CLI迁移命令执行 #

如果使用TypeORM CLI执行迁移，可在package.json的脚本中添加条件判断，仅当环境变量未设置时执行迁移：

{
  "scripts": {
    "migrate": "if [ \"$DISABLE_MIGRATIONS\" != \"true\" ]; then nest build && typeorm migration:run -d dist/typeorm.config.js; fi",
    "migrate:revert": "if [ \"$DISABLE_MIGRATIONS\" != \"true\" ]; then nest build && typeorm migration:revert -d dist/typeorm.config.js; fi"
  }
}

二、针对Prisma的场景 #

1. 控制CLI迁移命令执行 #

Prisma的迁移命令可通过脚本条件判断实现禁用：

{
  "scripts": {
    "migrate:dev": "if [ \"$DISABLE_MIGRATIONS\" != \"true\" ]; then prisma migrate dev; fi",
    "migrate:prod": "if [ \"$DISABLE_MIGRATIONS\" != \"true\" ]; then prisma migrate deploy; fi"
  }
}

2. 服务启动时动态控制迁移 #

若需要在NestJS启动时自动执行迁移，可在main.ts中添加环境变量判断：

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ConfigService } from '@nestjs/config';
import { exec } from 'child_process';
import { promisify } from 'util';

const execPromise = promisify(exec);

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const configService = app.get(ConfigService);
  const disableMigrations = configService.get('DISABLE_MIGRATIONS') === 'true';

  if (!disableMigrations) {
    // 执行Prisma生产环境迁移
    await execPromise('prisma migrate deploy');
  }

  await app.listen(3000);
}
bootstrap();

关键注意事项 #

• 确保环境变量DISABLE_MIGRATIONS在.env文件中正确设置（如DISABLE_MIGRATIONS=true）
• 环境变量读取时注意类型转换，因为从环境变量获取的值默认是字符串，需转为布尔值判断
• 生产环境建议关闭TypeORM的synchronize选项，避免自动修改数据库结构

内容的提问来源于stack exchange，提问作者Иван Апевалов