-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
sqlite.go
1469 lines (1352 loc) · 41.5 KB
/
sqlite.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
// Copyright (c) 2018 David Crawshaw <[email protected]>
// Copyright (c) 2021 Roxy Light <[email protected]>
//
// Permission to use, copy, modify, and distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
//
// SPDX-License-Identifier: ISC
package sqlite
import (
"bytes"
"fmt"
"sync"
"time"
"unsafe"
"modernc.org/libc"
"modernc.org/libc/sys/types"
lib "modernc.org/sqlite/lib"
)
// Version is the SQLite version in the format "X.Y.Z" where X is the major
// version number (always 3), Y is the minor version number, and Z is the
// release number.
const Version = lib.SQLITE_VERSION
// VersionNumber is an integer with the value (X*1000000 + Y*1000 + Z) where X
// is the major version number (always 3), Y is the minor version number, and Z
// is the release number.
const VersionNumber = lib.SQLITE_VERSION_NUMBER
var initOnce sync.Once
func initlib(tls *libc.TLS) {
initOnce.Do(func() {
lib.Xsqlite3_initialize(tls)
})
}
// Conn is an open connection to an SQLite3 database.
//
// A Conn can only be used by one goroutine at a time.
type Conn struct {
tls *libc.TLS
conn uintptr
stmts map[string]*Stmt // query -> prepared statement
closed bool
cancelCh chan struct{}
doneCh <-chan struct{}
unlockNote uintptr
file string
line int
}
const ptrSize = types.Size_t(unsafe.Sizeof(uintptr(0)))
// OpenConn opens a single SQLite database connection with the given flags.
// No flags or a value of 0 defaults to the following:
//
// - [OpenReadWrite]
// - [OpenCreate]
// - [OpenWAL]
// - [OpenURI]
//
// The OpenWAL flag is an extension specific to this library:
// it runs "PRAGMA journal_mode=wal;" before returning.
// While convenient, this constitutes a write transaction
// and may fail if the database is contended.
// A default timeout of a few seconds is used
// so that OpenConn does not block indefinitely.
// If you want to have more control over the timeout on setting WAL,
// do not pass OpenWAL and execute "PRAGMA journal_mode=wal;" yourself.
//
// https://www.sqlite.org/c3ref/open.html
func OpenConn(path string, flags ...OpenFlags) (*Conn, error) {
var openFlags OpenFlags
for _, f := range flags {
openFlags |= f
}
if openFlags == 0 {
openFlags = OpenReadWrite | OpenCreate | OpenWAL | OpenURI
}
c, err := openConn(path, openFlags&^(OpenWAL|OpenFullMutex)|OpenNoMutex)
if err != nil {
return nil, err
}
// Disable double-quoted string literals.
varArgs := libc.NewVaList(int32(0), uintptr(0))
if varArgs == 0 {
c.Close()
return nil, fmt.Errorf("sqlite: open %q: cannot allocate memory", path)
}
defer libc.Xfree(c.tls, varArgs)
res := ResultCode(lib.Xsqlite3_db_config(
c.tls,
c.conn,
lib.SQLITE_DBCONFIG_DQS_DDL,
varArgs,
))
if err := res.ToError(); err != nil {
// Making error opaque because it's not part of the primary connection
// opening and reflects an internal error.
c.Close()
return nil, fmt.Errorf("sqlite: open %q: disable double-quoted string literals: %v", path, err)
}
res = ResultCode(lib.Xsqlite3_db_config(
c.tls,
c.conn,
lib.SQLITE_DBCONFIG_DQS_DML,
varArgs,
))
if err := res.ToError(); err != nil {
// Making error opaque because it's not part of the primary connection
// opening and reflects an internal error.
c.Close()
return nil, fmt.Errorf("sqlite: open %q: disable double-quoted string literals: %v", path, err)
}
if openFlags&OpenWAL != 0 {
// Set timeout for enabling WAL.
// See https://github.com/crawshaw/sqlite/pull/113 for details.
c.SetBusyTimeout(10 * time.Second)
stmt, _, err := c.PrepareTransient("PRAGMA journal_mode=wal;")
if err != nil {
c.Close()
return nil, fmt.Errorf("sqlite: open %q: %w", path, err)
}
_, err = stmt.Step()
stmt.Finalize()
if err != nil {
c.Close()
return nil, fmt.Errorf("sqlite: open %q: enable wal: %w", path, err)
}
}
c.SetBlockOnBusy()
return c, nil
}
var allConns struct {
mu sync.RWMutex
table map[uintptr]*Conn
}
func openConn(path string, openFlags OpenFlags) (_ *Conn, err error) {
tls := libc.NewTLS()
defer func() {
if err != nil {
tls.Close()
}
}()
initlib(tls)
unlockNote, err := allocUnlockNote(tls)
if err != nil {
return nil, fmt.Errorf("sqlite: open %q: %w", path, err)
}
defer func() {
if err != nil {
libc.Xfree(tls, unlockNote)
}
}()
cpath, err := libc.CString(path)
if err != nil {
return nil, fmt.Errorf("sqlite: open %q: %w", path, err)
}
defer libc.Xfree(tls, cpath)
connPtr, err := malloc(tls, ptrSize)
if err != nil {
return nil, fmt.Errorf("sqlite: open %q: %w", path, err)
}
defer libc.Xfree(tls, connPtr)
res := ResultCode(lib.Xsqlite3_open_v2(tls, cpath, connPtr, int32(openFlags), 0))
c := &Conn{
tls: tls,
conn: *(*uintptr)(unsafe.Pointer(connPtr)),
stmts: make(map[string]*Stmt),
unlockNote: unlockNote,
}
if c.conn == 0 {
// Not enough memory to allocate the sqlite3 object.
return nil, fmt.Errorf("sqlite: open %q: %w", path, res.ToError())
}
if res != ResultOK {
// sqlite3_open_v2 may still return a sqlite3* just so we can extract the error.
extres := ResultCode(lib.Xsqlite3_extended_errcode(tls, c.conn))
if extres != 0 {
res = extres
}
lib.Xsqlite3_close_v2(tls, c.conn)
return nil, fmt.Errorf("sqlite: open %q: %w", path, res.ToError())
}
lib.Xsqlite3_extended_result_codes(tls, c.conn, 1)
allConns.mu.Lock()
if allConns.table == nil {
allConns.table = make(map[uintptr]*Conn)
}
allConns.table[c.conn] = c
allConns.mu.Unlock()
return c, nil
}
// Close closes the database connection using sqlite3_close and finalizes
// persistent prepared statements. https://www.sqlite.org/c3ref/close.html
func (c *Conn) Close() error {
if c == nil {
return fmt.Errorf("sqlite: close: nil connection")
}
if c.closed {
return fmt.Errorf("sqlite: close: already closed")
}
c.cancelInterrupt()
c.closed = true
for _, stmt := range c.stmts {
stmt.Finalize()
}
res := ResultCode(lib.Xsqlite3_close(c.tls, c.conn))
libc.Xfree(c.tls, c.unlockNote)
c.unlockNote = 0
c.tls.Close()
c.tls = nil
c.releaseAuthorizer()
busyHandlers.Delete(c.conn)
allConns.mu.Lock()
delete(allConns.table, c.conn)
allConns.mu.Unlock()
if !res.IsSuccess() {
return fmt.Errorf("sqlite: close: %w", res.ToError())
}
return nil
}
// AutocommitEnabled reports whether conn is in autocommit mode.
// https://sqlite.org/c3ref/get_autocommit.html
func (c *Conn) AutocommitEnabled() bool {
if c == nil {
return false
}
return lib.Xsqlite3_get_autocommit(c.tls, c.conn) != 0
}
// CheckReset reports whether any statement on this connection is in the process
// of returning results.
func (c *Conn) CheckReset() string {
if c != nil {
for _, stmt := range c.stmts {
if stmt.lastHasRow {
return stmt.query
}
}
}
return ""
}
// SetInterrupt assigns a channel to control connection execution lifetime.
//
// When doneCh is closed, the connection uses sqlite3_interrupt to
// stop long-running queries and cancels any *Stmt.Step calls that
// are blocked waiting for the database write lock.
//
// Subsequent uses of the connection will return SQLITE_INTERRUPT
// errors until doneCh is reset with a subsequent call to SetInterrupt.
//
// Any busy statements at the time SetInterrupt is called will be reset.
//
// SetInterrupt returns the old doneCh assigned to the connection.
func (c *Conn) SetInterrupt(doneCh <-chan struct{}) (oldDoneCh <-chan struct{}) {
if c == nil {
return nil
}
if c.closed {
panic("sqlite.Conn is closed")
}
oldDoneCh = c.doneCh
c.cancelInterrupt()
c.doneCh = doneCh
for _, stmt := range c.stmts {
if stmt.lastHasRow {
stmt.Reset()
}
}
if doneCh == nil {
return oldDoneCh
}
cancelCh := make(chan struct{})
c.cancelCh = cancelCh
go func() {
select {
case <-doneCh:
lib.Xsqlite3_interrupt(c.tls, c.conn)
fireUnlockNote(c.tls, c.unlockNote)
<-cancelCh
cancelCh <- struct{}{}
case <-cancelCh:
cancelCh <- struct{}{}
}
}()
return oldDoneCh
}
// SetBusyTimeout sets a busy handler that sleeps for up to d to acquire a lock.
// Passing a non-positive value will turn off all busy handlers.
//
// By default, connections are opened with SetBlockOnBusy,
// with the assumption that programs use SetInterrupt to control timeouts.
//
// https://www.sqlite.org/c3ref/busy_timeout.html
func (c *Conn) SetBusyTimeout(d time.Duration) {
if c != nil {
lib.Xsqlite3_busy_timeout(c.tls, c.conn, int32(d/time.Millisecond))
busyHandlers.Delete(c.conn)
}
}
// SetBlockOnBusy sets a busy handler that waits to acquire a lock
// until the connection is interrupted (see SetInterrupt).
//
// By default, connections are opened with SetBlockOnBusy,
// with the assumption that programs use SetInterrupt to control timeouts.
//
// https://www.sqlite.org/c3ref/busy_handler.html
func (c *Conn) SetBlockOnBusy() {
if c == nil {
return
}
c.setBusyHandler(func(count int) bool {
if count >= len(busyDelays) {
count = len(busyDelays) - 1
}
t := time.NewTimer(busyDelays[count])
defer t.Stop()
select {
case <-t.C:
return true
case <-c.doneCh:
// ^ Assuming that doneCh won't be set by SetInterrupt concurrently
// with other operations.
return false
}
})
}
var busyDelays = [...]time.Duration{
1 * time.Millisecond,
2 * time.Millisecond,
5 * time.Millisecond,
10 * time.Millisecond,
15 * time.Millisecond,
20 * time.Millisecond,
25 * time.Millisecond,
25 * time.Millisecond,
25 * time.Millisecond,
50 * time.Millisecond,
50 * time.Millisecond,
100 * time.Millisecond,
}
var busyHandlers sync.Map // sqlite3* -> func(int) bool
func (c *Conn) setBusyHandler(handler func(count int) bool) {
if c == nil {
return
}
if handler == nil {
lib.Xsqlite3_busy_handler(c.tls, c.conn, 0, 0)
busyHandlers.Delete(c.conn)
return
}
busyHandlers.Store(c.conn, handler)
xBusy := cFuncPointer(busyHandlerCallback)
lib.Xsqlite3_busy_handler(c.tls, c.conn, xBusy, c.conn)
}
func busyHandlerCallback(tls *libc.TLS, pArg uintptr, count int32) int32 {
val, _ := busyHandlers.Load(pArg)
if val == nil {
return 0
}
f := val.(func(int) bool)
if !f(int(count)) {
return 0
}
return 1
}
func (c *Conn) interrupted() error {
select {
case <-c.doneCh:
return ResultInterrupt.ToError()
default:
return nil
}
}
func (c *Conn) cancelInterrupt() {
if c.cancelCh != nil {
c.cancelCh <- struct{}{}
<-c.cancelCh
c.cancelCh = nil
}
}
// Prep returns a persistent SQL statement.
//
// Any error in preparation will panic.
//
// Persistent prepared statements are cached by the query
// string in a Conn. If Finalize is not called, then subsequent
// calls to Prepare will return the same statement.
//
// https://www.sqlite.org/c3ref/prepare.html
func (c *Conn) Prep(query string) *Stmt {
stmt, err := c.Prepare(query)
if err != nil {
if ErrCode(err) == ResultInterrupt {
return &Stmt{
conn: c,
query: query,
colNames: make(map[string]int),
prepInterrupt: true,
}
}
panic(err)
}
return stmt
}
// Prepare prepares a persistent SQL statement.
//
// Persistent prepared statements are cached by the query
// string in a Conn. If Finalize is not called, then subsequent
// calls to Prepare will return the same statement.
//
// If the query has any unprocessed trailing bytes, Prepare
// returns an error.
//
// https://www.sqlite.org/c3ref/prepare.html
func (c *Conn) Prepare(query string) (*Stmt, error) {
if c == nil {
return nil, fmt.Errorf("sqlite: prepare %q: nil connection", query)
}
if stmt := c.stmts[query]; stmt != nil {
if err := stmt.Reset(); err != nil {
return nil, err
}
if err := stmt.ClearBindings(); err != nil {
return nil, err
}
return stmt, nil
}
stmt, trailingBytes, err := c.prepare(query, lib.SQLITE_PREPARE_PERSISTENT)
if err != nil {
return nil, fmt.Errorf("sqlite: prepare %q: %w", query, err)
}
if trailingBytes != 0 {
stmt.Finalize()
return nil, fmt.Errorf("sqlite: prepare %q: statement has trailing bytes", query)
}
c.stmts[query] = stmt
return stmt, nil
}
// PrepareTransient prepares an SQL statement that is not cached by
// the Conn. Subsequent calls with the same query will create new Stmts.
// Finalize must be called by the caller once done with the Stmt.
//
// The number of trailing bytes not consumed from query is returned.
//
// To run a sequence of queries once as part of a script,
// the sqlitex package provides an ExecScript function built on this.
//
// https://www.sqlite.org/c3ref/prepare.html
func (c *Conn) PrepareTransient(query string) (stmt *Stmt, trailingBytes int, err error) {
if c == nil {
return nil, 0, fmt.Errorf("sqlite: prepare: nil connection")
}
// TODO(soon)
// if stmt != nil {
// runtime.SetFinalizer(stmt, func(stmt *Stmt) {
// if stmt.conn != nil {
// panic("open *sqlite.Stmt \"" + query + "\" garbage collected, call Finalize")
// }
// })
// }
stmt, trailingBytes, err = c.prepare(query, 0)
if err != nil {
err = fmt.Errorf("sqlite: prepare: %w", err)
}
return stmt, trailingBytes, err
}
func (c *Conn) prepare(query string, flags uint32) (*Stmt, int, error) {
if err := c.interrupted(); err != nil {
return nil, 0, err
}
cquery, err := libc.CString(query)
if err != nil {
return nil, 0, err
}
defer libc.Xfree(c.tls, cquery)
ctrailingPtr, err := malloc(c.tls, ptrSize)
if err != nil {
return nil, 0, err
}
defer libc.Xfree(c.tls, ctrailingPtr)
stmtPtr, err := malloc(c.tls, ptrSize)
if err != nil {
return nil, 0, err
}
defer libc.Xfree(c.tls, stmtPtr)
res := ResultCode(lib.Xsqlite3_prepare_v3(c.tls, c.conn, cquery, -1, flags, stmtPtr, ctrailingPtr))
if err := c.extreserr(res); err != nil {
if offset, ok := ErrorOffset(err); ok && offset <= len(query) {
line, col := linecol(query[:offset])
err = fmt.Errorf("%d:%d: %w", line, col, err)
}
return nil, 0, err
}
ctrailing := *(*uintptr)(unsafe.Pointer(ctrailingPtr))
trailingBytes := len(query) - int(ctrailing-cquery)
stmt := &Stmt{
conn: c,
query: query,
stmt: *(*uintptr)(unsafe.Pointer(stmtPtr)),
}
stmt.bindNames = make([]string, lib.Xsqlite3_bind_parameter_count(c.tls, stmt.stmt))
for i := range stmt.bindNames {
cname := lib.Xsqlite3_bind_parameter_name(c.tls, stmt.stmt, int32(i+1))
if cname != 0 {
stmt.bindNames[i] = libc.GoString(cname)
}
}
colCount := int(lib.Xsqlite3_column_count(c.tls, stmt.stmt))
stmt.colNames = make(map[string]int, colCount)
for i := 0; i < colCount; i++ {
cname := lib.Xsqlite3_column_name(c.tls, stmt.stmt, int32(i))
if cname != 0 {
stmt.colNames[libc.GoString(cname)] = i
}
}
return stmt, trailingBytes, nil
}
// Changes reports the number of rows affected by the most recent statement.
//
// https://www.sqlite.org/c3ref/changes.html
func (c *Conn) Changes() int {
if c == nil {
return 0
}
return int(lib.Xsqlite3_changes(c.tls, c.conn))
}
// LastInsertRowID reports the rowid of the most recently successful INSERT.
//
// https://www.sqlite.org/c3ref/last_insert_rowid.html
func (c *Conn) LastInsertRowID() int64 {
if c == nil {
return 0
}
return lib.Xsqlite3_last_insert_rowid(c.tls, c.conn)
}
// Serialize serializes the database with the given name (e.g. "main" or "temp").
func (c *Conn) Serialize(dbName string) ([]byte, error) {
if c == nil {
return nil, fmt.Errorf("sqlite: serialize %q: nil connection", dbName)
}
zSchema, cleanup, err := cDBName(dbName)
if err != nil {
return nil, fmt.Errorf("sqlite: serialize %q: %v", dbName, err)
}
defer cleanup()
piSize := lib.Xsqlite3_malloc(c.tls, int32(unsafe.Sizeof(int64(0))))
if piSize == 0 {
return nil, fmt.Errorf("sqlite: serialize %q: memory allocation failure", dbName)
}
defer lib.Xsqlite3_free(c.tls, piSize)
// Optimization: avoid copying if possible.
p := lib.Xsqlite3_serialize(c.tls, c.conn, zSchema, piSize, lib.SQLITE_SERIALIZE_NOCOPY)
if p == 0 {
// Optimization impossible. Have SQLite allocate memory.
p = lib.Xsqlite3_serialize(c.tls, c.conn, zSchema, piSize, 0)
if p == 0 {
return nil, fmt.Errorf("sqlite: serialize %q: unable to serialize", dbName)
}
defer lib.Xsqlite3_free(c.tls, p)
}
// Copy data into a Go byte slice.
n := *(*int64)(unsafe.Pointer(piSize))
goCopy := make([]byte, n)
copy(goCopy, libc.GoBytes(p, int(n)))
return goCopy, nil
}
// Deserialize disconnects the database with the given name (e.g. "main")
// and reopens it as an in-memory database based on the serialized data.
// The database name must already exist.
// It is not possible to deserialize into the TEMP database.
func (c *Conn) Deserialize(dbName string, data []byte) error {
if c == nil {
return fmt.Errorf("sqlite: deserialize to %q: nil connection", dbName)
}
zSchema, cleanup, err := cDBName(dbName)
if err != nil {
return fmt.Errorf("sqlite: deserialize to %q: %v", dbName, err)
}
defer cleanup()
n := int64(len(data))
pData := lib.Xsqlite3_malloc64(c.tls, uint64(n))
if pData == 0 {
return fmt.Errorf("sqlite: deserialize to %q: memory allocation failure", dbName)
}
copy(libc.GoBytes(pData, len(data)), data)
res := ResultCode(lib.Xsqlite3_deserialize(c.tls, c.conn, zSchema, pData, n, n, lib.SQLITE_DESERIALIZE_FREEONCLOSE|lib.SQLITE_DESERIALIZE_RESIZEABLE))
if !res.IsSuccess() {
return fmt.Errorf("sqlite: deserialize to %q: %w", dbName, res.ToError())
}
return nil
}
// extreserr asks SQLite for a string explaining the error.
// Only called for errors that are probably program bugs.
func (c *Conn) extreserr(res ResultCode) error {
if res.IsSuccess() {
return nil
}
return &extendedError{
code: res,
offset: int(lib.Xsqlite3_error_offset(c.tls, c.conn)),
message: libc.GoString(lib.Xsqlite3_errmsg(c.tls, c.conn)),
}
}
// linecol computes the 1-based line number and column
// of a character placed after s.
func linecol(s string) (line, col int) {
line, col = 1, 1
for _, c := range s {
// This is intentionally a bit naive with regards to control characters.
// If the user wants greater control,
switch c {
case '\n':
line++
col = 1
case '\t':
const tabWidth = 8
locationInTab := (col - 1) % tabWidth
col += tabWidth - locationInTab
default:
col++
}
}
return
}
// Stmt is an SQLite3 prepared statement.
//
// A Stmt is attached to a particular Conn
// (and that Conn can only be used by a single goroutine).
//
// When a Stmt is no longer needed it should be cleaned up
// by calling the Finalize method.
type Stmt struct {
conn *Conn
stmt uintptr
query string
bindNames []string
colNames map[string]int
bindErr error
prepInterrupt bool // set if Prep was interrupted
lastHasRow bool // last bool returned by Step
}
func (stmt *Stmt) interrupted() error {
if stmt.prepInterrupt {
return ResultInterrupt.ToError()
}
return stmt.conn.interrupted()
}
// Finalize deletes a prepared statement.
//
// Be sure to always call Finalize when done with
// a statement created using PrepareTransient.
//
// Do not call Finalize on a prepared statement that
// you intend to prepare again in the future.
//
// https://www.sqlite.org/c3ref/finalize.html
func (stmt *Stmt) Finalize() error {
if ptr := stmt.conn.stmts[stmt.query]; ptr == stmt {
delete(stmt.conn.stmts, stmt.query)
}
res := ResultCode(lib.Xsqlite3_finalize(stmt.conn.tls, stmt.stmt))
stmt.conn = nil
if err := res.ToError(); err != nil {
return fmt.Errorf("sqlite: finalize: %w", err)
}
return nil
}
// Reset resets a prepared statement so it can be executed again.
//
// Note that any parameter values bound to the statement are retained.
// To clear bound values, call ClearBindings.
//
// https://www.sqlite.org/c3ref/reset.html
func (stmt *Stmt) Reset() error {
stmt.lastHasRow = false
var res ResultCode
for {
res = ResultCode(lib.Xsqlite3_reset(stmt.conn.tls, stmt.stmt))
if res != ResultLockedSharedCache {
break
}
// An SQLITE_LOCKED_SHAREDCACHE error has been seen from sqlite3_reset
// in the wild, but so far has eluded exact test case replication.
// TODO: write a test for this.
if res := waitForUnlockNotify(stmt.conn.tls, stmt.conn.conn, stmt.conn.unlockNote); res != ResultOK {
return fmt.Errorf("sqlite: reset: %w", stmt.conn.extreserr(res))
}
}
if err := stmt.conn.extreserr(res); err != nil {
return fmt.Errorf("sqlite: reset: %w", err)
}
return nil
}
// ClearBindings clears all bound parameter values on a statement.
//
// https://www.sqlite.org/c3ref/clear_bindings.html
func (stmt *Stmt) ClearBindings() error {
if err := stmt.interrupted(); err != nil {
return fmt.Errorf("sqlite: clear bindings: %w", err)
}
res := ResultCode(lib.Xsqlite3_clear_bindings(stmt.conn.tls, stmt.stmt))
if err := res.ToError(); err != nil {
return fmt.Errorf("sqlite: clear bindings: %w", err)
}
return nil
}
// Step moves through the statement cursor using sqlite3_step.
//
// If a row of data is available, rowReturned is reported as true.
// If the statement has reached the end of the available data then
// rowReturned is false. Thus the status codes SQLITE_ROW and
// SQLITE_DONE are reported by the rowReturned bool, and all other
// non-OK status codes are reported as an error.
//
// If an error value is returned, then the statement has been reset.
//
// https://www.sqlite.org/c3ref/step.html
//
// # Shared cache
//
// As multiple writers are common in multi-threaded programs,
// this Step method uses sqlite3_unlock_notify to handle any
// SQLITE_LOCKED errors.
//
// Without the shared cache, SQLite will block for
// several seconds while trying to acquire the write lock.
// With the shared cache, it returns SQLITE_LOCKED immediately
// if the write lock is held by another connection in this process.
// Dealing with this correctly makes for an unpleasant programming
// experience, so this package does it automatically by blocking
// Step until the write lock is relinquished.
//
// This means Step can block for a very long time.
// Use SetInterrupt to control how long Step will block.
//
// For far more details, see:
//
// http://www.sqlite.org/unlock_notify.html
func (stmt *Stmt) Step() (rowReturned bool, err error) {
if stmt.bindErr != nil {
err = stmt.bindErr
stmt.bindErr = nil
stmt.Reset()
return false, fmt.Errorf("sqlite: step: %w", err)
}
rowReturned, err = stmt.step()
stmt.lastHasRow = rowReturned
if err != nil {
lib.Xsqlite3_reset(stmt.conn.tls, stmt.stmt)
return rowReturned, fmt.Errorf("sqlite: step: %w", err)
}
return rowReturned, nil
}
func (stmt *Stmt) step() (bool, error) {
for {
if err := stmt.interrupted(); err != nil {
return false, err
}
switch res := ResultCode(lib.Xsqlite3_step(stmt.conn.tls, stmt.stmt)); res.ToPrimary() {
case ResultLocked:
if res != ResultLockedSharedCache {
// don't call waitForUnlockNotify as it might deadlock, see:
// https://github.com/crawshaw/sqlite/issues/6
return false, stmt.conn.extreserr(res)
}
if res := waitForUnlockNotify(stmt.conn.tls, stmt.conn.conn, stmt.conn.unlockNote); !res.IsSuccess() {
return false, stmt.conn.extreserr(res)
}
lib.Xsqlite3_reset(stmt.conn.tls, stmt.stmt)
// loop
case ResultRow:
return true, nil
case ResultDone:
return false, nil
case ResultInterrupt:
// TODO: embed some of these errors into the stmt for zero-alloc errors?
return false, res.ToError()
default:
return false, stmt.conn.extreserr(res)
}
}
}
func (stmt *Stmt) handleBindErr(prefix string, res ResultCode) {
if stmt.bindErr == nil && !res.IsSuccess() {
stmt.bindErr = fmt.Errorf("%s: %w", prefix, res.ToError())
}
}
// DataCount returns the number of columns in the current row of the result
// set of prepared statement.
//
// https://sqlite.org/c3ref/data_count.html
func (stmt *Stmt) DataCount() int {
return int(lib.Xsqlite3_data_count(stmt.conn.tls, stmt.stmt))
}
// ColumnCount returns the number of columns in the result set returned by the
// prepared statement.
//
// https://sqlite.org/c3ref/column_count.html
func (stmt *Stmt) ColumnCount() int {
return int(lib.Xsqlite3_column_count(stmt.conn.tls, stmt.stmt))
}
// ColumnName returns the name assigned to a particular column in the result
// set of a SELECT statement.
//
// https://sqlite.org/c3ref/column_name.html
func (stmt *Stmt) ColumnName(col int) string {
return libc.GoString(lib.Xsqlite3_column_name(stmt.conn.tls, stmt.stmt, int32(col)))
}
// BindParamCount reports the number of parameters in stmt.
//
// https://www.sqlite.org/c3ref/bind_parameter_count.html
func (stmt *Stmt) BindParamCount() int {
if stmt.stmt == 0 {
return 0
}
return len(stmt.bindNames)
}
// BindParamName returns the name of parameter or the empty string if the
// parameter is nameless or i is out of range.
//
// Parameters indices start at 1.
//
// https://www.sqlite.org/c3ref/bind_parameter_name.html
func (stmt *Stmt) BindParamName(i int) string {
i-- // map from 1-based to 0-based
if i < 0 || i >= len(stmt.bindNames) {
return ""
}
return stmt.bindNames[i]
}
// BindInt64 binds value to a numbered stmt parameter.
//
// Parameter indices start at 1.
//
// https://www.sqlite.org/c3ref/bind_blob.html
func (stmt *Stmt) BindInt64(param int, value int64) {
if stmt.stmt == 0 {
return
}
res := ResultCode(lib.Xsqlite3_bind_int64(stmt.conn.tls, stmt.stmt, int32(param), value))
stmt.handleBindErr("bind int64", res)
}
// BindBool binds value (as an integer 0 or 1) to a numbered stmt parameter.
//
// Parameter indices start at 1.
//
// https://www.sqlite.org/c3ref/bind_blob.html
func (stmt *Stmt) BindBool(param int, value bool) {
if stmt.stmt == 0 {
return
}
v := int64(0)
if value {
v = 1
}
res := ResultCode(lib.Xsqlite3_bind_int64(stmt.conn.tls, stmt.stmt, int32(param), v))
stmt.handleBindErr("bind bool", res)
}
var emptyCString = mustCString("")
const sqliteStatic uintptr = 0
// BindBytes binds value to a numbered stmt parameter.
//
// In-memory copies of value are made using this interface.
// For large blobs, consider using the streaming Blob object.
//
// Parameter indices start at 1.
//
// https://www.sqlite.org/c3ref/bind_blob.html
func (stmt *Stmt) BindBytes(param int, value []byte) {
if stmt.stmt == 0 {
return
}
if len(value) == 0 {
res := ResultCode(lib.Xsqlite3_bind_blob(stmt.conn.tls, stmt.stmt, int32(param), emptyCString, 0, sqliteStatic))
stmt.handleBindErr("bind bytes", res)
return
}
v, err := malloc(stmt.conn.tls, types.Size_t(len(value)))
if err != nil {
if stmt.bindErr == nil {
stmt.bindErr = fmt.Errorf("bind bytes: %w", err)
}
return
}
for i, b := range value {
*(*byte)(unsafe.Pointer(v + uintptr(i))) = b
}
res := ResultCode(lib.Xsqlite3_bind_blob(stmt.conn.tls, stmt.stmt, int32(param), v, int32(len(value)), freeFuncPtr))
stmt.handleBindErr("bind bytes", res)
}
var freeFuncPtr = cFuncPointer(libc.Xfree)
// BindText binds value to a numbered stmt parameter.
//
// Parameter indices start at 1.
//
// https://www.sqlite.org/c3ref/bind_blob.html
func (stmt *Stmt) BindText(param int, value string) {
if stmt.stmt == 0 {
return
}
allocSize := types.Size_t(len(value))
if allocSize == 0 {
allocSize = 1
}
v, err := malloc(stmt.conn.tls, allocSize)
if err != nil {
if stmt.bindErr == nil {
stmt.bindErr = fmt.Errorf("bind text: %w", err)
}
return
}
for i := 0; i < len(value); i++ {
*(*byte)(unsafe.Pointer(v + uintptr(i))) = value[i]
}
res := ResultCode(lib.Xsqlite3_bind_text(stmt.conn.tls, stmt.stmt, int32(param), v, int32(len(value)), freeFuncPtr))
stmt.handleBindErr("bind text", res)
}
// BindFloat binds value to a numbered stmt parameter.
//
// Parameter indices start at 1.
//
// https://www.sqlite.org/c3ref/bind_blob.html
func (stmt *Stmt) BindFloat(param int, value float64) {
if stmt.stmt == 0 {
return