CRUD通常指数据库的增删改查操作,本文详细介绍了如何使用GORM实现创建、查询、更新和删除操作。

CRUD

CRUD通常指数据库的增删改查操作,本文详细介绍了如何使用GORM实现创建、查询、更新和删除操作。
本文中的db变量为*gorm.DB对象,例如:

  1. import (
  2. "github.com/jinzhu/gorm"
  3. _ "github.com/jinzhu/gorm/dialects/mysql"
  4. )
  5. func main() {
  6. db, err := gorm.Open("mysql", "user:password@/dbname?charset=utf8&parseTime=True&loc=Local")
  7. defer db.Close()
  8. // db.Xx
  9. }

创建

创建记录

首先定义模型:

  1. type User struct {
  2. ID int64
  3. Name string
  4. Age int64
  5. }

使用使用NewRecord()查询主键是否存在,主键为空使用Create()创建记录:

  1. user := User{Name: "q1mi", Age: 18}
  2. db.NewRecord(user) // 主键为空返回`true`
  3. db.Create(&user) // 创建user
  4. db.NewRecord(user) // 创建`user`后返回`false`

默认值

可以通过 tag 定义字段的默认值,比如:

  1. type User struct {
  2. ID int64
  3. Name string `gorm:"default:'小王子'"`
  4. Age int64
  5. }

注意:通过tag定义字段的默认值,在创建记录时候生成的 SQL 语句会排除没有值或值为 零值 的字段。 在将记录插入到数据库后,Gorm会从数据库加载那些字段的默认值。
举个例子:

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

上面代码实际执行的SQL语句是INSERT INTO users("age") values('99');,排除了零值字段Name,而在数据库中这一条数据会使用设置的默认值小王子作为Name字段的值。
注意:所有字段的零值, 比如0, "",false或者其它零值,都不会保存到数据库内,但会使用他们的默认值。 如果你想避免这种情况,可以考虑使用指针或实现 Scanner/Valuer接口,比如:

使用指针方式实现零值存入数据库

  1. // 使用指针
  2. type User struct {
  3. ID int64
  4. Name *string `gorm:"default:'小王子'"`
  5. Age int64
  6. }
  7. user := User{Name: new(string), Age: 18))}
  8. db.Create(&user) // 此时数据库中该条记录name字段的值就是''

使用Scanner/Valuer接口方式实现零值存入数据库

  1. // 使用 Scanner/Valuer
  2. type User struct {
  3. ID int64
  4. Name sql.NullString `gorm:"default:'小王子'"` // sql.NullString 实现了Scanner/Valuer接口
  5. Age int64
  6. }
  7. user := User{Name: sql.NullString{"", true}, Age:18}
  8. db.Create(&user) // 此时数据库中该条记录name字段的值就是''

扩展创建选项

例如PostgreSQL数据库中可以使用下面的方式实现合并插入, 有则更新, 无则插入。

  1. // 为Instert语句添加扩展SQL选项
  2. db.Set("gorm:insert_option", "ON CONFLICT").Create(&product)
  3. // INSERT INTO products (name, code) VALUES ("name", "code") ON CONFLICT;

查询

一般查询

  1. // 根据主键查询第一条记录
  2. db.First(&user)
  3. //// SELECT * FROM users ORDER BY id LIMIT 1;
  4. // 随机获取一条记录
  5. db.Take(&user)
  6. //// SELECT * FROM users LIMIT 1;
  7. // 根据主键查询最后一条记录
  8. db.Last(&user)
  9. //// SELECT * FROM users ORDER BY id DESC LIMIT 1;
  10. // 查询所有的记录
  11. db.Find(&users)
  12. //// SELECT * FROM users;
  13. // 查询指定的某条记录(仅当主键为整型时可用)
  14. db.First(&user, 10)
  15. //// SELECT * FROM users WHERE id = 10;

Where 条件

