GORM學習指南

本文轉載自查看原文 2020-03-14 22:21 1046 Go之路

orm是一個使用Go語言編寫的ORM框架。它文檔齊全，對開發者友好，支持主流數據庫。

一、初識Gorm

中文官方網站內含十分齊全的中文文檔，有了它你甚至不需要再繼續向下閱讀本文。

1.1 安裝

go get -u github.com/jinzhu/gorm

1.2 連接數據庫

連接不同的數據庫都需要導入對應數據的驅動程序，GORM已經貼心的為我們包裝了一些驅動程序，只需要按如下方式導入需要的數據庫驅動即可：

import _ "github.com/jinzhu/gorm/dialects/mysql"
// import _ "github.com/jinzhu/gorm/dialects/postgres"
// import _ "github.com/jinzhu/gorm/dialects/sqlite"
// import _ "github.com/jinzhu/gorm/dialects/mssql"

連接MySQL

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mysql"
)

func main() {
  db, err := gorm.Open("mysql", "user:password@(localhost)/dbname?charset=utf8mb4&parseTime=True&loc=Local")
  defer db.Close()
}

連接PostgreSQL

基本代碼同上，注意引入對應postgres驅動並正確指定gorm.Open()參數。

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/postgres"
)

func main() {
  db, err := gorm.Open("postgres", "host=myhost port=myport user=gorm dbname=gorm password=mypassword")
  defer db.Close()
}

連接Sqlite3

基本代碼同上，注意引入對應sqlite驅動並正確指定gorm.Open()參數。

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/sqlite"
)

func main() {
  db, err := gorm.Open("sqlite3", "/tmp/gorm.db")
  defer db.Close()
}

連接SQL Server

基本代碼同上，注意引入對應mssql驅動並正確指定gorm.Open()參數。

import (
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mssql"
)

func main() {
  db, err := gorm.Open("mssql", "sqlserver://username:password@localhost:1433?database=dbname")
  defer db.Close()
}

二、GORM基本示例

注意:

本文以MySQL數據庫為例，講解GORM各項功能的主要使用方法。
往下閱讀本文前，你需要有一個能夠成功連接上的MySQL數據庫實例。

2.1 創建數據庫

在使用GORM前手動創建數據庫db1：

CREATE DATABASE db1;

2.2 GORM操作MySQL

使用GORM連接上面的db1進行創建、查詢、更新、刪除操作。

package main

import (
	"github.com/jinzhu/gorm"
	"log"
	_ "github.com/jinzhu/gorm/dialects/mysql"
)
// 用戶信息
type UserInfo struct {
	ID uint
	Name string
	Gender string
	Hobby string
}

func main() {
	db, err := gorm.Open("mysql", "root:0000@(127.0.0.1:3306)/db_test?charset=utf8mb4&parseTime=True&loc=Local")
	if err!= nil{
		panic(err)
	}
	defer db.Close()
	u := &UserInfo{}
	//自動遷移  數據庫建表
	db.AutoMigrate(u)
	//插入數據
	u1 := UserInfo{Name:"飛凡",Gender:"男",Hobby:"籃球"}
	u2 := UserInfo{Name:"靈兒",Gender:"女",Hobby:"寫作"}
	db.Create(&u1)
	db.Create(&u2)

	// 查詢
	db.Find(u)
	log.Printf("%v\n", u)
	var u3 = new(UserInfo)
	db.First(u3)
	log.Printf("%v\n", u3)
	
	u4 := &UserInfo{}
	db.Find(u, "name=?", "靈兒")
	log.Printf("%v\n", u4)

	//修改
	u5 := &UserInfo{}
	db.Model(u5).Where("name=?", "飛凡").Update("hobby", "讀書")
	//刪除
	db.Delete(&UserInfo{})
}

三、GORM Model定義

在使用ORM工具時，通常我們需要在代碼中定義模型（Models）與數據庫中的數據表進行映射，在GORM中模型（Models）通常是正常定義的結構體、基本的go類型或它們的指針。同時也支持sql.Scanner及driver.Valuer接口（interfaces）。

3.1 gorm.Model

為了方便模型定義，GORM內置了一個gorm.Model結構體。gorm.Model是一個包含了ID, CreatedAt, UpdatedAt, DeletedAt四個字段的Golang結構體。

