GORM中clause.Returning{}使用报错，求正确用法指导

错误原因分析 #

你遇到的undefined: clause错误，核心原因是未正确导入GORM的clause子包，或者错误使用了包引用路径（比如gorm.clause这种写法是错误的，clause是独立的子包，不属于gorm包的嵌套结构）。

正确步骤 #

1. 导入clause包 #

首先确保代码中导入了正确的clause子包：

import (
  "gorm.io/gorm"
  "gorm.io/gorm/clause" // 必须导入该包
)

2. clause.Returning的常用写法 #

根据需求不同，有几种常见使用方式：

• 返回所有字段：直接使用空结构体

  db.Clauses(clause.Returning{}).Create(&user)
  

• 返回指定字段：明确指定需要返回的列

  // 返回id和name字段
  db.Clauses(clause.Returning{
    Columns: []clause.Column{{Name: "id"}, {Name: "name"}},
  }).Update(&user)
  

• 返回特定模型的所有字段（适用于关联表或指定表场景）

  db.Clauses(clause.Returning{Columns: clause.ColumnsOf(&User{})}).Create(&user)
  

3. 注意数据库兼容性 #

Returning子句仅支持PostgreSQL、SQLite 3.35+、SQL Server等数据库，MySQL不支持该语法。如果你的数据库是MySQL，使用该clause会触发语法错误，无需使用。

完整示例代码 #

package main

import (
  "gorm.io/driver/postgres"
  "gorm.io/gorm"
  "gorm.io/gorm/clause"
)

type User struct {
  ID   uint
  Name string
  Age  int
}

func main() {
  dsn := "host=localhost user=gorm password=gorm dbname=gorm port=5432 sslmode=disable"
  db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
  if err != nil {
    panic("failed to connect database")
  }

  // 自动迁移表结构
  db.AutoMigrate(&User{})

  // 创建用户并返回所有字段
  var user User
  db.Clauses(clause.Returning{}).Create(&User{Name: "Alice", Age: 20}).Scan(&user)
  // 此时user会包含数据库生成的ID等字段

  // 更新用户并返回指定字段
  var updatedUser User
  db.Clauses(clause.Returning{Columns: []clause.Column{{Name: "name"}, {Name: "age"}}}).
    Model(&User{ID: user.ID}).Update("age", 21).Scan(&updatedUser)
}

内容的提问来源于stack exchange，提问作者Muhammed afsal