普通SQL查询

  1. // Get first matched record
  2. db.Where("name = ?", "jinzhu").First(&user)
  3. //// SELECT * FROM users WHERE name = 'jinzhu' limit 1;
  4. // Get all matched records
  5. db.Where("name = ?", "jinzhu").Find(&users)
  6. //// SELECT * FROM users WHERE name = 'jinzhu';
  7. // <>
  8. db.Where("name <> ?", "jinzhu").Find(&users)
  9. //// SELECT * FROM users WHERE name <> 'jinzhu';
  10. // IN
  11. db.Where("name IN (?)", []string{"jinzhu", "jinzhu 2"}).Find(&users)
  12. //// SELECT * FROM users WHERE name in ('jinzhu','jinzhu 2');
  13. // LIKE
  14. db.Where("name LIKE ?", "%jin%").Find(&users)
  15. //// SELECT * FROM users WHERE name LIKE '%jin%';
  16. // AND
  17. db.Where("name = ? AND age >= ?", "jinzhu", "22").Find(&users)
  18. //// SELECT * FROM users WHERE name = 'jinzhu' AND age >= 22;
  19. // Time
  20. db.Where("updated_at > ?", lastWeek).Find(&users)
  21. //// SELECT * FROM users WHERE updated_at > '2000-01-01 00:00:00';
  22. // BETWEEN
  23. db.Where("created_at BETWEEN ? AND ?", lastWeek, today).Find(&users)
  24. //// SELECT * FROM users WHERE created_at BETWEEN '2000-01-01 00:00:00' AND '2000-01-08 00:00:00';

Struct & Map查询

  1. // Struct
  2. db.Where(&User{Name: "jinzhu", Age: 20}).First(&user)
  3. //// SELECT * FROM users WHERE name = "jinzhu" AND age = 20 LIMIT 1;
  4. // Map
  5. db.Where(map[string]interface{}{"name": "jinzhu", "age": 20}).Find(&users)
  6. //// SELECT * FROM users WHERE name = "jinzhu" AND age = 20;
  7. // 主键的切片
  8. db.Where([]int64{20, 21, 22}).Find(&users)
  9. //// SELECT * FROM users WHERE id IN (20, 21, 22);

提示:当通过结构体进行查询时,GORM将会只通过非零值字段查询,这意味着如果你的字段值为0''false或者其他零值时,将不会被用于构建查询条件,例如:

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

你可以使用指针或实现 Scanner/Valuer 接口来避免这个问题.

  1. // 使用指针
  2. type User struct {
  3. gorm.Model
  4. Name string
  5. Age *int
  6. }
  7. // 使用 Scanner/Valuer
  8. type User struct {
  9. gorm.Model
  10. Name string
  11. Age sql.NullInt64 // sql.NullInt64 实现了 Scanner/Valuer 接口
  12. }

Not 条件

作用与 Where 类似的情形如下:

  1. db.Not("name", "jinzhu").First(&user)
  2. //// SELECT * FROM users WHERE name <> "jinzhu" LIMIT 1;
  3. // Not In
  4. db.Not("name", []string{"jinzhu", "jinzhu 2"}).Find(&users)
  5. //// SELECT * FROM users WHERE name NOT IN ("jinzhu", "jinzhu 2");
  6. // Not In slice of primary keys
  7. db.Not([]int64{1,2,3}).First(&user)
  8. //// SELECT * FROM users WHERE id NOT IN (1,2,3);
  9. db.Not([]int64{}).First(&user)
  10. //// SELECT * FROM users;
  11. // Plain SQL
  12. db.Not("name = ?", "jinzhu").First(&user)
  13. //// SELECT * FROM users WHERE NOT(name = "jinzhu");
  14. // Struct
  15. db.Not(User{Name: "jinzhu"}).First(&user)
  16. //// SELECT * FROM users WHERE name <> "jinzhu";

