This repository has been archived by the owner on Jan 4, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
builder.go
1292 lines (1170 loc) · 37.9 KB
/
builder.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 reiner
import (
"database/sql"
"errors"
"fmt"
"runtime"
"strings"
"time"
// MySQL 驅動程式。
_ "github.com/go-sql-driver/mysql"
)
var (
// ErrInvalidPointer 是會在資料的映射目的地為 nil 指標時所發生的錯誤。
ErrInvalidPointer = errors.New("reiner: the destination of the result is an invalid pointer")
// ErrIncorrectDataType 是個會在插入、更新資料時傳入非 `map[string]interface` 資料型態參數時所發生的錯誤。
ErrIncorrectDataType = errors.New("reiner: the data type must be a `map[string]interface`")
// ErrUnbegunTransaction 會在執行尚未透過 `Begin` 初始化的交易時所發生的錯誤。
ErrUnbegunTransaction = errors.New("reiner: calling the transaction function without `Begin()`")
// ErrNoTable 是個會在未指定資料表格時所發生的錯誤。
ErrNoTable = errors.New("reiner: no table was specified")
)
// Function 重現了一個像 `SHA(?)` 或 `NOW()` 的資料庫函式。
type Function struct {
query string
values []interface{}
}
// condition 是一個 `WHERE` 或 `HAVING` 的條件式。
type condition struct {
args []interface{}
connector string
}
// order 是個基於 `ORDER` 的排序資訊。
type order struct {
column string
args []interface{}
}
// join 帶有資料表格的加入資訊。
type join struct {
typ string
table interface{}
condition string
conditions []condition
}
// Trace 是個已執行的 SQL 指令蹤跡、堆疊資料。
type Trace struct {
Query string
Duration time.Duration
Stacks []map[string]interface{}
Error error
}
// Builder 是個資料庫的 SQL 指令建置系統,同時也帶有資料庫的連線資料。
type Builder struct {
db *DB
// executable 表示是否該執行建置後的指令,當沒有連線的時候這會是 `false`。
// 這表示僅用於建置 SQL 指令,而不是執行它。
executable bool
// alias 是作為子指令時所帶有的別名,這會用在子指令資料表格的加入上。
alias string
// destination 呈現了資料的映射目的地指針。
destination interface{}
tableName []string
conditions []condition
havingConditions []condition
queryOptions []string
joins map[string]*join
joinOrder []string
onDuplicateColumns []string
lastInsertIDColumn string
limit []int
orders []order
groupBy []string
lockMethod string
tracing bool
query string
params []interface{}
count int
// Timestamp 是時間戳的相關輔助函式。
Timestamp *Timestamp
// Traces 是最後執行的 SQL 指令蹤跡資訊,適合用於效能除錯上。
Traces []Trace
// TotalCount 是結果的總計筆數。
TotalCount int
// PageLimit 限制了一頁僅能有幾筆資料。
PageLimit int
// TotalPage 是結果的總計頁數。
TotalPage int
// LasyQuery 是最後所執行的 SQL 指令。
LastQuery string
// LastInsertID 是最後所插入的資料 ID 編號。
LastInsertID int
// LastParams 是最後執行時的參數資料。
LastParams []interface{}
// LastResult 是最後執行時的 `sql.Result` 資料。
LastResult sql.Result
}
// newBuilder 會基於傳入的資料庫連線來建立一個新的 SQL 指令建置系統。
func newBuilder(db *DB) *Builder {
return &Builder{executable: true, db: db, Timestamp: &Timestamp{}, PageLimit: 20, joins: make(map[string]*join)}
}
// clone 會複製資料庫建置函式來避免多個 Goroutine 編輯同個資料庫建置函式指標建構體。
func (b *Builder) clone() (cloned *Builder) {
a := *b
newJoins := make(map[string]*join)
for _, v := range a.joinOrder {
newJoins[v] = a.joins[v]
}
a.joins = newJoins
cloned = &a
return
}
// cleanAfter 會在 SQL 指令建置之後清除資料來避免下次使用到舊的資料。
func (b *Builder) cleanAfter() {
b.queryOptions = []string{}
b.tableName = []string{}
b.params = []interface{}{}
b.onDuplicateColumns = []string{}
b.groupBy = []string{}
b.joins = map[string]*join{}
b.joinOrder = []string{}
b.orders = []order{}
b.conditions = []condition{}
b.havingConditions = []condition{}
b.limit = []int{}
b.destination = nil
}
// cleanBefore 會在 SQL 指令建置之前清除以往的資料,
// 留到建置前才清除的原因是避免需要歷史資料的時候卻在執行後直接被清除了。
func (b *Builder) cleanBefore() {
b.TotalCount = 0
b.TotalPage = 0
b.LastInsertID = 0
b.LastResult = nil
b.LastParams = []interface{}{}
b.count = 0
}
//=======================================================
// 保存函式
//=======================================================
// saveTrace 會取得、紀錄呼叫函式的名稱,並且計算執行時間然後將其保存於蹤跡資訊中。
func (b *Builder) saveTrace(err error, query string, startedAt time.Time) {
if !b.tracing {
return
}
var stacks []map[string]interface{}
for skip := 0; ; skip++ {
pc, file, line, ok := runtime.Caller(skip)
if !ok {
break
}
stacks = append(stacks, map[string]interface{}{
"Skip": skip,
"PC": pc,
"File": file,
"Line": line,
})
}
b.Traces = append(b.Traces, Trace{
Query: query,
Duration: time.Since(startedAt),
Stacks: stacks,
Error: err,
})
}
// saveJoin 會保存資料表格的加入資訊。
func (b *Builder) saveJoin(table interface{}, typ string, condition string) {
switch v := table.(type) {
// 子指令加入。
case *SubQuery:
b.joins[v.builder.query] = &join{
typ: typ,
table: table,
condition: condition,
}
b.joinOrder = append(b.joinOrder, v.builder.query)
// 普通的表格加入。
case string:
b.joins[v] = &join{
typ: typ,
table: table,
condition: condition,
}
b.joinOrder = append(b.joinOrder, v)
}
}
// saveJoinCondition 會將資料表格的加入條件式資訊保存到指定的資料表格加入資訊中。
func (b *Builder) saveJoinCondition(connector string, table interface{}, args ...interface{}) {
switch v := table.(type) {
// 子指令條件式。
case *SubQuery:
b.joins[v.builder.query].conditions = append(b.joins[v.builder.query].conditions, condition{
args: args,
connector: connector,
})
// 普通條件式。
case string:
b.joins[v].conditions = append(b.joins[v].conditions, condition{
args: args,
connector: connector,
})
}
}
// saveCondition 會保存欄位的查詢條件。
func (b *Builder) saveCondition(typ, connector string, args ...interface{}) {
var c condition
c.connector = connector
c.args = args
if typ == "HAVING" {
b.havingConditions = append(b.havingConditions, c)
} else {
b.conditions = append(b.conditions, c)
}
}
//=======================================================
// 參數函式
//=======================================================
// bindParams 會將接收到的多個變數綁定到本次的建置工作中,並且產生、回傳相對應的 SQL 指令片段。
func (b *Builder) bindParams(data interface{}) (query string) {
switch d := data.(type) {
case []interface{}:
for _, v := range d {
query += fmt.Sprintf("%s, ", b.bindParam(v))
}
case []int:
for _, v := range d {
query += fmt.Sprintf("%s, ", b.bindParam(v))
}
case []string:
for _, v := range d {
query += fmt.Sprintf("%s, ", b.bindParam(v))
}
}
query = trim(query)
return
}
// bindParam 會將單個傳入的變數綁定到本次的建置工作中,並且依照變數型態來產生並回傳相對應的 SQL 指令片段與決定是否要以括號包覆。
func (b *Builder) bindParam(data interface{}, parentheses ...bool) (param string) {
switch v := data.(type) {
case *SubQuery:
if len(v.builder.Params()) > 0 {
b.params = append(b.params, v.builder.Params()...)
}
case Function:
if len(v.values) > 0 {
b.params = append(b.params, v.values...)
}
case nil:
case Timestamp:
b.params = append(b.params, v.value)
default:
b.params = append(b.params, data)
}
param = b.paramToQuery(data, parentheses...)
return
}
// paramToQuery 會將參數的變數資料型態轉換成 SQL 指令片段,並決定是否要加上括號。
func (b *Builder) paramToQuery(data interface{}, parentheses ...bool) (param string) {
switch v := data.(type) {
case *SubQuery:
if len(parentheses) > 0 {
if parentheses[0] == false {
param = fmt.Sprintf("%s", v.builder.query)
}
} else {
param = fmt.Sprintf("(%s)", v.builder.query)
}
case Function:
param = v.query
case nil:
param = "NULL"
default:
param = "?"
}
return
}
//=======================================================
// 建置函式
//=======================================================
// buildWhere 會基於目前所擁有的條件式來建置一串 `WHERE` 和 `HAVING` 的 SQL 指令。
func (b *Builder) buildWhere(typ string) (query string) {
var conditions []condition
if typ == "HAVING" {
conditions = b.havingConditions
query = "HAVING "
} else {
conditions = b.conditions
query = "WHERE "
}
if len(conditions) == 0 {
query = ""
return
}
query += b.buildConditions(conditions)
return
}
// buildUpdate 會建置 `UPDATE` 的 SQL 指令。
func (b *Builder) buildUpdate(data interface{}) (query string, err error) {
if len(b.tableName) == 0 {
err = ErrNoTable
return
}
var set string
beforeOptions, _ := b.buildQueryOptions()
query = fmt.Sprintf("UPDATE %s%s SET ", beforeOptions, b.tableName[0])
switch realData := data.(type) {
case map[string]interface{}:
for column, value := range realData {
set += fmt.Sprintf("%s = %s, ", column, b.bindParam(value))
}
}
query += fmt.Sprintf("%s ", trim(set))
return
}
// buildLimit 會建置 `LIMIT` 的 SQL 指令。
func (b *Builder) buildLimit() (query string) {
switch len(b.limit) {
case 0:
return
case 1:
query = fmt.Sprintf("LIMIT %d ", b.limit[0])
case 2:
query = fmt.Sprintf("LIMIT %d, %d ", b.limit[0], b.limit[1])
}
return
}
// buildSelect 會建置 `SELECT` 的 SQL 指令。
func (b *Builder) buildSelect(columns ...string) (query string, err error) {
if len(b.tableName) == 0 {
err = ErrNoTable
return
}
beforeOptions, _ := b.buildQueryOptions()
if len(columns) == 0 {
query = fmt.Sprintf("SELECT %s* FROM %s ", beforeOptions, b.tableName[0])
} else {
query = fmt.Sprintf("SELECT %s%s FROM %s ", beforeOptions, strings.Join(columns, ", "), b.tableName[0])
}
return
}
// buildConditions 會將傳入的條件式轉換成指定的 `WHERE` 或 `HAVING` SQL 指令。
func (b *Builder) buildConditions(conditions []condition) (query string) {
for i, v := range conditions {
// 如果不是第一個條件式的話,那麼就增加連結語句。
if i != 0 {
query += fmt.Sprintf("%s ", v.connector)
}
// 取得欄位名稱的種類,有可能是個 SQL 指令或普通的欄位名稱、甚至是子指令。
var typ string
switch q := v.args[0].(type) {
case string:
if strings.Contains(q, "?") || strings.Contains(q, "(") || len(v.args) == 1 {
typ = "Query"
} else {
typ = "Column"
}
case *SubQuery:
typ = "SubQuery"
}
// 基於種類來建置相對應的條件式。
switch len(v.args) {
// .Where("Column = Column")
case 1:
query += fmt.Sprintf("%s ", v.args[0].(string))
// .Where("Column = ?", "Value")
// .Where("Column", "Value")
// .Where(subQuery, "EXISTS")
case 2:
switch typ {
case "Query":
query += fmt.Sprintf("%s ", v.args[0].(string))
b.bindParam(v.args[1])
case "Column":
switch d := v.args[1].(type) {
case Timestamp:
query += fmt.Sprintf(d.query, v.args[0].(string), b.bindParam(d))
default:
query += fmt.Sprintf("%s = %s ", v.args[0].(string), b.bindParam(d))
}
case "SubQuery":
query += fmt.Sprintf("%s %s ", v.args[1].(string), b.bindParam(v.args[0]))
}
// .Where("Column", ">", "Value")
// .Where("Column", "IN", subQuery)
// .Where("Column", "IS", nil)
case 3:
if typ == "Query" {
query += fmt.Sprintf("%s ", v.args[0].(string))
b.bindParams(v.args[1:])
} else {
if v.args[1].(string) == "IN" || v.args[1].(string) == "NOT IN" {
query += fmt.Sprintf("%s %s (%s) ", v.args[0].(string), v.args[1].(string), b.bindParam(v.args[2], false))
} else {
query += fmt.Sprintf("%s %s %s ", v.args[0].(string), v.args[1].(string), b.bindParam(v.args[2]))
}
}
// .Where("(Column = ? OR Column = SHA(?))", "Value", "Value")
// .Where("Column", "BETWEEN", 1, 20)
default:
if typ == "Query" {
query += fmt.Sprintf("%s ", v.args[0].(string))
b.bindParams(v.args[1:])
} else {
switch v.args[1].(string) {
case "BETWEEN", "NOT BETWEEN":
query += fmt.Sprintf("%s %s %s AND %s ", v.args[0].(string), v.args[1].(string), b.bindParam(v.args[2]), b.bindParam(v.args[3]))
case "IN", "NOT IN":
query += fmt.Sprintf("%s %s (%s) ", v.args[0].(string), v.args[1].(string), b.bindParams(v.args[2:]))
}
}
}
}
return
}
// buildDelete 會建置 `DELETE` 的 SQL 指令。
func (b *Builder) buildDelete(tableNames ...string) (query string, err error) {
if len(b.tableName) == 0 {
err = ErrNoTable
return
}
beforeOptions, _ := b.buildQueryOptions()
query += fmt.Sprintf("DELETE %sFROM %s ", beforeOptions, strings.Join(tableNames, ", "))
return
}
// buildQueryOptions 依照以保存的語句選項來建置執行選項的 SQL 指令片段。
// 這會回傳兩個 SQL 指令片段,分別是放在整體 SQL 指令的前面與後面。
func (b *Builder) buildQueryOptions() (before string, after string) {
for _, v := range b.queryOptions {
switch v {
case "ALL", "DISTINCT", "SQL_CACHE", "SQL_NO_CACHE", "DISTINCTROW", "HIGH_PRIORITY", "STRAIGHT_JOIN", "SQL_SMALL_RESULT", "SQL_BIG_RESULT", "SQL_BUFFER_RESULT", "SQL_CALC_FOUND_ROWS", "LOW_PRIORITY", "QUICK", "IGNORE", "DELAYED":
before += fmt.Sprintf("%s, ", v)
case "FOR UPDATE", "LOCK IN SHARE MODE":
after += fmt.Sprintf("%s, ", v)
}
}
if before != "" {
before = fmt.Sprintf("%s ", trim(before))
}
if after != "" {
after = fmt.Sprintf("%s ", trim(after))
}
return
}
// buildQuery 會將所有建置工作串連起來並且依序執行來建置整個可用的 SQL 指令。
func (b *Builder) buildQuery() {
b.query += b.buildDuplicate()
b.query += b.buildJoin()
b.query += b.buildWhere("WHERE")
b.query += b.buildWhere("HAVING")
b.query += b.buildOrderBy()
b.query += b.buildGroupBy()
b.query += b.buildLimit()
_, afterOptions := b.buildQueryOptions()
b.query += afterOptions
b.query = strings.TrimSpace(b.query)
}
// buildOrderBy 會基於現有的排序資料來建置 `ORDERY BY` 的 SQL 指令。
func (b *Builder) buildOrderBy() (query string) {
if len(b.orders) == 0 {
return
}
query += "ORDER BY "
for _, v := range b.orders {
switch len(v.args) {
// .OrderBy("RAND()")
case 0:
query += fmt.Sprintf("%s, ", v.column)
// .OrderBy("ID", "ASC")
case 1:
query += fmt.Sprintf("%s %s, ", v.column, v.args[0])
// .OrderBy("UserGroup", "ASC", "SuperUser", "Admin")
default:
query += fmt.Sprintf("FIELD (%s, %s) %s, ", v.column, b.bindParams(v.args[1:]), v.args[0])
}
}
query = trim(query) + " "
return
}
// buildGroupBy 會建置 `GROUP BY` 的 SQL 指令。
func (b *Builder) buildGroupBy() (query string) {
if len(b.groupBy) == 0 {
return
}
query += "GROUP BY "
for _, v := range b.groupBy {
query += fmt.Sprintf("%s, ", v)
}
query = trim(query) + " "
return
}
// buildDuplicate 會建置 `ON DUPLICATE KEY UPDATE` 的 SQL 指令。
func (b *Builder) buildDuplicate() (query string) {
if len(b.onDuplicateColumns) == 0 {
return
}
query += "ON DUPLICATE KEY UPDATE "
if b.lastInsertIDColumn != "" {
query += fmt.Sprintf("%s=LAST_INSERT_ID(%s), ", b.lastInsertIDColumn, b.lastInsertIDColumn)
}
for _, v := range b.onDuplicateColumns {
query += fmt.Sprintf("%s = VALUES(%s), ", v, v)
}
query = trim(query)
return
}
// buildInsert 會建置 `INSERT INTO` 的 SQL 指令。
func (b *Builder) buildInsert(operator string, data interface{}) (query string, err error) {
if len(b.tableName) == 0 {
err = ErrNoTable
return
}
var columns, values string
beforeOptions, _ := b.buildQueryOptions()
// 會基於資料型態建置不同的指令。
switch realData := data.(type) {
case map[string]interface{}:
for column, value := range realData {
columns += fmt.Sprintf("%s, ", column)
values += fmt.Sprintf("%s, ", b.bindParam(value))
}
values = fmt.Sprintf("(%s)", trim(values))
case []map[string]interface{}:
var columnNames []string
// 先取得欄位的名稱,這樣才能照順序遍歷整個 `map`。
for name := range realData[0] {
columnNames = append(columnNames, name)
// 先建置欄位名稱的 SQL 指令片段。
columns += fmt.Sprintf("%s, ", name)
}
for _, single := range realData {
var currentValues string
for _, name := range columnNames {
currentValues += fmt.Sprintf("%s, ", b.bindParam(single[name]))
}
values += fmt.Sprintf("(%s), ", trim(currentValues))
}
values = trim(values)
}
columns = trim(columns)
query = fmt.Sprintf("%s %sINTO %s (%s) VALUES %s ", operator, beforeOptions, b.tableName[0], columns, values)
return
}
// buildJoin 會建置資料表的插入 SQL 指令。
func (b *Builder) buildJoin() (query string) {
if len(b.joinOrder) == 0 {
return
}
for _, k := range b.joinOrder {
v := b.joins[k]
// 插入的種類(例如:`LEFT JOIN`、`RIGHT JOIN`、`INNER JOIN`)。
query += fmt.Sprintf("%s ", v.typ)
switch d := v.table.(type) {
// 子指令。
case *SubQuery:
query += fmt.Sprintf("%s AS %s ON ", b.bindParam(d), d.builder.alias)
// 資料表格名稱。
case string:
query += fmt.Sprintf("%s ON ", d)
}
if len(v.conditions) == 0 {
query += fmt.Sprintf("(%s) ", v.condition)
} else {
conditionsQuery := strings.TrimSpace(b.buildConditions(v.conditions))
query += fmt.Sprintf("(%s %s %s) ", v.condition, v.conditions[0].connector, conditionsQuery)
}
}
return
}
//=======================================================
// 執行函式
//=======================================================
// runQuery 會以 `Query` 的方式執行建置出來的 SQL 指令。
func (b *Builder) runQuery() (rows *sql.Rows, err error) {
b.cleanBefore()
b.buildQuery()
b.LastQuery = b.query
b.LastParams = b.params
// 如果有啟用追蹤模式的話,開始計算執行時間。
var start time.Time
if b.tracing {
start = time.Now()
}
// 如果這個建置建構體是可執行的話,就執行 SQL 指令。
if b.executable {
var stmt *sql.Stmt
var count int
var tx *sql.Tx
// 如果指令選項中有 `SQL_CALC_FOUND_ROWS` 的話就開始一段交易,
// 因為這個指令僅能用於同個連線中。
for _, v := range b.queryOptions {
if v == "SQL_CALC_FOUND_ROWS" {
// 開始一個交易。
tx, err = b.db.begin()
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
// 準備執行指令。
stmt, err = tx.Prepare(b.query)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
// 傳入參數並且執行指令。
rows, err = stmt.Query(b.params...)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
// 將取得到的結果映射置目的地指標。
// 這同時會關閉 `rows` 所以就不會觸發 `busy buffer` 錯誤。
count, err = load(rows, b.destination)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
// 保存結果行數。
b.count = count
// 選擇 `FOUND_ROWS` 來取得總計的行數。
rows, err = tx.Query("SELECT FOUND_ROWS()")
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
// 掃描資料來取得總計的行數。
for rows.Next() {
var totalCount int
rows.Scan(&totalCount)
if rows.Err() != nil {
err = rows.Err()
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
b.TotalCount = totalCount
}
// 關閉、結束整個指令環境。
err = stmt.Close()
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
}
// 如果沒有設置 `SQL_CALC_FOUND_ROWS` 的話就使用正常的連線池。
stmt, err = b.db.prepare(b.query)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
rows, err = stmt.Query(b.params...)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
err = stmt.Close()
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
count, err = load(rows, b.destination)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
b.count = count
}
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
// executeQuery 會透過 `Exec` 的方式執行建置出來的 SQL 指令。
func (b *Builder) executeQuery() (res sql.Result, err error) {
b.cleanBefore()
b.buildQuery()
b.LastQuery = b.query
b.LastParams = b.params
// 如果有啟用追蹤模式的話,開始計算執行時間。
var start time.Time
if b.tracing {
start = time.Now()
}
// 如果這個建置建構體是可執行的話,就執行 SQL 指令。
if b.executable {
var stmt *sql.Stmt
var count int64
stmt, err = b.db.prepare(b.query)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
res, err = stmt.Exec(b.params...)
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
b.LastResult = res
count, err = res.RowsAffected()
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
b.count = int(count)
err = stmt.Close()
if err != nil {
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
}
b.saveTrace(err, b.query, start)
b.cleanAfter()
return
}
//=======================================================
// 輸出函式
//=======================================================
// Table 能夠指定資料表格的名稱。
func (b *Builder) Table(tableName ...string) (builder *Builder) {
builder = b.clone()
builder.tableName = tableName
return
}
//=======================================================
// 選擇函式
//=======================================================
// Get 會取得多列的資料結果,傳入的參數為欲取得的欄位名稱,不傳入參數表示取得所有欄位。
func (b *Builder) Get(columns ...string) (builder *Builder, err error) {
builder = b.clone()
builder.query, err = builder.buildSelect(columns...)
if err != nil {
return
}
_, err = builder.runQuery()
if err != nil {
return
}
return
}
// GetValue 會取得單個欄位的資料(例如:字串、正整數)。
func (b *Builder) GetValue(column string) (builder *Builder, err error) {
builder, err = b.GetOne(column)
return
}
// GetValues 會取得將多筆單個欄位的資料映射到本地的字串、正整數切片、陣列。
func (b *Builder) GetValues(column string) (builder *Builder, err error) {
builder, err = b.Get(column)
return
}
// GetOne 會取得僅單列的資料作為結果,傳入的參數為欲取得的欄位名稱,不傳入參數表示取得所有欄位。
// 簡單說,這就是 `.Limit(1).Get()` 的縮寫用法。
func (b *Builder) GetOne(columns ...string) (builder *Builder, err error) {
builder, err = b.clone().Limit(1).Get(columns...)
return
}
// Paginate 基本上和 `Get` 取得函式無異,但此函式能夠自動依照分頁數來推算該從哪裡繼續取得資料。
// 使用時須先確定是否有指定 `PageLimit`(預設為:20),這樣才能限制一頁有多少筆資料。
func (b *Builder) Paginate(pageCount int, columns ...string) (builder *Builder, err error) {
builder, err = b.WithTotalCount().Limit(b.PageLimit*(pageCount-1), b.PageLimit).Get(columns...)
builder.TotalPage = 0
if builder.TotalCount != 0 {
builder.TotalPage = builder.TotalCount / builder.PageLimit
}
return
}
// WithTotalCount 會在 SQL 執行指令中安插 `SQL_CALC_FOUND_ROWS` 選項,
// 如此一來就能夠在執行完 SQL 指令後取得查詢的總計行數。在不同情況下,這可能會拖低執行效能。
func (b *Builder) WithTotalCount() (builder *Builder) {
builder = b.clone().SetQueryOption("SQL_CALC_FOUND_ROWS")
return
}
//=======================================================
// 插入函式
//=======================================================
// Insert 會插入一筆新的資料。
func (b *Builder) Insert(data interface{}) (builder *Builder, err error) {
builder = b.clone()
builder.query, err = builder.buildInsert("INSERT", data)
if err != nil {
return
}
res, err := builder.executeQuery()
if err != nil || !builder.executable {
return
}
id, err := res.LastInsertId()
if err != nil {
return
}
builder.LastInsertID = int(id)
return
}
// InsertMulti 會一次插入多筆資料。
func (b *Builder) InsertMulti(data interface{}) (builder *Builder, err error) {
builder = b.clone()
builder.query, err = builder.buildInsert("INSERT", data)
if err != nil {
return
}
res, err := builder.executeQuery()
if err != nil || !builder.executable {
return
}
id, err := res.LastInsertId()
if err != nil {
return
}
builder.LastInsertID = int(id)
return
}
// Delete 會移除相符的資料列,記得用上 `Where` 條件式來避免整個資料表格被清空。
// 這很重要好嗎,因為⋯你懂的⋯。喔,不。
func (b *Builder) Delete() (builder *Builder, err error) {
builder = b.clone()
builder.query, err = builder.buildDelete(b.tableName...)
if err != nil {
return
}
_, err = builder.executeQuery()
return
}
//=======================================================
// 更新函式
//=======================================================
// Replace 基本上和 `Insert` 無異,這會在有重複資料時移除該筆資料並重新插入。
// 若無該筆資料則插入新的資料。
func (b *Builder) Replace(data interface{}) (builder *Builder, err error) {
builder = b.clone()
builder.query, err = builder.buildInsert("REPLACE", data)
if err != nil {
return
}
_, err = builder.executeQuery()
return
}
// Update 會以指定的資料來更新相對應的資料列。
func (b *Builder) Update(data interface{}) (builder *Builder, err error) {
builder = b.clone()
builder.query, err = builder.buildUpdate(data)
_, err = builder.executeQuery()
return
}
// OnDuplicate 能夠指定欲更新的欄位名稱,這會在插入的資料重複時自動更新相對應的欄位。
func (b *Builder) OnDuplicate(columns []string, lastInsertID ...string) (builder *Builder) {
builder = b.clone()
builder.onDuplicateColumns = columns
if len(lastInsertID) != 0 {
builder.lastInsertIDColumn = lastInsertID[0]
}
return
}
//=======================================================
// 限制函式
//=======================================================
// Limit 能夠在 SQL 查詢指令中建立限制筆數的條件。
func (b *Builder) Limit(from int, count ...int) (builder *Builder) {
builder = b.clone()
if len(count) == 0 {
builder.limit = []int{from}
} else {
builder.limit = []int{from, count[0]}
}
return
}
// OrderBy 會依照指定的欄位來替結果做出排序(例如:`DESC`、`ASC`)。
func (b *Builder) OrderBy(column string, args ...interface{}) (builder *Builder) {
builder = b.clone()
builder.orders = append(builder.orders, order{
column: column,
args: args,
})
return
}
// GroupBy 會在執行 SQL 指令時依照特定的欄位來做執行區分。
func (b *Builder) GroupBy(columns ...string) (builder *Builder) {
builder = b.clone()
builder.groupBy = columns
return
}
//=======================================================
// 指令函式
//=======================================================
// RawQuery 會接收傳入的變數來執行傳入的 SQL 執行語句,變數可以在語句中以 `?`(Prepared Statements)使用來避免 SQL 注入攻擊。
// 這會將多筆資料映射到本地的建構體切片、陣列上。
func (b *Builder) RawQuery(query string, values ...interface{}) (builder *Builder, err error) {
builder = b.clone()
builder.query = query
builder.params = values
_, err = builder.runQuery()
return
}
// RawQueryValue 與 RawQuery 使用方法相同,但這會在 SQL 指令後追加 `LIMIT 1` 並將單個欄位的資料映射到本地的變數(字串、正整數),
// 這很適合用於像是你想要取得單個使用者暱稱的時候。
func (b *Builder) RawQueryValue(query string, values ...interface{}) (builder *Builder, err error) {
builder, err = b.RawQuery(fmt.Sprintf("%s LIMIT 1", strings.TrimSpace(query)), values...)
return
}
// RawQueryValues 與 RawQuery 使用方法相同,但這會將多筆單個欄位的資料映射到本地的字串、正整數切片、陣列。
// 這很適合用於像是你想要取得多個使用者暱稱陣列的時候。
func (b *Builder) RawQueryValues(query string, values ...interface{}) (builder *Builder, err error) {
builder, err = b.RawQuery(query, values...)
return
}
// RawQueryOne 與 RawQuery 使用方法相同,但這會在 SQL 指令後追加 `LIMIT 1` 且僅會將單筆資料映射到本地的建構體、`map`。