Typeorm-Model-Generator 教程

Typeorm-Model-Generator 教程

typeorm-model-generatorGenerates models for TypeORM from existing database.项目地址:https://gitcode.com/gh_mirrors/ty/typeorm-model-generator

1. 项目目录结构及介绍

Typeorm-Model-Generator 的基本目录结构通常包括以下几个部分：

• src/: 存放源代码的主要目录。

  • index.ts: 主入口文件，包含命令行接口的实现。
  • generator.ts: 生成器的核心逻辑，负责解析数据库结构并创建TypeORM实体模型。
  • options.ts: 包含命令行选项的定义。
  • templates/: 模板文件夹，存储生成实体类的模板。

• package.json: 项目基本信息，包括依赖和脚本配置。

• .gitignore: 版本控制忽略文件列表。

此外，还有 README.md 和 LICENSE 文件，分别包含项目说明和许可信息。

2. 项目的启动文件介绍

由于Typeorm-Model-Generator 是一个命令行工具，其启动主要依赖于 npm 或 yarn 的运行。一般用户不会直接运行项目的源代码，而是全局安装后使用 CLI 命令。如果你想要本地运行，可以使用以下命令：

$ npm run index

或者，如果你已经全局安装了这个工具，可以通过以下命令生成实体模型：

$ typeorm-model-generator

请注意，运行命令时需要提供数据库连接和其他必要的参数，这些参数可以通过命令行选项指定（详细信息请参考下一步）。

3. 项目的配置文件介绍

Typeorm-Model-Generator 不依赖特定的配置文件来工作。它通常通过命令行参数接收数据库连接信息和生成选项。例如：

typeorm-model-generator -h hostname -d database -p port -u username -x password -e engine -o outputDirectory

• -h / --host: 数据库服务器的IP地址或域名。
• -d / --database: 要连接的数据库名称。
• -p / --port: 数据库服务器的端口号。
• -u / --user: 登录数据库的用户名。
• -x / --password: 数据库密码。
• -e / --engine: 数据库引擎类型（如 mysql, postgres 等）。
• -o / --output-dir: 生成文件的目标目录。

如果你频繁地使用相同配置，你可能会希望把这些配置存放在一个环境变量文件或者在你的项目根目录下创建一个 ormconfig.json 文件，然后通过 --config 参数指向这个文件。ormconfig.json 示例：

{
  "type": "mysql",
  "host": "localhost",
  "port": 3306,
  "username": "root",
  "password": "your_password",
  "database": "testdb",
  "entities": ["./dist/**/*.entity.js"],
  "cli": {
    "migrationsDir": "./src/migration"
  }
}

然后，运行命令时可以简化为：

typeorm-model-generator --config ormconfig.json

这样就可以避免每次都手动输入数据库连接信息。

typeorm-model-generatorGenerates models for TypeORM from existing database.项目地址:https://gitcode.com/gh_mirrors/ty/typeorm-model-generator