-
Notifications
You must be signed in to change notification settings - Fork 16
/
types.go
458 lines (398 loc) · 11.8 KB
/
types.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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
package types
import (
"database/sql"
"fmt"
"io"
"log"
"reflect"
"strings"
"unsafe"
sq "github.com/Masterminds/squirrel"
"github.com/gbl08ma/sqalx"
"github.com/iancoleman/strcase"
"github.com/palantir/stacktrace"
)
const dbColumnTagName = "dbColumn"
const dbColumnRawTagName = "dbColumnRaw"
const dbIgnoreTagName = "dbIgnore"
const dbKeyTagName = "dbKey"
const dbTypeTagName = "dbType"
var logger = log.New(io.Discard, "", log.LstdFlags)
var sdb sq.StatementBuilderType
var dbTypes = make(map[string]reflect.Type)
func init() {
sdb = sq.StatementBuilder.PlaceholderFormat(sq.Dollar)
}
func registerCustomDBtype(t customDBType) {
rt := reflect.TypeOf(t)
dbTypes[rt.Elem().Name()] = rt.Elem()
}
type structDBfield struct {
column string
value interface{}
key bool
ignore bool
rawColumnName bool
specialType reflect.Type // a customDBtype
}
type tableNameSpecifier interface {
tableName() string
}
type extraDataQuerier interface {
queryExtra(sqalx.Node) error
}
type extraDataUpdater interface {
// updateExtra is called twice: once, before updating the main type, and again, after updating it (this helps dealing with foreign keys/row dependencies)
updateExtra(node sqalx.Node, preSelf bool) error
}
type extraDataDeleter interface {
// deleteExtra is called twice: once, before deleting the main type, and again, after deleting it (this helps dealing with foreign keys/row dependencies)
deleteExtra(node sqalx.Node, preSelf bool) error
}
type customDBType interface {
convertToDB(origValue interface{})
convertFromDB() interface{}
}
func getStructInfo(t interface{}) (fields []structDBfield, tableName string) {
rv := reflect.ValueOf(t)
rt := reflect.TypeOf(t)
if rt.Kind() == reflect.Ptr {
rv = rv.Elem()
rt = rt.Elem()
}
if s, specifiesTableName := t.(tableNameSpecifier); specifiesTableName {
tableName = s.tableName()
} else {
tableName = strcase.ToSnake(rt.Name())
}
fields = make([]structDBfield, 0, rt.NumField())
for i := 0; i < rt.NumField(); i++ {
fieldType := rt.Field(i)
columnName, rawColumnName, ignore, key, specialType := parseFieldTag(fieldType.Tag, fieldType.Name)
if ignore {
fields = append(fields, structDBfield{ignore: true})
continue
}
f := structDBfield{
column: columnName,
rawColumnName: rawColumnName,
key: key,
specialType: specialType,
}
if rv.IsValid() {
field := rv.Field(i)
if !field.CanInterface() {
// probably unexported
field = reflect.NewAt(field.Type(), unsafe.Pointer(field.UnsafeAddr())).Elem()
}
f.value = field.Interface()
}
fields = append(fields, f)
}
return fields, tableName
}
func parseFieldTag(tag reflect.StructTag, fieldName string) (columnName string, isRawColumnName, mustIgnore bool, isKey bool, specialType reflect.Type) {
if tag.Get(dbIgnoreTagName) == "true" {
return "", true, false, false, nil
}
columnName = strcase.ToSnake(fieldName)
if tn := tag.Get(dbColumnRawTagName); tn != "" {
columnName = tn
isRawColumnName = true
}
if tn := tag.Get(dbColumnTagName); tn != "" {
columnName = tn
}
isKey = tag.Get(dbKeyTagName) == "true"
return columnName, isRawColumnName, false, isKey, dbTypes[tag.Get(dbTypeTagName)]
}
func getWithSelect[T any](node sqalx.Node, sbuilder sq.SelectBuilder, withGlobalCount bool) ([]T, uint64, error) {
tx, err := node.Beginx()
if err != nil {
return []T{}, 0, stacktrace.Propagate(err, "")
}
defer tx.Commit() // read-only tx
var t T
fields, tableName := getStructInfo(t)
columns := make([]string, 0, len(fields)+1)
for _, f := range fields {
if !f.ignore {
if f.rawColumnName {
columns = append(columns, f.column)
} else {
columns = append(columns, tableName+"."+f.column)
}
}
}
if withGlobalCount {
columns = append(columns, "count(*) OVER() AS types_global_count")
}
query := sbuilder.Columns(columns...).From(tableName)
logger.Println(query.ToSql())
rows, err := query.RunWith(tx).Query()
if err != nil {
return []T{}, 0, stacktrace.Propagate(err, "")
}
rt := reflect.TypeOf(t)
if rt.Kind() == reflect.Ptr {
rt = rt.Elem()
}
values := []T{}
var globalCount uint64
for rows.Next() {
rv := reflect.New(rt).Elem()
valueFields := make([]interface{}, 0, rv.NumField())
for i := 0; i < rv.NumField(); i++ {
if fields[i].ignore {
continue
}
if fields[i].specialType == nil {
field := rv.Field(i)
if !field.Addr().CanInterface() {
// probably unexported
field = reflect.NewAt(field.Type(), unsafe.Pointer(field.UnsafeAddr())).Elem()
}
valueFields = append(valueFields, field.Addr().Interface())
} else {
valueFields = append(valueFields, reflect.New(fields[i].specialType).Interface())
}
}
if withGlobalCount {
valueFields = append(valueFields, &globalCount)
}
err = rows.Scan(valueFields...)
if err != nil {
rows.Close()
return []T{}, 0, stacktrace.Propagate(err, "")
}
// convert special types to the type wanted by the struct
j := 0
for i := 0; i < rv.NumField(); i++ {
if fields[i].ignore {
continue
}
if fields[i].specialType != nil {
vf := valueFields[j].(customDBType)
field := rv.Field(i)
field.Set(reflect.ValueOf(vf.convertFromDB()))
}
j++
}
values = append(values, rv.Addr().Interface().(T))
}
if !withGlobalCount {
globalCount = uint64(len(values))
}
rows.Close()
if _, hasExtra := (any)(t).(extraDataQuerier); hasExtra {
for i := range values {
v := (any)(values[i]).(extraDataQuerier)
err = v.queryExtra(tx)
if err != nil {
return values, globalCount, stacktrace.Propagate(err, "")
}
}
}
return values, globalCount, nil
}
// GetWithSelect returns a slice of all values for the generic type that match the conditions in sbuilder
func GetWithSelect[T any](node sqalx.Node, sbuilder sq.SelectBuilder) ([]T, error) {
items, _, err := getWithSelect[T](node, sbuilder, false)
if err != nil {
return nil, stacktrace.Propagate(err, "")
}
return items, nil
}
// GetWithSelect returns a slice of all values for the generic type that match the conditions in sbuilder
// along with a count of all values ignoring LIMIT or OFFSET clauses
func GetWithSelectAndCount[T any](node sqalx.Node, sbuilder sq.SelectBuilder) ([]T, uint64, error) {
return getWithSelect[T](node, sbuilder, true)
}
// Update updates or inserts values t in the database
func Update[T any](node sqalx.Node, t ...T) error {
return stacktrace.Propagate(updateOrInsert(node, true, t), "")
}
// Insert inserts values t in the database
func Insert[T any](node sqalx.Node, t ...T) error {
return stacktrace.Propagate(updateOrInsert(node, false, t), "")
}
// updateOrInsert updates or inserts values t in the database
func updateOrInsert[T any](node sqalx.Node, allowUpdate bool, t []T) error {
if len(t) == 0 {
return nil
}
tx, err := node.Beginx()
if err != nil {
return stacktrace.Propagate(err, "")
}
defer tx.Rollback()
columns := []string{}
rows := [][]interface{}{}
fields := []structDBfield{}
tableName := ""
_, hasExtra := (any)(t[0]).(extraDataUpdater)
for rowIdx, ti := range t {
if hasExtra {
err = (any)(ti).(extraDataUpdater).updateExtra(tx, true)
if err != nil {
return stacktrace.Propagate(err, "")
}
}
fields, tableName = getStructInfo(ti)
values := []interface{}{}
for i := range fields {
if !fields[i].ignore {
if rowIdx == 0 {
columns = append(columns, fields[i].column)
}
if fields[i].specialType != nil {
// convert special types
converted := reflect.New(fields[i].specialType).Interface().(customDBType)
converted.convertToDB(fields[i].value)
fields[i].value = converted
}
values = append(values, fields[i].value)
}
}
rows = append(rows, values)
}
suffixStr := ""
keyFields := make([]*structDBfield, 0, len(fields))
keyFieldNames := make([]string, 0, len(fields))
for _, field := range fields {
if field.key {
keyFields = append(keyFields, &field)
keyFieldNames = append(keyFieldNames, field.column)
}
}
if allowUpdate && len(keyFields) > 0 {
suffixStr = "ON CONFLICT (" + strings.Join(keyFieldNames, ", ") + ") DO UPDATE SET "
updateFields := 0
for _, field := range fields {
if !field.key && !field.ignore {
suffixStr += fmt.Sprintf("%s = EXCLUDED.%s,", field.column, field.column)
updateFields++
}
}
if updateFields == 0 {
// all columns on this table are part of the primary key
suffixStr = suffixStr[:len(suffixStr)-len("UPDATE SET ")] + "NOTHING"
} else {
suffixStr = suffixStr[:len(suffixStr)-1]
}
}
builder := sdb.Insert(tableName).Columns(columns...)
for _, values := range rows {
builder = builder.Values(values...)
}
builder = builder.Suffix(suffixStr)
logger.Println(builder.ToSql())
_, err = builder.RunWith(tx).Exec()
if err != nil {
return stacktrace.Propagate(err, "")
}
// call updateExtra again, this time with preSelf == false
if hasExtra {
for _, ti := range t {
err = (any)(ti).(extraDataUpdater).updateExtra(tx, false)
if err != nil {
return stacktrace.Propagate(err, "")
}
}
}
return stacktrace.Propagate(tx.Commit(), "")
}
// DeleteCustom deletes the values which match the conditions in dbuilder
func DeleteCustom[T any](node sqalx.Node, dbuilder sq.DeleteBuilder) error {
tx, err := node.Beginx()
if err != nil {
return stacktrace.Propagate(err, "")
}
defer tx.Rollback()
var t T
_, tableName := getStructInfo(t)
builder := dbuilder.From(tableName)
logger.Println(builder.ToSql())
_, err = builder.RunWith(tx).Exec()
if err != nil {
return stacktrace.Propagate(err, "")
}
return stacktrace.Propagate(tx.Commit(), "")
}
// Delete deletes values t from the database.
func Delete[T any](node sqalx.Node, t ...T) error {
return stacktrace.Propagate(deleteValues(node, false, t), "")
}
// MustDelete deletes values t from the database.
// MustDelete is like Delete but returns an error when no rows were deleted even though a non-zero argument count was passed
func MustDelete[T any](node sqalx.Node, t ...T) error {
return stacktrace.Propagate(deleteValues(node, true, t), "")
}
// delete deletes values t from the database
func deleteValues[T any](node sqalx.Node, errorOnNothingDeleted bool, t []T) error {
if len(t) == 0 {
return nil
}
tx, err := node.Beginx()
if err != nil {
return stacktrace.Propagate(err, "")
}
defer tx.Rollback()
or := make(sq.Or, 0, len(t))
tableName := ""
_, hasExtra := (any)(t[0]).(extraDataDeleter)
for _, ti := range t {
if hasExtra {
err = (any)(ti).(extraDataDeleter).deleteExtra(tx, true)
if err != nil {
return stacktrace.Propagate(err, "")
}
}
var fields []structDBfield
fields, tableName = getStructInfo(ti)
deleteEqs := make(map[string]interface{})
for _, field := range fields {
if field.key {
deleteEqs[field.column] = field.value
}
}
if len(deleteEqs) == 0 {
return stacktrace.NewError("type does not have any known keys")
}
or = append(or, sq.Eq(deleteEqs))
}
builder := sdb.Delete(tableName).Where(or)
logger.Println(builder.ToSql())
result, err := builder.RunWith(tx).Exec()
if err != nil {
return stacktrace.Propagate(err, "")
}
// call deleteExtra again, this time with preSelf == false
if hasExtra {
for _, ti := range t {
err = (any)(ti).(extraDataDeleter).deleteExtra(tx, false)
if err != nil {
return stacktrace.Propagate(err, "")
}
}
}
if errorOnNothingDeleted {
rowsAffected, err := result.RowsAffected()
if err != nil {
return stacktrace.Propagate(err, "")
}
if rowsAffected == 0 {
return sql.ErrNoRows
}
}
return stacktrace.Propagate(tx.Commit(), "")
}
// SetLogger sets the logger that will be used for verbose output of the functions in this package
func SetLogger(l *log.Logger) {
logger = l
}
func subQueryEq(property string, query sq.SelectBuilder) sq.Sqlizer {
sql, args, _ := query.ToSql()
subQuery := fmt.Sprintf("%s = (%s)", property, sql)
return sq.Expr(subQuery, args...)
}