// gorm.Model 定義
type Model struct {
  ID        uint `gorm:"primary_key"`
  CreatedAt time.Time
  UpdatedAt time.Time
  DeletedAt *time.Time
}

　　你可以將它嵌入到你自己的模型中：

// 將 `ID`, `CreatedAt`, `UpdatedAt`, `DeletedAt`字段注入到`User`模型中
type User struct {
  gorm.Model
  Name string
}

　當然你也可以完全自己定義模型：

// 不使用gorm.Model，自行定義模型
type User struct {
  ID   int
  Name string
}

3.2 模型定義示例

type User struct {
  gorm.Model
  Name         string
  Age          sql.NullInt64
  Birthday     *time.Time
  Email        string  `gorm:"type:varchar(100);unique_index"`
  Role         string  `gorm:"size:255"` // 設置字段大小為255
  MemberNumber *string `gorm:"unique;not null"` // 設置會員號（member number）唯一並且不為空
  Num          int     `gorm:"AUTO_INCREMENT"` // 設置 num 為自增類型
  Address      string  `gorm:"index:addr"` // 給address字段創建名為addr的索引
  IgnoreMe     int     `gorm:"-"` // 忽略本字段
}

3.3 結構體標記（tags）

使用結構體聲明模型時，標記（tags）是可選項。gorm支持以下標記:

3.3.1 支持的結構體標記（Struct tags）

3.3.2 關聯相關標記（tags）

3.4 主鍵、表名、列名的約定

3.4.1 主鍵（Primary Key）

GORM 默認會使用名為ID的字段作為表的主鍵。

type User struct {
  ID   string // 名為`ID`的字段會默認作為表的主鍵
  Name string
}

// 使用`AnimalID`作為主鍵
type Animal struct {
  AnimalID int64 `gorm:"primary_key"`
  Name     string
  Age      int64
}

3.4.2 表名（Table Name）

表名默認就是結構體名稱的復數，例如：

type User struct {} // 默認表名是 `users`

// 將 User 的表名設置為 `profiles`
func (User) TableName() string {
  return "profiles"
}

func (u User) TableName() string {
  if u.Role == "admin" {
    return "admin_users"
  } else {
    return "users"
  }
}

// 禁用默認表名的復數形式，如果置為 true，則 `User` 的默認表名是 `user`
db.SingularTable(true)

也可以通過Table()指定表名：

// 使用User結構體創建名為`deleted_users`的表
db.Table("deleted_users").CreateTable(&User{})

var deleted_users []User
db.Table("deleted_users").Find(&deleted_users)
//// SELECT * FROM deleted_users;

db.Table("deleted_users").Where("name = ?", "jinzhu").Delete()
//// DELETE FROM deleted_users WHERE name = 'jinzhu';

GORM還支持更改默認表名稱規則：

gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {
  return "prefix_" + defaultTableName;
}

3.4.3 列名（Column Name）

列名由字段名稱進行下划線分割來生成

type User struct {
  ID        uint      // column name is `id`
  Name      string    // column name is `name`
  Birthday  time.Time // column name is `birthday`
  CreatedAt time.Time // column name is `created_at`
}

　可以使用結構體tag指定列名：

type Animal struct {
  AnimalId    int64     `gorm:"column:beast_id"`         // set column name to `beast_id`
  Birthday    time.Time `gorm:"column:day_of_the_beast"` // set column name to `day_of_the_beast`
  Age         int64     `gorm:"column:age_of_the_beast"` // set column name to `age_of_the_beast`
}

3.4.4 時間戳跟蹤

CreatedAt

如果模型有 CreatedAt字段，該字段的值將會是初次創建記錄的時間。

db.Create(&user) // `CreatedAt`將會是當前時間

// 可以使用`Update`方法來改變`CreateAt`的值
db.Model(&user).Update("CreatedAt", time.Now())

UpdatedAt

如果模型有UpdatedAt字段，該字段的值將會是每次更新記錄的時間。

db.Save(&user) // `UpdatedAt`將會是當前時間

db.Model(&user).Update("name", "jinzhu") // `UpdatedAt`將會是當前時間

DeletedAt

如果模型有DeletedAt字段，調用Delete刪除該記錄時，將會設置DeletedAt字段為當前時間，而不是直接將記錄從數據庫中刪除。

