Skip to content

Commit

Permalink
update Delete Godoc to describe soft delete behaviour (#5554)
Browse files Browse the repository at this point in the history
  • Loading branch information
bruc3mackenzi3 authored and jinzhu committed Sep 22, 2022
1 parent 0636818 commit a9b19f6
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion finisher_api.go
Expand Up @@ -388,7 +388,9 @@ func (db *DB) UpdateColumns(values interface{}) (tx *DB) {
return tx.callbacks.Update().Execute(tx)
}

// Delete delete value match given conditions, if the value has primary key, then will including the primary key as condition
// Delete deletes value matching given conditions. If value contains primary key it is included in the conditions.
// If value includes a deleted_at field, then Delete performs a soft delete instead by setting deleted_at with the current
// time if null.
func (db *DB) Delete(value interface{}, conds ...interface{}) (tx *DB) {
tx = db.getInstance()
if len(conds) > 0 {
Expand Down

0 comments on commit a9b19f6

Please sign in to comment.