Or条件

  1. db.Where("role = ?", "admin").Or("role = ?", "super_admin").Find(&users)
  2. //// SELECT * FROM users WHERE role = 'admin' OR role = 'super_admin';
  3. // Struct
  4. db.Where("name = 'jinzhu'").Or(User{Name: "jinzhu 2"}).Find(&users)
  5. //// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';
  6. // Map
  7. db.Where("name = 'jinzhu'").Or(map[string]interface{}{"name": "jinzhu 2"}).Find(&users)
  8. //// SELECT * FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2';

内联条件

作用与Where查询类似,当内联条件与多个立即执行方法一起使用时, 内联条件不会传递给后面的立即执行方法。

  1. // 根据主键获取记录 (只适用于整形主键)
  2. db.First(&user, 23)
  3. //// SELECT * FROM users WHERE id = 23 LIMIT 1;
  4. // 根据主键获取记录, 如果它是一个非整形主键
  5. db.First(&user, "id = ?", "string_primary_key")
  6. //// SELECT * FROM users WHERE id = 'string_primary_key' LIMIT 1;
  7. // Plain SQL
  8. db.Find(&user, "name = ?", "jinzhu")
  9. //// SELECT * FROM users WHERE name = "jinzhu";
  10. db.Find(&users, "name <> ? AND age > ?", "jinzhu", 20)
  11. //// SELECT * FROM users WHERE name <> "jinzhu" AND age > 20;
  12. // Struct
  13. db.Find(&users, User{Age: 20})
  14. //// SELECT * FROM users WHERE age = 20;
  15. // Map
  16. db.Find(&users, map[string]interface{}{"age": 20})
  17. //// SELECT * FROM users WHERE age = 20;

额外查询选项

  1. // 为查询 SQL 添加额外的 SQL 操作
  2. db.Set("gorm:query_option", "FOR UPDATE").First(&user, 10)
  3. //// SELECT * FROM users WHERE id = 10 FOR UPDATE;

FirstOrInit

获取匹配的第一条记录,否则根据给定的条件初始化一个新的对象 (仅支持 struct 和 map 条件)

  1. // 未找到
  2. db.FirstOrInit(&user, User{Name: "non_existing"})
  3. //// user -> User{Name: "non_existing"}
  4. // 找到
  5. db.Where(User{Name: "Jinzhu"}).FirstOrInit(&user)
  6. //// user -> User{Id: 111, Name: "Jinzhu", Age: 20}
  7. db.FirstOrInit(&user, map[string]interface{}{"name": "jinzhu"})
  8. //// user -> User{Id: 111, Name: "Jinzhu", Age: 20}

Attrs

如果记录未找到,将使用参数初始化 struct.

  1. // 未找到
  2. db.Where(User{Name: "non_existing"}).Attrs(User{Age: 20}).FirstOrInit(&user)
  3. //// SELECT * FROM USERS WHERE name = 'non_existing';
  4. //// user -> User{Name: "non_existing", Age: 20}
  5. db.Where(User{Name: "non_existing"}).Attrs("age", 20).FirstOrInit(&user)
  6. //// SELECT * FROM USERS WHERE name = 'non_existing';
  7. //// user -> User{Name: "non_existing", Age: 20}
  8. // 找到
  9. db.Where(User{Name: "Jinzhu"}).Attrs(User{Age: 30}).FirstOrInit(&user)
  10. //// SELECT * FROM USERS WHERE name = jinzhu';
  11. //// user -> User{Id: 111, Name: "Jinzhu", Age: 20}

Assign

不管记录是否找到,都将参数赋值给 struct.

  1. // 未找到
  2. db.Where(User{Name: "non_existing"}).Assign(User{Age: 20}).FirstOrInit(&user)
  3. //// user -> User{Name: "non_existing", Age: 20}
  4. // 找到
  5. db.Where(User{Name: "Jinzhu"}).Assign(User{Age: 30}).FirstOrInit(&user)
  6. //// SELECT * FROM USERS WHERE name = jinzhu';
  7. //// user -> User{Id: 111, Name: "Jinzhu", Age: 30}