四、創建

創建記錄

首先定義模型：

type User struct {
	ID           int64
	Name         string
	Age          int64
}

使用使用NewRecord()查詢主鍵是否存在，主鍵為空使用Create()創建記錄：

user := User{Name: "q1mi", Age: 18}

db.NewRecord(user) // 主鍵為空返回`true`
db.Create(&user)   // 創建user
db.NewRecord(user) // 創建`user`后返回`false`

默認值

可以通過 tag 定義字段的默認值，比如：

type User struct {
  ID   int64
  Name string `gorm:"default:'小王子'"`
  Age  int64
}

注意：通過tag定義字段的默認值，在創建記錄時候生成的 SQL 語句會排除沒有值或值為零值的字段。在將記錄插入到數據庫后，Gorm會從數據庫加載那些字段的默認值。

舉個例子：

var user = User{Name: "", Age: 99}
db.Create(&user)

上面代碼實際執行的SQL語句是INSERT INTO users("age") values('99');，排除了零值字段Name，而在數據庫中這一條數據會使用設置的默認值小王子作為Name字段的值。

注意：所有字段的零值, 比如0, "",false或者其它零值，都不會保存到數據庫內，但會使用他們的默認值。如果你想避免這種情況，可以考慮使用指針或實現 Scanner/Valuer接口，比如：

使用指針方式實現零值存入數據庫

// 使用指針
type User struct {
  ID   int64
  Name *string `gorm:"default:'小王子'"`
  Age  int64
}
user := User{Name: new(string), Age: 18))}
db.Create(&user)  // 此時數據庫中該條記錄name字段的值就是''

使用Scanner/Valuer接口方式實現零值存入數據庫

// 使用 Scanner/Valuer
type User struct {
	ID int64
	Name sql.NullString `gorm:"default:'小王子'"` // sql.NullString 實現了Scanner/Valuer接口
	Age  int64
}
user := User{Name: sql.NullString{"", true}, Age:18}
db.Create(&user)  // 此時數據庫中該條記錄name字段的值就是''

擴展創建選項

例如PostgreSQL數據庫中可以使用下面的方式實現合並插入, 有則更新, 無則插入。

// 為Instert語句添加擴展SQL選項
db.Set("gorm:insert_option", "ON CONFLICT").Create(&product)
// INSERT INTO products (name, code) VALUES ("name", "code") ON CONFLICT;

五、查詢

5.1 一般查詢

// 根據主鍵查詢第一條記錄
db.First(&user)
//// SELECT * FROM users ORDER BY id LIMIT 1;

// 隨機獲取一條記錄
db.Take(&user)
//// SELECT * FROM users LIMIT 1;

// 根據主鍵查詢最后一條記錄
db.Last(&user)
//// SELECT * FROM users ORDER BY id DESC LIMIT 1;

// 查詢所有的記錄
db.Find(&users)
//// SELECT * FROM users;

// 查詢指定的某條記錄(僅當主鍵為整型時可用)
db.First(&user, 10)
//// SELECT * FROM users WHERE id = 10;

一般查詢

5.2 where條件

// Get first matched record
db.Where("name = ?", "jinzhu").First(&user)
//// SELECT * FROM users WHERE name = 'jinzhu' limit 1;

// Get all matched records
db.Where("name = ?", "jinzhu").Find(&users)
//// SELECT * FROM users WHERE name = 'jinzhu';

// <>
db.Where("name <> ?", "jinzhu").Find(&users)
//// SELECT * FROM users WHERE name <> 'jinzhu';

// IN
db.Where("name IN (?)", []string{"jinzhu", "jinzhu 2"}).Find(&users)
//// SELECT * FROM users WHERE name in ('jinzhu','jinzhu 2');

// LIKE
db.Where("name LIKE ?", "%jin%").Find(&users)
//// SELECT * FROM users WHERE name LIKE '%jin%';

// AND
db.Where("name = ? AND age >= ?", "jinzhu", "22").Find(&users)
//// SELECT * FROM users WHERE name = 'jinzhu' AND age >= 22;

// Time
db.Where("updated_at > ?", lastWeek).Find(&users)
//// SELECT * FROM users WHERE updated_at > '2000-01-01 00:00:00';

