ZenORM Generate

ZenORM Table Structure Code Generation Tool

表结构代码生成工具

安装

npm i -D @zenorm/generate

配置

新建配置文件 dbgen.config.js

/** @type {import("@zenorm/generate").GenerateConfig} */
export default {
  "database": "you_db_name",    // 数据库名
  "host": "localhost",          // 目标数据库地址
  "port": 3306,                 // 数据库端口
  "user": "root",               // 数据库用户名
  "password": "",               // 数据库密码
  "outputDir": "./model/",      // 代码输出目录
  "bindQuery": true,            // 绑定 Query 对象
}

在 package.json 中添加命令

{
  "scripts": {
    "dbgen": "zenorm-generate dbgen.config.js"
  },
}

运行命令生成数据库代码

npm run dbgen

Generate Config - 代码生成配置

| 配置项 | 类型 | 默认值 | 说明 | ----- | --- | ----- | ---- | host | string | 无 | 目标数据库地址 | port | number | 无 | 数据库端口 | user | string | 无 | 数据库用户名 | password | string | 无 | 数据库密码 | database | string | 无 | 数据库名 | outputDir | string | './src/model' | 代码输出目录 | tablesFilename | string | '_tables' | 生成数据库表结构文件名 | repositoriesFilename | string | '_repositories' | 生成 repositories 文件名 | globalFilename | string | 无 | 全局文件名 - 如果设置所有表将继承于此 - 例如设置为：'_global' - 如果文件不存在则自动创建 | bindQuery | boolean | false | repositories 文件生成 bindQuery(query: QueryParam) 方法用于设置模型的 Query 源 - 并生成模型的静态 Repository 方法 | generateRepositories | boolean | false | 是否生成 Repositories 类 - 通常用于多租户模式做数据库前置绑定 Query 对象 | declareRepositoriesToModules | string[] | 无 | 是否需将 Repositories 实例定义到目标模块中 - 例如: ["@zenweb/core.Core.repositories"] | filter | string | 无 | 表过滤规则正则 | include | string | 无 | 表包含规则正则 | esModule | boolean | 无 | 是否输出满足 ESM 导入文件名 （必须带有 .js 扩展名）