Golang 使用gorm进行upsert

Golang 使用gorm进行upsert

upsert 是数据库插入操作的扩展，如果某个唯一字段已经存在，则将本次新增插入操作变成更新操作，否则就正常执行插入操作。

从 1.20.x 开始，GORM 为不同的数据库提供兼容的 Upsert 支持（Upsert-On-Conflict）

1 简单应用

// 在 `id` 冲突时将列更新为新值
DB.Clauses(clause.OnConflict{
  Columns:   []clause.Column{{Name: "id"}}, // key colume
  // 也可以用 map [ string ] interface {} { "role" : "user" }
  DoUpdates: clause.AssignmentColumns([]string{"name", "age"}), // column needed to be updated
}).Create(&users)

其中新增还是更新根据指定的唯一索引字段确定。
上例中，id为主键，如果新增的记录id相同(不冲突)，则不新增只更新name和age字段，否则新增一条users记录。
等同于下列SQL操作：

// SQL Server
MERGE INTO "users" USING *** WHEN NOT MATCHED THEN INSERT *** WHEN MATCHED THEN UPDATE SET "name"="excluded"."name"; 
//  PostgreSQL
INSERT INTO "users" *** ON CONFLICT ("id") DO UPDATE SET "name"="excluded"."name", "age"="excluded"."age";
// MySQL
INSERT INTO `users` *** ON DUPLICATE KEY UPDATE `name`=VALUES(name),`age=VALUES(age); 

1.1 支持用切片upsert多个记录，用map设置默认值

db.Clauses(clause.OnConflict{ 
 // 在 `id` 冲突时将列更新为默认值
  Columns: []clause.Column{{Name: "id" }}, 
  DoUpdates: clause.Assignments(map[string]interface{}{"role" : "user"}), 
}).Create(&users)  // users可以是切边
// MERGE INTO "users" USING *** WHEN NOT MATCHED THEN INSERT *** WHEN MATCHED THEN UPDATE SET ***; SQL Server 
// INSERT INTO `users` *** ON DUPLICATE KEY UPDATE ***; MySQL

在主键id冲突时，更新users中的"role" 为 “user”。

2 自定义索引字段

DB.Clauses(clause.OnConflict{
  Columns:   []clause.Column{{Name: "key1"}, {Name: "key2"}},
  UpdateAll: true,  // 主键冲突时, 更新除主键的所有字段
}).Create(&users)

使用唯一联合索引字段 key1+key2 ，只有这两个字段联合不唯一时才新增，否则更新users表中的所有字段。
Gorm插入的记录是插入还是更新操作，是根据是否存在主键冲突来决定，当出现主键冲突时则进行更新操作（使用 ON DUPLICATE KEY UPDATE 语句后面的参数），否则进行插入操作。
所以Columns必须是唯一索引，主键索引或者其他唯一联合索引都行。