// BETWEEN
db.Where("created_at BETWEEN ? AND ?", lastWeek, today).Find(&users)
//// SELECT * FROM users WHERE created_at BETWEEN '2000-01-01 00:00:00' AND '2000-01-08 00:00:00';

普通sql查詢

// Struct
db.Where(&User{Name: "jinzhu", Age: 20}).First(&user)
//// SELECT * FROM users WHERE name = "jinzhu" AND age = 20 LIMIT 1;

// Map
db.Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users)
//// SELECT * FROM users WHERE name = "jinzhu" AND age = 20;

// 主鍵的切片
db.Where([]int64{20, 21, 22}).Find(&users)
//// SELECT * FROM users WHERE id IN (20, 21, 22);

struct&Map查詢

提示：當通過結構體進行查詢時，GORM將會只通過非零值字段查詢，這意味着如果你的字段值為0，''，false或者其他零值時，將不會被用於構建查詢條件，例如：

db.Where(&User{Name: "jinzhu", Age: 0}).Find(&users)
//// SELECT * FROM users WHERE name = "jinzhu";

你可以使用指針或實現 Scanner/Valuer 接口來避免這個問題.

// 使用指針
type User struct {
  gorm.Model
  Name string
  Age  *int
}

// 使用 Scanner/Valuer
type User struct {
  gorm.Model
  Name string
  Age  sql.NullInt64  // sql.NullInt64 實現了 Scanner/Valuer 接口
}

5.3 Not條件

db.Not("name", "jinzhu").First(&user)
//// SELECT * FROM users WHERE name <> "jinzhu" LIMIT 1;

// Not In
db.Not("name", []string{"jinzhu", "jinzhu 2"}).Find(&users)
//// SELECT * FROM users WHERE name NOT IN ("jinzhu", "jinzhu 2");

// Not In slice of primary keys
db.Not([]int64{1,2,3}).First(&user)
//// SELECT * FROM users WHERE id NOT IN (1,2,3);

db.Not([]int64{}).First(&user)
//// SELECT * FROM users;

// Plain SQL
db.Not("name = ?", "jinzhu").First(&user)
//// SELECT * FROM users WHERE NOT(name = "jinzhu");

// Struct
db.Not(User{Name: "jinzhu"}).First(&user)
//// SELECT * FROM users WHERE name <> "jinzhu";

not條件

5.4 OR條件

db.Where("role = ?", "admin").Or("role = ?", "super_admin").Find(&users)
//// SELECT * FROM users WHERE role = 'admin' OR role = 'super_admin';

// Struct
db.Where("name = 'jinzhu'").Or(User{Name: "jinzhu 2"}).Find(&users)
//// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';

// Map
db.Where("name = 'jinzhu'").Or(map[string]interface{}{"name": "jinzhu 2"}).Find(&users)
//// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';

OR條件

5.5 內聯條件

// 根據主鍵獲取記錄 (只適用於整形主鍵)
db.First(&user, 23)
//// SELECT * FROM users WHERE id = 23 LIMIT 1;
// 根據主鍵獲取記錄, 如果它是一個非整形主鍵
db.First(&user, "id = ?", "string_primary_key")
//// SELECT * FROM users WHERE id = 'string_primary_key' LIMIT 1;

// Plain SQL
db.Find(&user, "name = ?", "jinzhu")
//// SELECT * FROM users WHERE name = "jinzhu";

db.Find(&users, "name <> ? AND age > ?", "jinzhu", 20)
//// SELECT * FROM users WHERE name <> "jinzhu" AND age > 20;

// Struct
db.Find(&users, User{Age: 20})
//// SELECT * FROM users WHERE age = 20;

// Map
db.Find(&users, map[string]interface{}{"age": 20})
//// SELECT * FROM users WHERE age = 20;

內聯條件

5.6 額外查詢選項

// 為查詢 SQL 添加額外的 SQL 操作
db.Set("gorm:query_option", "FOR UPDATE").First(&user, 10)
//// SELECT * FROM users WHERE id = 10 FOR UPDATE;

5.7 FirstOrinit

獲取匹配的第一條記錄，否則根據給定的條件初始化一個新的對象 (僅支持 struct 和 map 條件)

// 未找到
db.FirstOrInit(&user, User{Name: "non_existing"})
//// user -> User{Name: "non_existing"}

