使用方式：

  1. $ gf gen -h
  2. USAGE
  3.     gf gen TYPE [OPTION]
  5. TYPE
  6.     dao     generate dao and model files.
  7.     model   generate model files, note that these generated model files are different from model files
  8.             of command "gf gen dao".
  10. OPTION
  11.     -/--path             directory path for generated files.
  12.     -l, --link           database configuration, please refer to: https://goframe.org/database/gdb/config
  13.     -t, --tables         generate models only for given tables, multiple table names separated with ','
  14.     -g, --group          specifying the configuration group name for database,
  15.                          it's not necessary and the default value is "default"
  16.     -c, --config         used to specify the configuration file for database, it's commonly not necessary.
  17.                          If "-l" is not passed, it will search "./config.toml" and "./config/config.toml"
  18.                          in current working directory in default.
  19.     -p, --prefix         add prefix for all table of specified link/database tables.
  20.     -r, --remove-prefix  remove specified prefix of the table, multiple prefix separated with ','
  21.     -m, --mod            module name for generated golang file imports.
  23. CONFIGURATION SUPPORT
  24.     Options are also supported by configuration file. The configuration node name is "gf.gen", which also supports
  25.     multiple databases, for example:
  26.     [gfcli]
  27.         [[gfcli.gen.dao]]
  28.             link   = "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  29.             tables = "order,products"
  30.         [[gfcli.gen.dao]]
  31.             link   = "mysql:root:12345678@tcp(127.0.0.1:3306)/primary"
  32.             path   = "./my-app"
  33.             prefix = "primary_"
  34.             tables = "user, userDetail"
  36. EXAMPLES
  37.     gf gen dao
  38.         gf gen dao
  39.         gf gen dao -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  40.         gf gen dao -path ./model -c config.yaml -g user-center -t user,user_detail,user_login
  41.         gf gen dao -r user_
  42.     gf gen model
  43.         gf gen model
  44.         gf gen model -l "mysql:root:12345678@tcp(127.0.0.1:3306)/test"
  45.         gf gen model -path ./model -c config.yaml -g user-center -t user,user_detail,user_login
  46.         gf gen model -r user_
  50. DESCRIPTION
  51.     The "gen" command is designed for multiple generating purposes.
  52.     It's currently supporting generating go files for ORM models.

1、dao代码生成（推荐）

dao命令用于生成dao数据访问对象文件，以及model数据结构定义文件。推荐使用配置文件来管理生成规则。

配置示例：

  1. [gfcli]
  2.     [[gfcli.gen.dao]]
  3.         link   = "mysql:root:12345678@tcp(127.0.0.1:3306)/order"
  4.         group  = "order"
  5.         prefix = "order_"
  6.         tables = "" 
  7.     [[gfcli.gen.dao]]
  8.         link   = "mysql:root:12345678@tcp(127.0.0.1:3306)/user"
  9.         group  = "user"
  10.         prefix = "user_"
  11.         tables = "user,userDetail,userScore"

参数说明：

名称必须默认值含义示例
gfcli.gen.dao是
dao代码生成配置项，可以有多个配置项构成数组，支持多个数据库生成。-
link是
分为两部分，第一部分表示你连接的数据库类型mysql, postgresql等, 第二部分就是连接数据库的dsn信息。具体请参考 ORM使用配置 章节。
  1. mysql:root:12345678@tcp(127.0.0.1:3306)/user
mod否
用于生成go文件的import计算，默认情况下会自动读取当前项目根目录下的go.mod获取。github.com/gogf/gf-demos
group否default在数据库配置中的数据库分组名称。

default

order

user

prefix否
生成数据库对象及文件的前缀，以便区分不同数据库或者不同数据库中的相同表名，防止数据表同名覆盖。

order

user

tables否
指定当前数据库中需要执行代码生成的数据表。如果为空，表示数据库的所有表都会生成。user, userDetail
path否./app生成dao和model文件的存储目录地址./app
remove-prefix否
删除数据表的指定前缀名称。gf_

使用方式：进入项目根目录执行 gf gen dao 即可。

生成的代码结构示例：

gen 代码生成 - 图1

其中：

  1. dao/internal 以及model/internal 下面的文件由工具生成，多次生成会被覆盖，因此不要手动修改。采用internal包名的目的是仅作为dao或model的内部包引用，不对外开放。
  2. dao 目录下的文件 可以做一些数据库的定制化操作，通过工具多次生成不会覆盖，但是更多建议用户在自己的service中实现。
  3. model目录下的文件，可以做自定义的一些数据结构定义，通过工具多次生成不会覆盖。

2、model代码生成（不再推荐）

使用方式：进入项目根目录执行 gf gen model 即可。

gen命令用以自动化从数据库直接生成采用了Active Record设计模式的模型文件。该命令将会根据数据表名生成对应的目录，该目录名称即数据表包名。目录下自动生成3个文件：

  1. 数据表名.go 自定义文件，开发者可以自由定义填充的代码文件，仅会生成一次，每一次模型生成不会覆盖。
  2. 数据表名_entity.go 表结构文件，根据数据表结构生成的结构体定义文件，包含字段注释。数据表在外部变更后，可使用gen命令重复生成更新该文件。
  3. 数据表名_model.go 表模型文件，为数据表提供了许多便捷的CURD操作方法，并可直接查询返回该表的结构体对象。数据表在外部变更后，可使用gen命令重复生成更新该文件。

数据表模型生成支持的数据库类型为：MySQL/MariaDB、PostgreSQL、SQLite、SQLServer。目前暂不支持Oracle，若有需求请联系作者。