Gen ガイド

GEN ガイド

GEN: コード生成によって強化された、より使いやすく安全なGORM。

概要

• 動的な生の SQL からの慣用的で再利用可能な API
• interface{} なしで 100% タイプセーフな DAO API
• GORM の規約に従ったデータベースから構造体への変換
• GORM の内部で、GORM がサポートするすべての機能、プラグイン、DBMS をサポート

インストール

go get -u gorm.io/gen

クイックスタート

アプリケーションで gen を使用するのは非常に簡単です。仕組みは次のとおりです。

1. Go で設定を記述する

package main

import "gorm.io/gen"

// Dynamic SQL
type Querier interface {
  // SELECT * FROM @@table WHERE name = @name{{if role !=""}} AND role = @role{{end}}
  FilterWithNameAndRole(name, role string) ([]gen.T, error)
}

func main() {
  g := gen.NewGenerator(gen.Config{
    OutPath: "../query",
    Mode: gen.WithoutContext|gen.WithDefaultQuery|gen.WithQueryInterface, // generate mode
  })

  // gormdb, _ := gorm.Open(mysql.Open("root:@(127.0.0.1:3306)/demo?charset=utf8mb4&parseTime=True&loc=Local"))
  g.UseDB(gormdb) // reuse your gorm db

  // Generate basic type-safe DAO API for struct `model.User` following conventions
  g.ApplyBasic(model.User{})

  // Generate Type Safe API with Dynamic SQL defined on Querier interface for `model.User` and `model.Company`
  g.ApplyInterface(func(Querier){}, model.User{}, model.Company{})

  // Generate the code
  g.Execute()
}

2. コードを生成する

go run main.go

3. 生成されたコードをプロジェクトで使用する

import "your_project/query"

func main() {
  // Basic DAO API
  user, err := query.User.Where(u.Name.Eq("modi")).First()

  // Dynamic SQL API
  users, err := query.User.FilterWithNameAndRole("modi", "admin")
}