-
Notifications
You must be signed in to change notification settings - Fork 299
/
soft_delete.go
107 lines (90 loc) · 3.2 KB
/
soft_delete.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
// Copyright © 2021 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package store
import (
"context"
"fmt"
"time"
"github.com/jinzhu/gorm"
)
// SoftDelete makes a Delete operation set a DeletedAt instead of actually deleting the model.
type SoftDelete struct {
DeletedAt *time.Time `gorm:"index"`
}
func withSoftDeleted() func(*gorm.DB) *gorm.DB {
return func(db *gorm.DB) *gorm.DB {
return db.Unscoped()
}
}
type deletedOptionsKeyType struct{}
var deletedOptionsKey deletedOptionsKeyType
type deletedOptions struct {
IncludeDeleted bool
OnlyDeleted bool
}
func withSoftDeletedIfRequested(ctx context.Context) func(*gorm.DB) *gorm.DB {
if opts, ok := ctx.Value(deletedOptionsKey).(*deletedOptions); ok {
return func(db *gorm.DB) *gorm.DB {
if opts.IncludeDeleted || opts.OnlyDeleted {
db = db.Unscoped()
}
scope := db.NewScope(db.Value)
if opts.OnlyDeleted && scope.HasColumn("deleted_at") {
db = db.Where(fmt.Sprintf("%s.deleted_at IS NOT NULL", scope.TableName()))
}
return db
}
}
return func(db *gorm.DB) *gorm.DB { return db }
}
// WithSoftDeleted returns a context that tells the store to include (only) deleted entities.
func WithSoftDeleted(ctx context.Context, onlyDeleted bool) context.Context {
return context.WithValue(ctx, deletedOptionsKey, &deletedOptions{
IncludeDeleted: true,
OnlyDeleted: onlyDeleted,
})
}
// WithoutSoftDeleted returns a context that tells the store not to query for deleted entities.
func WithoutSoftDeleted(ctx context.Context) context.Context {
return context.WithValue(ctx, deletedOptionsKey, &deletedOptions{})
}
type expiredOptionsKeyType struct{}
var expiredOptionsKey expiredOptionsKeyType
type expiredOptions struct {
OnlyExpired bool
RestoreThreshold time.Duration
}
// WithExpired returns a context that tells the store to only query expired entities.
func WithExpired(ctx context.Context, threshold time.Duration) context.Context {
return context.WithValue(ctx, expiredOptionsKey, expiredOptions{
OnlyExpired: true,
RestoreThreshold: threshold,
})
}
func expiredFromContext(ctx context.Context) (onlyExpired bool, restoreThreshold time.Duration) {
if opts, ok := ctx.Value(expiredOptionsKey).(expiredOptions); ok {
return opts.OnlyExpired, opts.RestoreThreshold
}
return
}
func withExpiredEntities(expireThreshold time.Duration) func(*gorm.DB) *gorm.DB {
return func(db *gorm.DB) *gorm.DB {
scope := db.NewScope(db.Value)
if scope.HasColumn("deleted_at") {
db = db.Where(fmt.Sprintf("%s.deleted_at IS NOT NULL", scope.TableName())).
Where(fmt.Sprintf("%s.deleted_at < ?", scope.TableName()), time.Now().UTC().Add(-expireThreshold))
}
return db
}
}