// 找到
db.Where(User{Name: "Jinzhu"}).FirstOrInit(&user)
//// user -> User{Id: 111, Name: "Jinzhu", Age: 20}
db.FirstOrInit(&user, map[string]interface{}{"name": "jinzhu"})
//// user -> User{Id: 111, Name: "Jinzhu", Age: 20}

Attrs:如果記錄未找到，將使用參數初始化 struct.

// 未找到
db.Where(User{Name: "non_existing"}).Attrs(User{Age: 20}).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = 'non_existing';
//// user -> User{Name: "non_existing", Age: 20}

db.Where(User{Name: "non_existing"}).Attrs("age", 20).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = 'non_existing';
//// user -> User{Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "Jinzhu"}).Attrs(User{Age: 30}).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = jinzhu';
//// user -> User{Id: 111, Name: "Jinzhu", Age: 20}

Attrs

Assign：不管記錄是否找到，都將參數賦值給 struct.

// 未找到
db.Where(User{Name: "non_existing"}).Assign(User{Age: 20}).FirstOrInit(&user)
//// user -> User{Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "Jinzhu"}).Assign(User{Age: 30}).FirstOrInit(&user)
//// SELECT * FROM USERS WHERE name = jinzhu';
//// user -> User{Id: 111, Name: "Jinzhu", Age: 30}

Assign

5.8 FirstOrCreate

獲取匹配的第一條記錄, 否則根據給定的條件創建一個新的記錄 (僅支持 struct 和 map 條件)

// 未找到
db.FirstOrCreate(&user, User{Name: "non_existing"})
//// INSERT INTO "users" (name) VALUES ("non_existing");
//// user -> User{Id: 112, Name: "non_existing"}

// 找到
db.Where(User{Name: "Jinzhu"}).FirstOrCreate(&user)
//// user -> User{Id: 111, Name: "Jinzhu"}

Attrs

 // 未找到