FirstOrCreate

获取匹配的第一条记录, 否则根据给定的条件创建一个新的记录 (仅支持 struct 和 map 条件)

  1. // 未找到
  2. db.FirstOrCreate(&user, User{Name: "non_existing"})
  3. //// INSERT INTO "users" (name) VALUES ("non_existing");
  4. //// user -> User{Id: 112, Name: "non_existing"}
  5. // 找到
  6. db.Where(User{Name: "Jinzhu"}).FirstOrCreate(&user)
  7. //// user -> User{Id: 111, Name: "Jinzhu"}

Attrs

如果记录未找到,将使用参数创建 struct 和记录.

  1. // 未找到
  2. db.Where(User{Name: "non_existing"}).Attrs(User{Age: 20}).FirstOrCreate(&user)
  3. //// SELECT * FROM users WHERE name = 'non_existing';
  4. //// INSERT INTO "users" (name, age) VALUES ("non_existing", 20);
  5. //// user -> User{Id: 112, Name: "non_existing", Age: 20}
  6. // 找到
  7. db.Where(User{Name: "jinzhu"}).Attrs(User{Age: 30}).FirstOrCreate(&user)
  8. //// SELECT * FROM users WHERE name = 'jinzhu';
  9. //// user -> User{Id: 111, Name: "jinzhu", Age: 20}

Assign

不管记录是否找到,都将参数赋值给 struct 并保存至数据库.

  1. // 未找到
  2. db.Where(User{Name: "non_existing"}).Assign(User{Age: 20}).FirstOrCreate(&user)
  3. //// SELECT * FROM users WHERE name = 'non_existing';
  4. //// INSERT INTO "users" (name, age) VALUES ("non_existing", 20);
  5. //// user -> User{Id: 112, Name: "non_existing", Age: 20}
  6. // 找到
  7. db.Where(User{Name: "jinzhu"}).Assign(User{Age: 30}).FirstOrCreate(&user)
  8. //// SELECT * FROM users WHERE name = 'jinzhu';
  9. //// UPDATE users SET age=30 WHERE id = 111;
  10. //// user -> User{Id: 111, Name: "jinzhu", Age: 30}

高级查询

子查询

基于 *gorm.expr 的子查询

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

选择字段

Select,指定你想从数据库中检索出的字段,默认会选择全部字段。

  1. db.Select("name, age").Find(&users)
  2. //// SELECT name, age FROM users;
  3. db.Select([]string{"name", "age"}).Find(&users)
  4. //// SELECT name, age FROM users;
  5. db.Table("users").Select("COALESCE(age,?)", 42).Rows()
  6. //// SELECT COALESCE(age,'42') FROM users;

排序

Order,指定从数据库中检索出记录的顺序。设置第二个参数 reorder 为 true ,可以覆盖前面定义的排序条件。

  1. db.Order("age desc, name").Find(&users)
  2. //// SELECT * FROM users ORDER BY age desc, name;
  3. // 多字段排序
  4. db.Order("age desc").Order("name").Find(&users)
  5. //// SELECT * FROM users ORDER BY age desc, name;
  6. // 覆盖排序
  7. db.Order("age desc").Find(&users1).Order("age", true).Find(&users2)
  8. //// SELECT * FROM users ORDER BY age desc; (users1)
  9. //// SELECT * FROM users ORDER BY age; (users2)

数量

Limit,指定从数据库检索出的最大记录数。

  1. db.Limit(3).Find(&users)
  2. //// SELECT * FROM users LIMIT 3;
  3. // -1 取消 Limit 条件
  4. db.Limit(10).Find(&users1).Limit(-1).Find(&users2)
  5. //// SELECT * FROM users LIMIT 10; (users1)
  6. //// SELECT * FROM users; (users2)

偏移

