gorm數據庫映射工具

時間 2020-01-14

標籤 gorm 數據庫映射工具欄目 SQL 简体版

原文原文鏈接

gormt

一款 mysql 數據庫轉 struct 工具

能夠將mysql數據庫自動生成 golang 結構
自動生成快捷操做函數
支持索引,外鍵
帶大駝峯命名規則
帶json標籤

1. 經過當前目錄config.toml文件配置默認配置項

out_dir : "."  # 輸出目錄
singular_table : false  # 表名複數,是否大駝峯構建 參考:gorm.SingularTable
simple : false #簡單輸出
is_out_sql : false # 是否輸出 sql 原信息
is_out_func : true # 是否輸出 快捷函數
is_json_tag : false #是否打json標記
is_foreign_key : true #是否導出外鍵關聯
mysql_info :
    host : "127.0.0.1"
    port : 3306
    username : "root"
    password : "qwer"
    database : "oauth_db"

2. 能夠使用命令行工具更新配置項

./gormt -H=127.0.0.1 -d=oauth_db -p=qwer -u=root --port=3306

3. 查看幫助

./gormt -h

-------------------------------------------------------
base on gorm tools for mysql database to golang struct

Usage:
  main [flags]

Flags:
  -d, --database string   數據庫名
  -h, --help              help for main
  -H, --host string       數據庫地址.(注意-H爲大寫)
  -o, --outdir string     輸出目錄
  -p, --password string   密碼.
      --port int          端口號 (default 3306)
  -s, --singular          是否禁用表名複數
  -u, --user string       用戶名.

4. 支持gorm 相關屬性

數據庫表,列字段註釋支持
singular_table 表名複數(大駝峯)
json tag json標籤輸出
gorm.Model 基本模型支持gorm.Model模式導出>>>
PRIMARY_KEY 將列指定爲主鍵
UNIQUE 將列指定爲惟一
NOT NULL 將列指定爲非 NULL
INDEX 建立具備或不帶名稱的索引, 若是多個索引同名則建立複合索引
UNIQUE_INDEX 和 INDEX 相似，只不過建立的是惟一索引
支持外鍵相關屬性簡單帶外鍵模式導出>>>
支持函數導出(包括:外鍵，關聯體，索引關...)簡單函數導出示例>>>

5. 示例展現

--->導出結果示例

參數:singular_table = false simple = false isJsonTag = true

//    用戶信息
type UserAccountTbl struct {
    ID          int       `gorm:"primary_key;column:id;type:int(11);not null" json:"-"`                                                   //
    Account     string    `gorm:"unique;column:account;type:varchar(64);not null" json:"account"`                                         //
    Password    string    `gorm:"column:password;type:varchar(64);not null" json:"password"`                                              //
    AccountType int       `gorm:"column:account_type;type:int(11);not null" json:"account_type"`                                          //    賬號類型:0手機號，1郵件
    AppKey      string    `json:"app_key" gorm:"unique_index:UNIQ_5696AD037D3656A4;column:app_key;type:varchar(255);not null"`            //    authbucket_oauth2_client表的id
    UserInfoID  int       `gorm:"unique_index:UNIQ_5696AD037D3656A4;index;column:user_info_id;type:int(11);not null" json:"user_info_id"` //
    RegTime     time.Time `gorm:"column:reg_time;type:datetime" json:"reg_time"`                                                          //
    RegIP       string    `gorm:"column:reg_ip;type:varchar(15)" json:"reg_ip"`                                                           //
    BundleID    string    `json:"bundle_id" gorm:"column:bundle_id;type:varchar(255)"`                                                    //
    Describ     string    `gorm:"column:describ;type:varchar(255)" json:"describ"`                                                        //
}

參數:singular_table = false simple = true isJsonTag = false

--->導出結果

//    用戶信息
type UserAccountTbl struct {
    ID          int       `gorm:"primary_key"` //
    Account     string    `gorm:"unique"`      //
    Password    string    //
    AccountType int       //    賬號類型:0手機號，1郵件
    AppKey      string    `gorm:"unique_index:UNIQ_5696AD037D3656A4"`       //    authbucket_oauth2_client表的id
    UserInfoID  int       `gorm:"unique_index:UNIQ_5696AD037D3656A4;index"` //
    RegTime     time.Time //
    RegIP       string    //
    BundleID    string    //
    Describ     string    //
}

6. 支持函數導出(導出函數只是 gorm 的輔助類函數，徹底兼容 gorm 相關函數集)

// FetchByPrimaryKey primay or index 獲取惟一內容
func (obj *_UserAccountTblMgr) FetchByPrimaryKey(ID int) (result UserAccountTbl, err error) {
    err = obj.DB.Table(obj.GetTableName()).Where("id = ?", ID).Find(&result).Error
    if err == nil && obj.isRelated {
        {
            var info UserInfoTbl // 用戶信息
            err = obj.DB.Table("user_info_tbl").Where("id = ?", result.UserInfoTblID).Find(&info).Error
            if err != nil {
                return
            }
            result.UserInfoTbl = info
        }
    }

    return
}