如何通过TypeOrmModule.forRootAsync生成TypeORM迁移文件？

问题说明 #

执行migration:create创建空迁移文件正常，但运行迁移生成命令时出错：

Error: Given data source file must contain export of a DataSource instance

使用的生成命令：

yarn run typeorm migration:generate ./src/migrations -d ./src/database/database.provider.ts

当前项目通过TypeOrmModule.forRootAsync配置数据源，不想用旧版的ormconfig.json，尝试过旧命令也没解决。

核心原因 #

TypeORM的CLI工具需要直接读取导出的DataSource实例，而你当前的database.provider.ts导出的是Nest封装的动态模块（DynamicModule），CLI无法识别其中的数据库配置逻辑。

解决步骤 #

1. 新建CLI专用的数据源配置文件 #

在src/database/下创建data-source.ts，直接导出DataSource实例：

import { DataSource, DataSourceOptions } from 'typeorm';
import * as dotenv from 'dotenv';
import * as path from 'path';

// 加载.env环境变量（CLI运行时没有Nest的ConfigService上下文）
dotenv.config({ path: path.resolve(process.cwd(), '.env') });

const dataSourceOptions: DataSourceOptions = {
  type: 'postgres',
  host: process.env.DATABASE_HOST,
  username: process.env.DATABASE_USERNAME,
  password: process.env.DATABASE_PASSWORD,
  port: parseInt(process.env.DATABASE_PORT, 10),
  database: process.env.DATABASE_NAME,
  autoLoadEntities: true,
  synchronize: false,
  migrations: [path.join(__dirname, '../migrations/*{.ts,.js}')],
};

export const AppDataSource = new DataSource(dataSourceOptions);

2. 修改迁移生成命令 #

把原来的命令改成指向新的data-source.ts文件（记得替换[迁移文件名]为实际名称）：

yarn run typeorm migration:generate ./src/migrations/[迁移文件名] -d ./src/database/data-source.ts

3. 优化：避免配置重复（可选） #

如果不想在两个地方写重复的数据库配置，可以抽离配置逻辑：

新建src/database/config.ts

import { DataSourceOptions } from 'typeorm';
import { ConfigService } from '@nestjs/config';

export const getDataSourceOptions = (config?: ConfigService): DataSourceOptions => {
  // 优先用Nest的ConfigService，没有则直接读环境变量
  const getEnv = (key: string) => config?.get(key) || process.env[key];

  return {
    type: 'postgres',
    host: getEnv('DATABASE_HOST'),
    username: getEnv('DATABASE_USERNAME'),
    password: getEnv('DATABASE_PASSWORD'),
    port: parseInt(getEnv('DATABASE_PORT'), 10),
    database: getEnv('DATABASE_NAME'),
    autoLoadEntities: true,
    synchronize: false,
    migrations: [__dirname + '/../migrations/*{.ts,.js}'],
  };
};

修改原database.provider.ts

import { DynamicModule } from "@nestjs/common";
import { ConfigService } from "@nestjs/config";
import { TypeOrmModule } from "@nestjs/typeorm";
import { getDataSourceOptions } from './config';

export const DatabaseProvider: DynamicModule = TypeOrmModule.forRootAsync({
  inject: [ConfigService],
  async useFactory(config: ConfigService) {
    return getDataSourceOptions(config);
  }
})

修改data-source.ts

import { DataSource } from 'typeorm';
import * as dotenv from 'dotenv';
import * as path from 'path';
import { getDataSourceOptions } from './config';

dotenv.config({ path: path.resolve(process.cwd(), '.env') });

export const AppDataSource = new DataSource(getDataSourceOptions());

4. 保持原有模块不变 #

你的DatabaseModule不需要修改，依然可以正常引入DatabaseProvider，不影响项目运行时的数据库连接。

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