Offset,指定开始返回记录前要跳过的记录数。

  1. db.Offset(3).Find(&users)
  2. //// SELECT * FROM users OFFSET 3;
  3. // -1 取消 Offset 条件
  4. db.Offset(10).Find(&users1).Offset(-1).Find(&users2)
  5. //// SELECT * FROM users OFFSET 10; (users1)
  6. //// SELECT * FROM users; (users2)

总数

Count,该 model 能获取的记录总数。

  1. db.Where("name = ?", "jinzhu").Or("name = ?", "jinzhu 2").Find(&users).Count(&count)
  2. //// SELECT * from USERS WHERE name = 'jinzhu' OR name = 'jinzhu 2'; (users)
  3. //// SELECT count(*) FROM users WHERE name = 'jinzhu' OR name = 'jinzhu 2'; (count)
  4. db.Model(&User{}).Where("name = ?", "jinzhu").Count(&count)
  5. //// SELECT count(*) FROM users WHERE name = 'jinzhu'; (count)
  6. db.Table("deleted_users").Count(&count)
  7. //// SELECT count(*) FROM deleted_users;
  8. db.Table("deleted_users").Select("count(distinct(name))").Count(&count)
  9. //// SELECT count( distinct(name) ) FROM deleted_users; (count)

注意 Count 必须是链式查询的最后一个操作 ,因为它会覆盖前面的 SELECT,但如果里面使用了 count 时不会覆盖

Group & Having

  1. rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Rows()
  2. for rows.Next() {
  3. ...
  4. }
  5. // 使用Scan将多条结果扫描进事先准备好的结构体切片中
  6. type Result struct {
  7. Date time.Time
  8. Total int
  9. }
  10. var rets []Result
  11. db.Table("users").Select("date(created_at) as date, sum(age) as total").Group("date(created_at)").Scan(&rets)
  12. rows, err := db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Rows()
  13. for rows.Next() {
  14. ...
  15. }
  16. type Result struct {
  17. Date time.Time
  18. Total int64
  19. }
  20. db.Table("orders").Select("date(created_at) as date, sum(amount) as total").Group("date(created_at)").Having("sum(amount) > ?", 100).Scan(&results)

连接

Joins,指定连接条件

  1. rows, err := db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id").Rows()
  2. for rows.Next() {
  3. ...
  4. }
  5. db.Table("users").Select("users.name, emails.email").Joins("left join emails on emails.user_id = users.id").Scan(&results)
  6. // 多连接及参数
  7. 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)

Pluck

Pluck,查询 model 中的一个列作为切片,如果您想要查询多个列,您应该使用 Scan

  1. var ages []int64
  2. db.Find(&users).Pluck("age", &ages)
  3. var names []string
  4. db.Model(&User{}).Pluck("name", &names)
  5. db.Table("deleted_users").Pluck("name", &names)
  6. // 想查询多个字段? 这样做:
  7. db.Select("name, age").Find(&users)

扫描

Scan,扫描结果至一个 struct.

  1. type Result struct {
  2. Name string
  3. Age int
  4. }
  5. var result Result
  6. db.Table("users").Select("name, age").Where("name = ?", "Antonio").Scan(&result)
  7. var results []Result
  8. db.Table("users").Select("name, age").Where("id > ?", 0).Scan(&results)
  9. // 原生 SQL
  10. db.Raw("SELECT name, age FROM users WHERE name = ?", "Antonio").Scan(&result)

链式操作相关

链式操作

Method Chaining,Gorm 实现了链式操作接口,所以你可以把代码写成这样:

  1. // 创建一个查询
  2. tx := db.Where("name = ?", "jinzhu")
  3. // 添加更多条件
  4. if someCondition {
  5. tx = tx.Where("age = ?", 20)
  6. } else {
  7. tx = tx.Where("age = ?", 30)
  8. }
  9. if yetAnotherCondition {
  10. tx = tx.Where("active = ?", 1)
  11. }

在调用立即执行方法前不会生成Query语句,借助这个特性你可以创建一个函数来处理一些通用逻辑。

立即执行方法

