GORMガイド

デベロッパーフレンドリーを目指した、Go言語のORMライブラリです。

特徴

• フル機能ORM
• アソシエーション(Has One, Has Many, Belongs To, Many To Many, Polymorphism, Single-table inheritance)
• フック (Before/After Create/Save/Update/Delete/Find)
• Preload, Joinsを使ったイーガーロード
• トランザクション、ネスティング、セーブポイント、セーブポイントへのロールバック
• Context、プリペアードステートメント、DryRunへの対応
• Batch Insert, FindInBatches, マップを使用してのFind/Create, SQL式やContext Valuerを使用したCRUD操作への対応
• SQL Builder、Upsert、ロック、Optimizer/Index/Comment ヒント、名前付き引数、サブクエリの対応
• 複合主キー、インデックス、データベース制約への対応
• オートマイグレーション
• Logger
• Generics API for type-safe queries and operations
• Extendable, flexible plugin API: Database Resolver (multiple databases, read/write splitting) / Prometheus…
• すべての機能に付属するテストコード
• デベロッパーフレンドリー

インストール

go get -u gorm.io/gorm
go get -u gorm.io/driver/sqlite

クイックスタート

Generics API (>= v1.30.0)

package main

import (
  "context"
  "gorm.io/driver/sqlite"
  "gorm.io/gorm"
)

type Product struct {
  gorm.Model
  Code  string
  Price uint
}

func main() {
  db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
  if err != nil {
    panic("failed to connect database")
  }

  ctx := context.Background()

  // Migrate the schema
  db.AutoMigrate(&Product{})

  // Create
  err = gorm.G[Product](db).Create(ctx, &Product{Code: "D42", Price: 100})

  // Read
  product, err := gorm.G[Product](db).Where("id = ?", 1).First(ctx) // find product with integer primary key
  products, err := gorm.G[Product](db).Where("code = ?", "D42").Find(ctx) // find product with code D42

  // Update - update product's price to 200
  err = gorm.G[Product](db).Where("id = ?", product.ID).Update(ctx, "Price", 200)
  // Update - update multiple fields
  err = gorm.G[Product](db).Where("id = ?", product.ID).Updates(ctx, map[string]interface{}{"Price": 200, "Code": "F42"})

  // Delete - delete product
  err = gorm.G[Product](db).Where("id = ?", product.ID).Delete(ctx)
}

Traditional API

package main

import (
  "gorm.io/driver/sqlite"
  "gorm.io/gorm"
)

type Product struct {
  gorm.Model
  Code  string
  Price uint
}

func main() {
  db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
  if err != nil {
    panic("failed to connect database")
  }

  // Migrate the schema
  db.AutoMigrate(&Product{})

  // Create
  db.Create(&Product{Code: "D42", Price: 100})

  // Read
  var product Product
  db.First(&product, 1) // find product with integer primary key
  db.First(&product, "code = ?", "D42") // find product with code D42

  // Update - update product's price to 200
  db.Model(&product).Update("Price", 200)
  // Update - update multiple fields
  db.Model(&product).Updates(Product{Price: 200, Code: "F42"}) // non-zero fields
  db.Model(&product).Updates(map[string]interface{}{"Price": 200, "Code": "F42"})

  // Delete - delete product
  db.Delete(&product, 1)
}