forked from jmoiron/sqlx
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqlx.go
1055 lines (913 loc) · 30.2 KB
/
sqlx.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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package sqlx
import (
"database/sql"
"errors"
"io/ioutil"
"log"
"path/filepath"
"reflect"
"strings"
)
// NameMapper is used to map column names to struct field names. By default,
// it uses strings.ToLower to lowercase struct field names. It can be set
// to whatever you want, but it is encouraged to be set before sqlx is used
// as field-to-name mappings are cached after first use on a type.
var NameMapper = strings.ToLower
// A wrapper around sql.Rows which caches costly reflect operations
// during a looped StructScan
type Rows struct {
sql.Rows
started bool
fields []int
base reflect.Type
values []interface{}
}
// A reimplementation of sql.Row in order to gain access to the underlying
// sql.Rows.Columns() data, necessary for StructScan.
type Row struct {
err error
rows *sql.Rows
}
// An interface for something which can Scan and return a list of columns (Row, Rows)
type ColScanner interface {
Columns() ([]string, error)
Scan(dest ...interface{}) error
Err() error
}
// An interface for something which can Execute sql queries (Tx, DB, Stmt)
type Queryer interface {
Query(query string, args ...interface{}) (*sql.Rows, error)
Queryx(query string, args ...interface{}) (*Rows, error)
QueryRowx(query string, args ...interface{}) *Row
}
// An interface for something which can Execute sql commands (Tx, DB, Stmt)
type Execer interface {
Exec(query string, args ...interface{}) (sql.Result, error)
}
// An interface for something which can bind queries (Tx, DB)
type Binder interface {
DriverName() string
Rebind(string) string
BindMap(string, map[string]interface{}) (string, []interface{}, error)
BindStruct(string, interface{}) (string, []interface{}, error)
}
// A union interface which can bind, query, and exec (Tx, DB), used for
// NamedQuery and NamedExec, which requires exec/query and BindMap/Struct
type Ext interface {
Binder
Queryer
Execer
}
// An interface for something which can Prepare sql statements (Tx, DB)
type Preparer interface {
Prepare(query string) (*sql.Stmt, error)
}
// Same implementation as sql.Row.Scan
func (r *Row) Scan(dest ...interface{}) error {
if r.err != nil {
return r.err
}
// TODO(bradfitz): for now we need to defensively clone all
// []byte that the driver returned (not permitting
// *RawBytes in Rows.Scan), since we're about to close
// the Rows in our defer, when we return from this function.
// the contract with the driver.Next(...) interface is that it
// can return slices into read-only temporary memory that's
// only valid until the next Scan/Close. But the TODO is that
// for a lot of drivers, this copy will be unnecessary. We
// should provide an optional interface for drivers to
// implement to say, "don't worry, the []bytes that I return
// from Next will not be modified again." (for instance, if
// they were obtained from the network anyway) But for now we
// don't care.
for _, dp := range dest {
if _, ok := dp.(*sql.RawBytes); ok {
return errors.New("sql: RawBytes isn't allowed on Row.Scan")
}
}
defer r.rows.Close()
if !r.rows.Next() {
if r.rows.Err() != nil {
r.err = r.rows.Err()
return r.err
}
return sql.ErrNoRows
}
return r.rows.Scan(dest...)
}
// Return the underlying sql.Rows.Columns(), or the deferred error usually
// returned by Row.Scan()
func (r *Row) Columns() ([]string, error) {
if r.err != nil {
return []string{}, r.err
}
return r.rows.Columns()
}
func (r *Row) Err() error {
return r.err
}
// A wrapper around sql.DB which keeps track of the driverName upon Open,
// used mostly to automatically bind named queries using the right bindvars.
type DB struct {
sql.DB
driverName string
}
func NewDb(db *sql.DB, driverName string) *DB {
return &DB{*db, driverName}
}
// DriverName returns the driverName passed to the Open function for this DB.
func (db *DB) DriverName() string {
return db.driverName
}
// Open is the same as database/sql's Open, but returns an *sqlx.DB instead.
func Open(driverName, dataSourceName string) (*DB, error) {
db, err := sql.Open(driverName, dataSourceName)
if err != nil {
return nil, err
}
return &DB{*db, driverName}, err
}
// Rebind transforms a query from QUESTION to the DB driver's bindvar type.
func (db *DB) Rebind(query string) string {
return Rebind(BindType(db.driverName), query)
}
// BindMap's a query using the DB driver's bindvar type.
func (db *DB) BindMap(query string, argmap map[string]interface{}) (string, []interface{}, error) {
return BindMap(BindType(db.driverName), query, argmap)
}
// BindStruct's a query using the DB driver's bindvar type.
func (db *DB) BindStruct(query string, arg interface{}) (string, []interface{}, error) {
return BindStruct(BindType(db.driverName), query, arg)
}
// NamedQueryMap using this DB.
func (db *DB) NamedQueryMap(query string, argmap map[string]interface{}) (*Rows, error) {
return NamedQueryMap(db, query, argmap)
}
// NamedExecMap using this DB.
func (db *DB) NamedExecMap(query string, argmap map[string]interface{}) (sql.Result, error) {
return NamedExecMap(db, query, argmap)
}
// NamedQuery using this DB.
func (db *DB) NamedQuery(query string, arg interface{}) (*Rows, error) {
return NamedQuery(db, query, arg)
}
// NamedExec using this DB.
func (db *DB) NamedExec(query string, arg interface{}) (sql.Result, error) {
return NamedExec(db, query, arg)
}
// Select using this DB.
func (db *DB) Select(dest interface{}, query string, args ...interface{}) error {
return Select(db, dest, query, args...)
}
// Selectf using this DB.
func (db *DB) Selectf(dest interface{}, query string, args ...interface{}) {
Selectf(db, dest, query, args...)
}
// Selectv using this DB.
func (db *DB) Selectv(dest interface{}, query string, args ...interface{}) error {
return Selectv(db, dest, query, args...)
}
// Get using this DB.
func (db *DB) Get(dest interface{}, query string, args ...interface{}) error {
return Get(db, dest, query, args...)
}
// LoadFile using this DB.
func (db *DB) LoadFile(path string) (*sql.Result, error) {
return LoadFile(db, path)
}
// Begin starts a transaction, and panics on error. Returns an *sqlx.Tx instead
// of an *sql.Tx.
func (db *DB) MustBegin() *Tx {
tx, err := db.Beginx()
if err != nil {
panic(err)
}
return tx
}
// Same as Begin, but returns an *sqlx.Tx instead of an *sql.Tx.
func (db *DB) Beginx() (*Tx, error) {
if tx, err := db.DB.Begin(); err != nil {
return nil, err
} else {
return &Tx{*tx, db.driverName}, err
}
}
// Same as Query, but returns an *sqlx.Rows instead of *sql.Rows.
func (db *DB) Queryx(query string, args ...interface{}) (*Rows, error) {
if r, err := db.DB.Query(query, args...); err != nil {
return nil, err
} else {
return &Rows{Rows: *r}, err
}
}
// Same as QueryRow, but returns an *sqlx.Row instead of *sql.Row.
func (db *DB) QueryRowx(query string, args ...interface{}) *Row {
rows, err := db.DB.Query(query, args...)
return &Row{rows: rows, err: err}
}
// Execv (verbose) runs Execv using this database.
func (db *DB) Execv(query string, args ...interface{}) (sql.Result, error) {
return Execv(db, query, args...)
}
// Execl (log) runs Execl using this database.
func (db *DB) Execl(query string, args ...interface{}) sql.Result {
return Execl(db, query, args...)
}
// Execf (fatal) runs Execf using this database.
func (db *DB) Execf(query string, args ...interface{}) sql.Result {
return Execf(db, query, args...)
}
// Execp (panic) runs Execp using this database.
func (db *DB) Execp(query string, args ...interface{}) sql.Result {
return Execp(db, query, args...)
}
// MustExec (panic) runs MustExec using this database.
func (db *DB) MustExec(query string, args ...interface{}) sql.Result {
return MustExec(db, query, args...)
}
// Preparex returns an sqlx.Stmt instead of a sql.Stmt
func (db *DB) Preparex(query string) (*Stmt, error) {
return Preparex(db, query)
}
// An sqlx wrapper around database/sql's Tx with extra functionality
type Tx struct {
sql.Tx
driverName string
}
// Return the driverName used by the DB which began a transaction.
func (tx *Tx) DriverName() string {
return tx.driverName
}
// Rebind a query within a transaction's bindvar type.
func (tx *Tx) Rebind(query string) string {
return Rebind(BindType(tx.driverName), query)
}
// BindMap's a query within a transaction's bindvar type.
func (tx *Tx) BindMap(query string, argmap map[string]interface{}) (string, []interface{}, error) {
return BindMap(BindType(tx.driverName), query, argmap)
}
// BindStruct's a query within a transaction's bindvar type.
func (tx *Tx) BindStruct(query string, arg interface{}) (string, []interface{}, error) {
return BindStruct(BindType(tx.driverName), query, arg)
}
// NamedQuery within a transaction.
func (tx *Tx) NamedQuery(query string, arg interface{}) (*Rows, error) {
return NamedQuery(tx, query, arg)
}
// Exec a named query within a transaction.
func (tx *Tx) NamedExec(query string, arg interface{}) (sql.Result, error) {
return NamedExec(tx, query, arg)
}
// LoadFile within a transaction.
func (tx *Tx) LoadFile(path string) (*sql.Result, error) {
return LoadFile(tx, path)
}
// Select within a transaction.
func (tx *Tx) Select(dest interface{}, query string, args ...interface{}) error {
return Select(tx, dest, query, args...)
}
// Query within a transaction, returning *sqlx.Rows instead of *sql.Rows.
func (tx *Tx) Queryx(query string, args ...interface{}) (*Rows, error) {
if r, err := tx.Tx.Query(query, args...); err != nil {
return nil, err
} else {
return &Rows{Rows: *r}, err
}
}
// QueryRow within a transaction, returning *sqlx.Row instead of *sql.Row.
func (tx *Tx) QueryRowx(query string, args ...interface{}) *Row {
rows, err := tx.Tx.Query(query, args...)
return &Row{rows: rows, err: err}
}
// Get within a transaction.
func (tx *Tx) Get(dest interface{}, query string, args ...interface{}) error {
return Get(tx, dest, query, args...)
}
// Selectv (verbose) within a transaction.
func (tx *Tx) Selectv(dest interface{}, query string, args ...interface{}) error {
return Selectv(tx, dest, query, args...)
}
// Selectf (fatal) within a transaction.
func (tx *Tx) Selectf(dest interface{}, query string, args ...interface{}) {
Selectf(tx, dest, query, args...)
}
// Execv (verbose) runs Execv within a transaction.
func (tx *Tx) Execv(query string, args ...interface{}) (sql.Result, error) {
return Execv(tx, query, args...)
}
// Execl (log) runs Execl within a transaction.
func (tx *Tx) Execl(query string, args ...interface{}) sql.Result {
return Execl(tx, query, args...)
}
// Execf (fatal) runs Execf within a transaction.
func (tx *Tx) Execf(query string, args ...interface{}) sql.Result {
return Execf(tx, query, args...)
}
// Execp (panic) runs Execp within a transaction.
func (tx *Tx) Execp(query string, args ...interface{}) sql.Result {
return Execp(tx, query, args...)
}
// MustExec (panic) runs MustExec within a transaction.
func (tx *Tx) MustExec(query string, args ...interface{}) sql.Result {
return MustExec(tx, query, args...)
}
// Prepare's a statement within a transaction, returning a *sqlx.Stmt instead of an *sql.Stmt.
func (tx *Tx) Preparex(query string) (*Stmt, error) {
return Preparex(tx, query)
}
// Returns a version of the prepared statement which runs within a transaction. Provided
// stmt can be either *sql.Stmt or *sqlx.Stmt, and the return value is always *sqlx.Stmt.
func (tx *Tx) Stmtx(stmt interface{}) *Stmt {
var st sql.Stmt
var s *sql.Stmt
switch stmt.(type) {
case sql.Stmt:
st = stmt.(sql.Stmt)
s = &st
case Stmt:
s = stmt.(Stmt).Stmt
case *Stmt:
s = stmt.(*Stmt).Stmt
case *sql.Stmt:
s = stmt.(*sql.Stmt)
}
return &Stmt{tx.Stmt(s)}
}
// An sqlx wrapper around database/sql's Stmt with extra functionality
// Although a Stmt's interface differs from Tx and DB's, internally,
// a wrapper is used to satisfy the Queryer & Execer interfaces.
type Stmt struct{ *sql.Stmt }
// this unexposed wrapper lets you use a Stmt as a Queryer & Execer by
// implementing those interfaces but ignoring the `query` argument.
type qStmt struct{ Stmt }
func (q *qStmt) Query(query string, args ...interface{}) (*sql.Rows, error) {
return q.Stmt.Query(args...)
}
func (q *qStmt) Queryx(query string, args ...interface{}) (*Rows, error) {
if r, err := q.Stmt.Query(args...); err != nil {
return nil, err
} else {
return &Rows{Rows: *r}, err
}
}
func (q *qStmt) QueryRowx(query string, args ...interface{}) *Row {
rows, err := q.Stmt.Query(args...)
return &Row{rows: rows, err: err}
}
func (q *qStmt) Exec(query string, args ...interface{}) (sql.Result, error) {
return q.Stmt.Exec(args...)
}
// Select using the prepared statement.
func (s *Stmt) Select(dest interface{}, args ...interface{}) error {
return Select(&qStmt{*s}, dest, "", args...)
}
// Selectv (verbose) using the prepared statement.
func (s *Stmt) Selectv(dest interface{}, args ...interface{}) error {
return Selectv(&qStmt{*s}, dest, "", args...)
}
// Selectf (fatal) using the prepared statement.
func (s *Stmt) Selectf(dest interface{}, args ...interface{}) {
Selectf(&qStmt{*s}, dest, "", args...)
}
// Get using the prepared statement.
func (s *Stmt) Get(dest interface{}, args ...interface{}) error {
return Get(&qStmt{*s}, dest, "", args...)
}
// Execv (verbose) runs Execv using this statement. Note that the query
// portion of the error output will be blank, as Stmt does not expose its query.
func (s *Stmt) Execv(args ...interface{}) (sql.Result, error) {
return Execv(&qStmt{*s}, "", args...)
}
// Execl (log) using this statement. Note that the query portion of the error
// output will be blank, as Stmt does not expose its query.
func (s *Stmt) Execl(args ...interface{}) sql.Result {
return Execl(&qStmt{*s}, "", args...)
}
// Execf (fatal) using this statement. Note that the query portion of the error
// output will be blank, as Stmt does not expose its query.
func (s *Stmt) Execf(args ...interface{}) sql.Result {
return Execf(&qStmt{*s}, "", args...)
}
// Execf (panic) using this statement. Note that the query portion of the error
// output will be blank, as Stmt does not expose its query.
func (s *Stmt) Execp(args ...interface{}) sql.Result {
return Execp(&qStmt{*s}, "", args...)
}
// MustExec (panic) using this statement. Note that the query portion of the error
// output will be blank, as Stmt does not expose its query.
func (s *Stmt) MustExec(args ...interface{}) sql.Result {
return MustExec(&qStmt{*s}, "", args...)
}
// QueryRowx using this statement.
func (s *Stmt) QueryRowx(args ...interface{}) *Row {
qs := &qStmt{*s}
return qs.QueryRowx("", args...)
}
// Queryx using this statement.
func (s *Stmt) Queryx(args ...interface{}) (*Rows, error) {
qs := &qStmt{*s}
return qs.Queryx("", args...)
}
// SliceScan using this Rows.
func (r *Rows) SliceScan() ([]interface{}, error) {
return SliceScan(r)
}
// MapScan using this Rows.
func (r *Rows) MapScan(dest map[string]interface{}) error {
return MapScan(r, dest)
}
// Like sql.Rows.Scan, but scans a single Row into a single Struct. Use this
// and iterate over Rows manually when the memory load of Select() might be
// prohibitive. *Rows.StructScan caches the reflect work of matching up
// column positions to fields to avoid that overhead per scan, which means it
// is not safe to run StructScan on the same Rows instance with different
// struct types.
func (r *Rows) StructScan(dest interface{}) error {
var v reflect.Value
v = reflect.ValueOf(dest)
if v.Kind() != reflect.Ptr {
return errors.New("Must pass a pointer, not a value, to StructScan destination.")
}
base := reflect.Indirect(v)
// see if we have a cached fieldmap
if !r.started {
fm, err := getFieldmap(base.Type())
if err != nil {
return err
}
columns, err := r.Columns()
if err != nil {
return err
}
var ok bool
var num int
r.fields = make([]int, len(columns))
r.values = make([]interface{}, len(columns))
for i, name := range columns {
// find that name in the struct
num, ok = fm[name]
if !ok {
return errors.New("Could not find name " + name + " in interface.")
}
r.fields[i] = num
}
r.started = true
}
for i, field := range r.fields {
r.values[i] = base.Field(field).Addr().Interface()
}
r.Scan(r.values...)
return r.Err()
}
// Connect to a database and verify with a ping.
func Connect(driverName, dataSourceName string) (*DB, error) {
db, err := Open(driverName, dataSourceName)
if err != nil {
return db, err
}
err = db.Ping()
return db, err
}
// Connect, but panic on error.
func MustConnect(driverName, dataSourceName string) *DB {
db, err := Connect(driverName, dataSourceName)
if err != nil {
panic(err)
}
return db
}
// Preparex prepares a statement given a Preparer (Tx, DB), returning an *sqlx.Stmt.
func Preparex(p Preparer, query string) (*Stmt, error) {
if s, err := p.Prepare(query); err != nil {
return nil, err
} else {
return &Stmt{s}, err
}
}
// Query using the provided Queryer, and StructScan each row into dest, which must
// be a slice of structs. The resulting *sql.Rows are closed automatically.
func Select(q Queryer, dest interface{}, query string, args ...interface{}) error {
rows, err := q.Query(query, args...)
if err != nil {
return err
}
// if something happens here, we want to make sure the rows are Closed
defer rows.Close()
return StructScan(rows, dest)
}
// Selectv (verbose) will Select using a Queryer and use log.Println to print
//the query and the error in the event of an error.
func Selectv(q Queryer, dest interface{}, query string, args ...interface{}) error {
err := Select(q, dest, query, args...)
if err != nil {
log.Println(query, err)
}
return err
}
// Selectf (fatal) will Select using a Queryer and use log.Fatal to print
// the query and the error in the event of an error.
func Selectf(q Queryer, dest interface{}, query string, args ...interface{}) {
err := Select(q, dest, query, args...)
if err != nil {
log.Fatal(query, err)
}
}
// QueryRow using the provided Queryer, and StructScan the resulting row into dest,
// which must be a pointer to a struct. If there was no row, Get will return sql.ErrNoRows.
func Get(q Queryer, dest interface{}, query string, args ...interface{}) error {
r := q.QueryRowx(query, args...)
return r.StructScan(dest)
}
// LoadFile exec's every statement in a file (as a single call to Exec).
// LoadFile may return a nil *sql.Result if errors are encountered locating or
// reading the file at path. LoadFile reads the entire file into memory, so it
// is not suitable for loading large data dumps, but can be useful for initializing
// schemas or loading indexes.
// FIXME: this does not really work with multi-statement files for mattn/go-sqlite3
// or the go-mysql-driver/mysql drivers; pq seems to be an exception here. Detecting
// this by requiring something with DriverName() and then attempting to split the
// queries will be difficult to get right, and its current driver-specific behavior
// is deemed at least not complex in its incorrectness.
func LoadFile(e Execer, path string) (*sql.Result, error) {
realpath, err := filepath.Abs(path)
if err != nil {
return nil, err
}
contents, err := ioutil.ReadFile(realpath)
if err != nil {
return nil, err
}
res, err := e.Exec(string(contents))
return &res, err
}
// Execv (verbose) Exec's the query using the Execer and uses log.Println to
// print the query, result, and error in the event of an error.
func Execv(e Execer, query string, args ...interface{}) (sql.Result, error) {
res, err := e.Exec(query, args...)
if err != nil {
log.Println(query, res, err)
}
return res, err
}
// Execl (log) runs Exec on the query and args and ses log.Println to
// print the query, result, and error in the event of an error. Unlike Execv,
// Execl does not return the error, and can be used in single-value contexts.
//
// Do not abuse Execl; it is convenient for experimentation but generally not
// for production use.
func Execl(e Execer, query string, args ...interface{}) sql.Result {
res, err := e.Exec(query, args...)
if err != nil {
log.Println(query, res, err)
}
return res
}
// Execf (fatal) runs Exec on the query and args and uses log.Fatal to
// print the query, result, and error in the event of an error.
func Execf(e Execer, query string, args ...interface{}) sql.Result {
res, err := e.Exec(query, args...)
if err != nil {
log.Fatal(query, res, err)
}
return res
}
// Execp (panic) runs Exec on the query and args and panics on error.
func Execp(e Execer, query string, args ...interface{}) sql.Result {
res, err := e.Exec(query, args...)
if err != nil {
panic(err)
}
return res
}
// MustExec (panic) is an alias for Execp.
func MustExec(e Execer, query string, args ...interface{}) sql.Result {
res, err := e.Exec(query, args...)
if err != nil {
panic(err)
}
return res
}
// A map of names to field positions for destination structs
type fieldmap map[string]int
// A cache of fieldmaps for reflect Types
var fieldmapCache = map[reflect.Type]fieldmap{}
// Return the type for a slice, dereferencing it if it is a pointer. Returns
// an error if the destination is not a slice or a pointer to a slice.
func BaseSliceType(t reflect.Type) (reflect.Type, error) {
start:
switch t.Kind() {
case reflect.Ptr:
t = t.Elem()
goto start
case reflect.Slice:
default:
return nil, errors.New("Destination must be a slice.")
}
return t, nil
}
// Return the type of a struct, dereferencing it if it is a pointer. Returns
// an error if the destination is not a struct or a pointer to a struct.
func BaseStructType(t reflect.Type) (reflect.Type, error) {
switch t.Kind() {
case reflect.Ptr:
t = t.Elem()
fallthrough
case reflect.Struct:
default:
return nil, errors.New("Destination must be a struct type.")
}
return t, nil
}
// Create a fieldmap for a given type and return its fieldmap (or error)
// The fieldmap maps names to integers which represent the position of
// a struct field in a breadth first search of the fields.
func getFieldmap(t reflect.Type) (fm fieldmap, err error) {
// if we have a fieldmap cached, return it
t, err = BaseStructType(t)
if err != nil {
return nil, err
}
fm, ok := fieldmapCache[t]
if ok {
return fm, nil
} else {
fm = fieldmap{}
}
var f reflect.StructField
var name string
scannerVal := new(sql.Scanner)
scanner := reflect.TypeOf(scannerVal).Elem()
queue := []reflect.Type{t}
for i := 0; len(queue) != 0; {
ty := queue[0]
queue = queue[1:]
for j := 0; j < ty.NumField(); j++ {
f = ty.Field(j)
// skip unexported field
if len(f.PkgPath) != 0 {
continue
}
// skip structs which implement `scanner`
if f.Type.Kind() == reflect.Struct && !reflect.PtrTo(f.Type).Implements(scanner) {
queue = append(queue, f.Type)
} else {
name = NameMapper(f.Name)
if tag := f.Tag.Get("db"); tag != "" {
name = tag
}
if _, ok := fm[name]; ok {
// this name is already in the map, so skip it
continue
}
if name == "-" {
continue
}
fm[name] = i
i++
}
}
}
fieldmapCache[t] = fm
return fm, nil
}
// Return the numeric fields corresponding to the columns
func getFields(fm fieldmap, columns []string) ([]int, error) {
var num int
var ok bool
fields := make([]int, len(columns))
for i, name := range columns {
// find that name in the struct
num, ok = fm[name]
if !ok {
return fields, errors.New("Could not find name " + name + " in interface")
}
fields[i] = num
}
return fields, nil
}
// Return a slice of values representing the columns
// These values are actually pointers into the addresses of struct fields
// The values interface must be initialized to the length of fields, ie
// make([]interface{}, len(fields)).
func setValues(fields []int, vptr reflect.Value, values []interface{}) {
queue := []reflect.Value{vptr}
fieldMap, _ := getFieldmap(vptr.Type())
flattenedValues := make([]interface{}, len(fieldMap))
// TODO: cache indexes into value and use
// keep track of struct names we've encountered, so we can skip duplicates.
// this mirrors logic in the fieldmap construction process, which is a
// breadth first descent.
encountered := map[string]uint8{}
for i := 0; len(queue) != 0; {
vptr = queue[0]
queue = queue[1:]
for j := 0; j < vptr.NumField(); j++ {
v := vptr.Field(j)
vt := vptr.Type().Field(j)
if _, ok := encountered[vt.Name]; ok {
continue
}
if tag := vt.Tag.Get("db"); tag == "-" {
continue
}
encountered[vt.Name] = 0
_, isScanner := v.Addr().Interface().(sql.Scanner)
if v.Kind() == reflect.Struct && !isScanner {
queue = append(queue, v)
} else {
flattenedValues[i] = v.Addr().Interface()
i++
}
}
}
for i, field := range fields {
values[i] = flattenedValues[field]
}
}
// SliceScan using this Rows.
func (r *Row) SliceScan() ([]interface{}, error) {
return SliceScan(r)
}
// MapScan using this Rows.
func (r *Row) MapScan(dest map[string]interface{}) error {
return MapScan(r, dest)
}
// StructScan's a single Row (result of QueryRowx) into dest
func (r *Row) StructScan(dest interface{}) error {
var v reflect.Value
v = reflect.ValueOf(dest)
if v.Kind() != reflect.Ptr {
return errors.New("Must pass a pointer, not a value, to StructScan destination.")
}
direct := reflect.Indirect(v)
base, err := BaseStructType(direct.Type())
if err != nil {
return err
}
fm, err := getFieldmap(base)
if err != nil {
return err
}
columns, err := r.Columns()
if err != nil {
return err
}
fields, err := getFields(fm, columns)
if err != nil {
return err
}
values := make([]interface{}, len(columns))
// create a new struct type (which returns PtrTo) and indirect it
setValues(fields, reflect.Indirect(v), values)
// scan into the struct field pointers and append to our results
return r.Scan(values...)
}
// Scan a row, returning a []interface{} with values similar to MapScan.
// This function is primarly intended for use where the number of columns
// is not known. Because you can pass an []interface{} directly to Scan,
// it's recommended that you do that as it will not have to allocate new
// slices per row.
func SliceScan(r ColScanner) ([]interface{}, error) {
// ignore r.started, since we needn't use reflect for anything.
columns, err := r.Columns()
if err != nil {
return []interface{}{}, err
}
values := make([]interface{}, len(columns))
for i, _ := range values {
values[i] = &sql.NullString{}
}
r.Scan(values...)
for i, _ := range columns {
ns := *(values[i].(*sql.NullString))
if ns.Valid {
values[i] = ns.String
} else {
values[i] = nil
}
}
return values, r.Err()
}
// Like sql.Rows.Scan, but scans a single Row into a map[string]interface{}.
// Use this to get results for SQL that might not be under your control
// (for instance, if you're building an interface for an SQL server that
// executes SQL from input). Please do not use this as a primary interface!
// This will modify the map sent to it in place, so do not reuse the same one
// on different queries or you may end up with something odd!
//
// The resultant map values will be string representations of the various
// SQL datatypes for existing values and a nil for null values.
func MapScan(r ColScanner, dest map[string]interface{}) error {
// ignore r.started, since we needn't use reflect for anything.
columns, err := r.Columns()
if err != nil {
return err
}
values := make([]interface{}, len(columns))
for i, _ := range values {
values[i] = &sql.NullString{}
}
r.Scan(values...)
for i, column := range columns {
ns := *(values[i].(*sql.NullString))
if ns.Valid {
dest[column] = ns.String
} else {
dest[column] = nil
}
}
return r.Err()
}
// Fully scan a sql.Rows result into the dest slice. StructScan destinations MUST
// have fields that map to every column in the result, and they MAY have fields
// in addition to those. Fields are mapped to column names by lowercasing the
// field names by default: use the struct tag `db` to specify exact column names
// for each field.
//
// StructScan will scan in the entire rows result, so if you need do not want to
// allocate structs for the entire result, use Queryx and see sqlx.Rows.StructScan.
func StructScan(rows *sql.Rows, dest interface{}) error {
var v, vp reflect.Value
var isPtr bool
value := reflect.ValueOf(dest)
if value.Kind() != reflect.Ptr {
return errors.New("Must pass a pointer, not a value, to StructScan destination.")
}
direct := reflect.Indirect(value)
slice, err := BaseSliceType(value.Type())
if err != nil {
return err
}
isPtr = slice.Elem().Kind() == reflect.Ptr
base, err := BaseStructType(slice.Elem())
if err != nil {
return err
}
fm, err := getFieldmap(base)
if err != nil {
return err
}
columns, err := rows.Columns()
if err != nil {
return err
}
fields, err := getFields(fm, columns)
if err != nil {
return err
}
// this will hold interfaces which are pointers to each field in the struct
values := make([]interface{}, len(columns))
for rows.Next() {
// create a new struct type (which returns PtrTo) and indirect it
vp = reflect.New(base)
v = reflect.Indirect(vp)
setValues(fields, v, values)