Immediate methods ,立即执行方法是指那些会立即生成SQL语句并发送到数据库的方法, 他们一般是CRUD方法,比如:
Create, First, Find, Take, Save, UpdateXXX, Delete, Scan, Row, Rows
这有一个基于上面链式方法代码的立即执行方法的例子:

  1. tx.Find(&user)

生成的SQL语句如下:

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

范围

Scopes,Scope是建立在链式操作的基础之上的。
基于它,你可以抽取一些通用逻辑,写出更多可重用的函数库。

  1. func AmountGreaterThan1000(db *gorm.DB) *gorm.DB {
  2. return db.Where("amount > ?", 1000)
  3. }
  4. func PaidWithCreditCard(db *gorm.DB) *gorm.DB {
  5. return db.Where("pay_mode_sign = ?", "C")
  6. }
  7. func PaidWithCod(db *gorm.DB) *gorm.DB {
  8. return db.Where("pay_mode_sign = ?", "C")
  9. }
  10. func OrderStatus(status []string) func (db *gorm.DB) *gorm.DB {
  11. return func (db *gorm.DB) *gorm.DB {
  12. return db.Scopes(AmountGreaterThan1000).Where("status IN (?)", status)
  13. }
  14. }
  15. db.Scopes(AmountGreaterThan1000, PaidWithCreditCard).Find(&orders)
  16. // 查找所有金额大于 1000 的信用卡订单
  17. db.Scopes(AmountGreaterThan1000, PaidWithCod).Find(&orders)
  18. // 查找所有金额大于 1000 的 COD 订单
  19. db.Scopes(AmountGreaterThan1000, OrderStatus([]string{"paid", "shipped"})).Find(&orders)
  20. // 查找所有金额大于 1000 且已付款或者已发货的订单

多个立即执行方法

Multiple Immediate Methods,在 GORM 中使用多个立即执行方法时,后一个立即执行方法会复用前一个立即执行方法的条件 (不包括内联条件) 。

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

生成的 Sql

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

更新

更新所有字段

Save()默认会更新该对象的所有字段,即使你没有赋值。

  1. db.First(&user)
  2. user.Name = "七米"
  3. user.Age = 99
  4. db.Save(&user)
  5. //// 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

  1. // 更新单个属性,如果它有变化
  2. db.Model(&user).Update("name", "hello")
  3. //// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111;
  4. // 根据给定的条件更新单个属性
  5. db.Model(&user).Where("active = ?", true).Update("name", "hello")
  6. //// UPDATE users SET name='hello', updated_at='2013-11-17 21:34:10' WHERE id=111 AND active=true;
  7. // 使用 map 更新多个属性,只会更新其中有变化的属性
  8. db.Model(&user).Updates(map[string]interface{}{"name": "hello", "age": 18, "active": false})
  9. //// UPDATE users SET name='hello', age=18, active=false, updated_at='2013-11-17 21:34:10' WHERE id=111;
  10. // 使用 struct 更新多个属性,只会更新其中有变化且为非零值的字段
  11. db.Model(&user).Updates(User{Name: "hello", Age: 18})
  12. //// UPDATE users SET name='hello', age=18, updated_at = '2013-11-17 21:34:10' WHERE id = 111;
  13. // 警告:当使用 struct 更新时,GORM只会更新那些非零值的字段
  14. // 对于下面的操作,不会发生任何更新,"", 0, false 都是其类型的零值
  15. db.Model(&user).Updates(User{Name: "", Age: 0, Active: false})

更新选定字段

如果你想更新或忽略某些字段,你可以使用 SelectOmit

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

无Hooks更新

