NestJS 使用 TypeORM CLI 高效管理数据库变更在 NestJS 项目中，利用 TypeORM CLI 管

前置准备

安装 typeorm 可以全局安装 npm i -g typeorm 或者项目内安装 npm i typeorm 均可

本次示例使用项目内安装 npm i typeorm

安装 ts-node nestjs 项目一般已经自动安装了,如果没有则执行 npm install ts-node --save-dev 安装

修改 package.json

在 package.json 的 scripts 部分添加如下内容：

"scripts": {
    ...
     "typeorm": "typeorm-ts-node-commonjs -d ./ormConfig.ts",
    "migration:create": "typeorm-ts-node-commonjs -- migration:create",
    "migration:generate": "npm run typeorm -- migration:generate ./migrations/all",
    "migration:run": "npm run typeorm -- migration:run",
    "migration:revert": "npm run typeorm -- migration:revert"
}

创建 ormConfig.ts

typeorm cli 需要连接到数据库才能知道有哪些变动需要迁移,所以 ormConfig.ts 就是连接数据库的配置文件

具体配置可以直接查看 ts 类型文件或者猛击访问官方文档

执行 pnpm i dotenv 安装 dotenv 用来加载环境变量

env 文件

MYSQL_USER=root
MYSQL_PASSWORD=123456
MYSQL_DATABASE=nest_demo
MYSQL_HOST=localhost
MYSQL_PORT=3306

JWT_SECRET=xxxxxxx

ormConfig.ts

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

// 1. 设置环境变量指定要加载的配置文件路径
// 默认会加载 .env 文件,这里会加载其他的配置文件如 .env.pro 文件
process.env.DOTENV_CONFIG_PATH = path.resolve(__dirname, '.env');

// 2. 加载并解析指定的配置文件
dotenv.config();

const { MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_PASSWORD, MYSQL_DATABASE } =
  process.env;

// 这里到处是为了给 app.module.ts 中使用
export const AppDataSourceOptions: DataSourceOptions = {
  type: 'mysql',
  host: MYSQL_HOST,
  port: Number(MYSQL_PORT),
  username: MYSQL_USER,
  password: MYSQL_PASSWORD,
  database: MYSQL_DATABASE,
  entities: [__dirname + '/**/*.entity{.ts,.js}'],
  synchronize: false,
  logging: ['schema', 'query', 'error', 'warn', 'migration'],
  migrations: [__dirname + '/migrations/*{.ts,.js}'],
};

const AppDataSource = new DataSource(AppDataSourceOptions);

export default AppDataSource;

生成迁移文件

执行 npm run migration:generate

看到如下内容则表示本地实体与数据库一致没有改动!

我们可以修改下数据库实体再看下,这里修改 logs.entity.ts 文件增加三个字段

再次执行 npm run migration:generate

"migration:generate": "npm run typeorm -- migration:generate ./migrations/all"

./migrations/all 指定了生成迁移文件的存储路径

等同于 npx typeorm-ts-node-commonjs migration:generate -d ./ormConfig.ts ./migrations/all

输出如下表示成功,可以看到文件正确输出到了指定的目录下