db.Where(User{Name: "non_existing"}).Attrs(User{Age: 20}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'non_existing';
//// INSERT INTO "users" (name, age) VALUES ("non_existing", 20);
//// user -> User{Id: 112, Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "jinzhu"}).Attrs(User{Age: 30}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'jinzhu';
//// user -> User{Id: 111, Name: "jinzhu", Age: 20}

Attrs

Assign

// 未找到
db.Where(User{Name: "non_existing"}).Assign(User{Age: 20}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'non_existing';
//// INSERT INTO "users" (name, age) VALUES ("non_existing", 20);
//// user -> User{Id: 112, Name: "non_existing", Age: 20}

// 找到
db.Where(User{Name: "jinzhu"}).Assign(User{Age: 30}).FirstOrCreate(&user)
//// SELECT * FROM users WHERE name = 'jinzhu';
//// UPDATE users SET age=30 WHERE id = 111;
//// user -> User{Id: 111, Name: "jinzhu", Age: 30}

Assign

5.9. 高級查詢

db.Where("amount > ?", DB.Table("orders").Select("AVG(amount)").Where("state = ?", "paid").QueryExpr()).Find(&orders)
// SELECT * FROM "orders"  WHERE "orders"."deleted_at" IS NULL AND (amount > (SELECT AVG(amount) FROM "orders"  WHERE (state = 'paid')));

子查詢

Select，指定你想從數據庫中檢索出的字段，默認會選擇全部字段。
db.Select("name, age").Find(&users)
//// SELECT name, age FROM users;

db.Select([]string{"name", "age"}).Find(&users)
//// SELECT name, age FROM users;

db.Table("users").Select("COALESCE(age,?)", 42).Rows()
//// SELECT COALESCE(age,'42') FROM users;

選擇字段

db.Order("age desc, name").Find(&users)
//// SELECT * FROM users ORDER BY age desc, name;

// 多字段排序
db.Order("age desc").Order("name").Find(&users)
//// SELECT * FROM users ORDER BY age desc, name;

// 覆蓋排序
db.Order("age desc").Find(&users1).Order("age", true).Find(&users2)
//// SELECT * FROM users ORDER BY age desc; (users1)
//// SELECT * FROM users ORDER BY age; (users2)

排序

db.Limit(3).Find(&users)
//// SELECT * FROM users LIMIT 3;

// -1 取消 Limit 條件
db.Limit(10).Find(&users1).Limit(-1).Find(&users2)
//// SELECT * FROM users LIMIT 10; (users1)
//// SELECT * FROM users; (users2)

數量limit

db.Offset(3).Find(&users)
//// SELECT * FROM users OFFSET 3;

// -1 取消 Offset 條件
db.Offset(10).Find(&users1).Offset(-1).Find(&users2)
//// SELECT * FROM users OFFSET 10; (users1)
//// SELECT * FROM users; (users2)

偏移offset

db.Where("name = ?", "jinzhu").Or("name = ?", "jinzhu 2").Find(&users).Count(&count)
//// SELECT * from USERS WHERE name = 'jinzhu' OR name = 'jinzhu 2'; (users)
//// SELECT count(*) FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2'; (count)

db.Model(&User{}).Where("name = ?", "jinzhu").Count(&count)
//// SELECT count(*) FROM users WHERE name = 'jinzhu'; (count)

db.Table("deleted_users").Count(&count)
//// SELECT count(*) FROM deleted_users;

db.Table("deleted_users").Select("count(distinct(name))").Count(&count)
//// SELECT count( distinct(name) ) FROM deleted_users; (count)
注意 Count 必須是鏈式查詢的最后一個操作 ，因為它會覆蓋前面的 SELECT，但如果里面使用了 count 時不會覆蓋

總數count

rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Rows()
for rows.Next() {
  ...
}

// 使用Scan將多條結果掃描進事先准備好的結構體切片中
type Result struct {
    Date time.Time
    Total int
}
var rets []Result
db.Table("users").Select("date(created_at) as date, sum(age) as total").Group("date(created_at)").Scan(&rets)

rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Rows()
for rows.Next() {
  ...
}

type Result struct {
  Date  time.Time
  Total int64
}
db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Scan(&results)

having & group

rows, err := db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id").Rows()
for rows.Next() {
  ...
}

db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id").Scan(&results)

// 多連接及參數
db.Joins("JOIN emails ON emails.user_id = users.id AND emails.email = ?", "jinzhu@example.org").Joins("JOIN credit_cards ON credit_cards.user_id = users.id").Where("credit_cards.number = ?", "411111111111").Find(&user)

連接

5.10 Pluck

Pluck，查詢 model 中的一個列作為切片，如果您想要查詢多個列，您應該使用 Scan

var ages []int64
db.Find(&users).Pluck("age", &ages)

var names []string
db.Model(&User{}).Pluck("name", &names)

db.Table("deleted_users").Pluck("name", &names)

// 想查詢多個字段？ 這樣做：
db.Select("name, age").Find(&users)

pluck

5.11 掃描

Scan，掃描結果至一個 struct.

type Result struct {
  Name string
  Age  int
}

var result Result
db.Table("users").Select("name, age").Where("name = ?", "Antonio").Scan(&result)

var results []Result
db.Table("users").Select("name, age").Where("id > ?", 0).Scan(&results)

// 原生 SQL
db.Raw("SELECT name, age FROM users WHERE name = ?", "Antonio").Scan(&result)

scan

5.12 鏈式操作相關

Method Chaining，Gorm 實現了鏈式操作接口，所以你可以把代碼寫成這樣：

// 創建一個查詢
tx := db.Where("name = ?", "jinzhu")

// 添加更多條件
if someCondition {
  tx = tx.Where("age = ?", 20)
} else {
  tx = tx.Where("age = ?", 30)
}

if yetAnotherCondition {
  tx = tx.Where("active = ?", 1)
}

在調用立即執行方法前不會生成Query語句，借助這個特性你可以創建一個函數來處理一些通用邏輯。

立即執行方法

Immediate methods ，立即執行方法是指那些會立即生成SQL語句並發送到數據庫的方法, 他們一般是CRUD方法，比如：

Create, First, Find, Take, Save, UpdateXXX, Delete, Scan, Row, Rows…

這有一個基於上面鏈式方法代碼的立即執行方法的例子：

tx.Find(&user)

生成的SQL語句如下：

SELECT * FROM users where name = 'jinzhu' AND age = 30 AND active = 1;

范圍

Scopes，Scope是建立在鏈式操作的基礎之上的。

基於它，你可以抽取一些通用邏輯，寫出更多可重用的函數庫。

func AmountGreaterThan1000(db *gorm.DB) *gorm.DB {
  return db.Where("amount > ?", 1000)
}

func PaidWithCreditCard(db *gorm.DB) *gorm.DB {
  return db.Where("pay_mode_sign = ?", "C")
}

func PaidWithCod(db *gorm.DB) *gorm.DB {
  return db.Where("pay_mode_sign = ?", "C")
}

func OrderStatus(status []string) func (db *gorm.DB) *gorm.DB {
  return func (db *gorm.DB) *gorm.DB {
    return db.Scopes(AmountGreaterThan1000).Where("status IN (?)", status)
  }
}

db.Scopes(AmountGreaterThan1000, PaidWithCreditCard).Find(&orders)
// 查找所有金額大於 1000 的信用卡訂單

db.Scopes(AmountGreaterThan1000, PaidWithCod).Find(&orders)
// 查找所有金額大於 1000 的 COD 訂單

db.Scopes(AmountGreaterThan1000, OrderStatus([]string{"paid", "shipped"})).Find(&orders)
// 查找所有金額大於 1000 且已付款或者已發貨的訂單

多個立即執行方法

Multiple Immediate Methods，在 GORM 中使用多個立即執行方法時，后一個立即執行方法會復用前一個立即執行方法的條件 (不包括內聯條件) 。

db.Where("name LIKE ?", "jinzhu%").Find(&users, "id IN (?)", []int{1, 2, 3}).Count(&count)

生成的 Sql

SELECT * FROM users WHERE name LIKE 'jinzhu%' AND id IN (1, 2, 3)

SELECT count(*) FROM users WHERE name LIKE 'jinzhu%'

六、更新

更新所有字段

Save()默認會更新該對象的所有字段，即使你沒有賦值。

db.First(&user)

user.Name = "七米"
user.Age = 99
db.Save(&user)

////  UPDATE `users` SET `created_at` = '2020-02-16 12:52:20', `updated_at` = '2020-02-16 12:54:55', `deleted_at` = NULL, `name` = '七米', `age` = 99, `active` = true  WHERE `users`.`deleted_at` IS NULL AND `users`.`id` = 1
更新修改字段

如果你只希望更新指定字段，可以使用Update或者Updates

// 更新單個屬性，如果它有變化
db.Model(&user).Update("name", "hello")
//// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111;

// 根據給定的條件更新單個屬性
db.Model(&user).Where("active = ?", true).Update("name", "hello")
//// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111 AND active=true;

// 使用 map 更新多個屬性，只會更新其中有變化的屬性
db.Model(&user).Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
//// UPDATE users SET name='hello', age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111;

// 使用 struct 更新多個屬性，只會更新其中有變化且為非零值的字段
db.Model(&user).Updates(User{Name: "hello", Age: 18})
//// UPDATE users SET name='hello', age=18, updated_at = '2013-11-17 21:34:10' WHERE id = 111;

// 警告：當使用 struct 更新時，GORM只會更新那些非零值的字段
// 對於下面的操作，不會發生任何更新，"", 0, false 都是其類型的零值
db.Model(&user).Updates(User{Name: "", Age: 0, Active: false})

更新選定字段

如果你想更新或忽略某些字段，你可以使用 Select，Omit

db.Model(&user).Select("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
//// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111;

db.Model(&user).Omit("name").Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
//// UPDATE users SET age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111;

無Hooks更新

上面的更新操作會自動運行 model 的 BeforeUpdate, AfterUpdate 方法，更新 UpdatedAt 時間戳, 在更新時保存其 Associations, 如果你不想調用這些方法，你可以使用 UpdateColumn， UpdateColumns

// 更新單個屬性，類似於 `Update`
db.Model(&user).UpdateColumn("name", "hello")
//// UPDATE users SET name='hello' WHERE id = 111;

// 更新多個屬性，類似於 `Updates`
db.Model(&user).UpdateColumns(User{Name: "hello", Age: 18})
//// UPDATE users SET name='hello', age=18 WHERE id = 111;

批量更新

批量更新時Hooks（鈎子函數）不會運行。

db.Table("users").Where("id IN (?)", []int{10, 11}).Updates(map[string]interface{}{"name": "hello", "age": 18})
//// UPDATE users SET name='hello', age=18 WHERE id IN (10, 11);

// 使用 struct 更新時，只會更新非零值字段，若想更新所有字段，請使用map[string]interface{}
db.Model(User{}).Updates(User{Name: "hello", Age: 18})
//// UPDATE users SET name='hello', age=18;

// 使用 `RowsAffected` 獲取更新記錄總數
db.Model(User{}).Updates(User{Name: "hello", Age: 18}).RowsAffected

使用SQL表達式更新

先查詢表中的第一條數據保存至user變量。

var user User
db.First(&user)
db.Model(&user).Update("age", gorm.Expr("age * ? + ?", 2, 100))
//// UPDATE `users` SET `age` = age * 2 + 100, `updated_at` = '2020-02-16 13:10:20'  WHERE `users`.`id` = 1;

db.Model(&user).Updates(map[string]interface{}{"age": gorm.Expr("age * ? + ?", 2, 100)})
//// UPDATE "users" SET "age" = age * '2' + '100', "updated_at" = '2020-02-16 13:05:51' WHERE `users`.`id` = 1;

db.Model(&user).UpdateColumn("age", gorm.Expr("age - ?", 1))
//// UPDATE "users" SET "age" = age - 1 WHERE "id" = '1';

db.Model(&user).Where("age > 10").UpdateColumn("age", gorm.Expr("age - ?", 1))
//// UPDATE "users" SET "age" = age - 1 WHERE "id" = '1' AND quantity > 10;

修改Hooks中的值

如果你想修改 BeforeUpdate, BeforeSave 等 Hooks 中更新的值，你可以使用 scope.SetColumn, 例如：

func (user *User) BeforeSave(scope *gorm.Scope) (err error) {
  if pw, err := bcrypt.GenerateFromPassword(user.Password, 0); err == nil {
    scope.SetColumn("EncryptedPassword", pw)
  }
}

其它更新選項

// 為 update SQL 添加其它的 SQL
db.Model(&user).Set("gorm:update_option", "OPTION (OPTIMIZE FOR UNKNOWN)").Update("name", "hello")
//// UPDATE users SET name='hello', updated_at = '2013-11-17 21:34:10' WHERE id=111 OPTION (OPTIMIZE FOR UNKNOWN);

七、刪除

刪除記錄

警告刪除記錄時，請確保主鍵字段有值，GORM 會通過主鍵去刪除記錄，如果主鍵為空，GORM 會刪除該 model 的所有記錄。

// 刪除現有記錄
db.Delete(&email)
//// DELETE from emails where id=10;

// 為刪除 SQL 添加額外的 SQL 操作
db.Set("gorm:delete_option", "OPTION (OPTIMIZE FOR UNKNOWN)").Delete(&email)
//// DELETE from emails where id=10 OPTION (OPTIMIZE FOR UNKNOWN);

批量刪除

刪除全部匹配的記錄

db.Where("email LIKE ?", "%jinzhu%").Delete(Email{})
//// DELETE from emails where email LIKE "%jinzhu%";

db.Delete(Email{}, "email LIKE ?", "%jinzhu%")
//// DELETE from emails where email LIKE "%jinzhu%";

軟刪除

如果一個 model 有 DeletedAt 字段，他將自動獲得軟刪除的功能！當調用 Delete 方法時，記錄不會真正的從數據庫中被刪除，只會將DeletedAt 字段的值會被設置為當前時間

db.Delete(&user)
//// UPDATE users SET deleted_at="2013-10-29 10:23" WHERE id = 111;

// 批量刪除
db.Where("age = ?", 20).Delete(&User{})
//// UPDATE users SET deleted_at="2013-10-29 10:23" WHERE age = 20;

// 查詢記錄時會忽略被軟刪除的記錄
db.Where("age = 20").Find(&user)
//// SELECT * FROM users WHERE age = 20 AND deleted_at IS NULL;

// Unscoped 方法可以查詢被軟刪除的記錄
db.Unscoped().Where("age = 20").Find(&users)
//// SELECT * FROM users WHERE age = 20;

物理刪除

// Unscoped 方法可以物理刪除記錄
db.Unscoped().Delete(&order)
//// DELETE FROM orders WHERE id=10;

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 CANOpen學習指南 OpenResty學習指南（一） netty學習指南 redis 學習指南 ECharts學習指南 cookie學習指南 OpenResty學習指南（二） JavaScript學習指南。 Python學習指南 Python入門學習指南