上面的更新操作会自动运行 model 的 BeforeUpdate, AfterUpdate 方法,更新 UpdatedAt 时间戳, 在更新时保存其 Associations, 如果你不想调用这些方法,你可以使用 UpdateColumnUpdateColumns

  1. // 更新单个属性,类似于 `Update`
  2. db.Model(&user).UpdateColumn("name", "hello")
  3. //// UPDATE users SET name='hello' WHERE id = 111;
  4. // 更新多个属性,类似于 `Updates`
  5. db.Model(&user).UpdateColumns(User{Name: "hello", Age: 18})
  6. //// UPDATE users SET name='hello', age=18 WHERE id = 111;

批量更新

批量更新时Hooks(钩子函数)不会运行。

  1. db.Table("users").Where("id IN (?)", []int{10, 11}).Updates(map[string]interface{}{"name": "hello", "age": 18})
  2. //// UPDATE users SET name='hello', age=18 WHERE id IN (10, 11);
  3. // 使用 struct 更新时,只会更新非零值字段,若想更新所有字段,请使用map[string]interface{}
  4. db.Model(User{}).Updates(User{Name: "hello", Age: 18})
  5. //// UPDATE users SET name='hello', age=18;
  6. // 使用 `RowsAffected` 获取更新记录总数
  7. db.Model(User{}).Updates(User{Name: "hello", Age: 18}).RowsAffected

使用SQL表达式更新

先查询表中的第一条数据保存至user变量。

  1. var user User
  2. db.First(&user)
  1. db.Model(&user).Update("age", gorm.Expr("age * ? + ?", 2, 100))
  2. //// UPDATE `users` SET `age` = age * 2 + 100, `updated_at` = '2020-02-16 13:10:20' WHERE `users`.`id` = 1;
  3. db.Model(&user).Updates(map[string]interface{}{"age": gorm.Expr("age * ? + ?", 2, 100)})
  4. //// UPDATE "users" SET "age" = age * '2' + '100', "updated_at" = '2020-02-16 13:05:51' WHERE `users`.`id` = 1;
  5. db.Model(&user).UpdateColumn("age", gorm.Expr("age - ?", 1))
  6. //// UPDATE "users" SET "age" = age - 1 WHERE "id" = '1';
  7. db.Model(&user).Where("age > 10").UpdateColumn("age", gorm.Expr("age - ?", 1))
  8. //// UPDATE "users" SET "age" = age - 1 WHERE "id" = '1' AND quantity > 10;

修改Hooks中的值

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

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

其它更新选项

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

删除

删除记录

警告 删除记录时,请确保主键字段有值,GORM 会通过主键去删除记录,如果主键为空,GORM 会删除该 model 的所有记录。

  1. // 删除现有记录
  2. db.Delete(&email)
  3. //// DELETE from emails where id=10;
  4. // 为删除 SQL 添加额外的 SQL 操作
  5. db.Set("gorm:delete_option", "OPTION (OPTIMIZE FOR UNKNOWN)").Delete(&email)
  6. //// DELETE from emails where id=10 OPTION (OPTIMIZE FOR UNKNOWN);

批量删除

删除全部匹配的记录

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

软删除

如果一个 model 有 DeletedAt 字段,他将自动获得软删除的功能! 当调用 Delete 方法时, 记录不会真正的从数据库中被删除, 只会将DeletedAt 字段的值会被设置为当前时间

  1. db.Delete(&user)
  2. //// UPDATE users SET deleted_at="2013-10-29 10:23" WHERE id = 111;
  3. // 批量删除
  4. db.Where("age = ?", 20).Delete(&User{})
  5. //// UPDATE users SET deleted_at="2013-10-29 10:23" WHERE age = 20;
  6. // 查询记录时会忽略被软删除的记录
  7. db.Where("age = 20").Find(&user)
  8. //// SELECT * FROM users WHERE age = 20 AND deleted_at IS NULL;
  9. // Unscoped 方法可以查询被软删除的记录
  10. db.Unscoped().Where("age = 20").Find(&users)
  11. //// SELECT * FROM users WHERE age = 20;

物理删除

  1. // Unscoped 方法可以物理删除记录
  2. db.Unscoped().Delete(&order)
  3. //// DELETE FROM orders WHERE id=10;