Louis Thibault
Louis Thibault

Reputation: 21450

How can I check for errors in CRUD operations using GORM?

The official documentation for GORM demonstrates a way in which one can test for the existence of a record, i.e.:

user := User{Name: "Jinzhu", Age: 18, Birthday: time.Now()}

// returns true if record hasn’t been saved (primary key `Id` is blank)
db.NewRecord(user) // => true

db.Create(&user)

// will return false after `user` created
db.NewRecord(user) // => false

This can be used to test indirectly for errors in record creation but reports no useful information in the event of a failure.

Having checked the source code for db.Create, there seems to be some sort of stack-frame inspection that checks for errors before proceeding, meaning that transactional errors will fail silently:

func Create(scope *Scope) {
    defer scope.Trace(NowFunc())

    if !scope.HasError() {
        // actually perform the transaction
    }
}

Upvotes: 25

Views: 19439

Answers (3)

If you want to check type of error, just do it.

if err := db.Create(&user).Error; err != nil {

  if errors.Is(err, gorm.ErrRecordNotFound) {
    fmt.Println(err.Error())
  }

  return

}

Upvotes: 1

windyzboy
windyzboy

Reputation: 1375

I have tried the accepted answer, but it doesn't work, db.Error always return nil.

Just change something and it works, hope it helps somebody:

if err := db.Create(&Animal{Name: "Giraffe"}).Error; err != nil {
   // Create failed, do something e.g. return, panic etc.
   return 
}

Upvotes: 19

icza
icza

Reputation: 418217

DB.Create() returns a new (cloned) gorm.DB which is a struct and has a field Error:

type DB struct {
    Value        interface{}
    Error        error
    RowsAffected int64
    // contains filtered or unexported fields
}

You can store the returned *gorm.DB value and check its DB.Error field like this:

if dbc := db.Create(&user); dbc.Error != nil {
    // Create failed, do something e.g. return, panic etc.
    return
}

If you don't need anything else from the returned gorm.DB, you can directly check its Error field:

if db.Create(&user).Error != nil {
    // Create failed, do something e.g. return, panic etc.
    return
}

Upvotes: 30

Related Questions