/
Class_SQLiteDB.ahk
1252 lines (1251 loc) · 61.5 KB
/
Class_SQLiteDB.ahk
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
; ======================================================================================================================
; Function: Class definitions as wrappers for SQLite3.dll to work with SQLite DBs.
; AHK version: 1.1.33.09
; Tested on: Win 10 Pro (x64), SQLite 3.11.1
; Version: 0.0.01.00/2011-08-10/just me
; 0.0.02.00/2012-08-10/just me - Added basic BLOB support
; 0.0.03.00/2012-08-11/just me - Added more advanced BLOB support
; 0.0.04.00/2013-06-29/just me - Added new methods AttachDB and DetachDB
; 0.0.05.00/2013-08-03/just me - Changed base class assignment
; 0.0.06.00/2016-01-28/just me - Fixed version check, revised parameter initialization.
; 0.0.07.00/2016-03-28/just me - Added support for PRAGMA statements.
; 0.0.08.00/2019-03-09/just me - Added basic support for application-defined functions
; 0.0.09.00/2019-07-09/just me - Added basic support for prepared statements, minor bug fixes
; 0.0.10.00/2019-12-12/just me - Fixed bug in EscapeStr method
; 0.0.11.00/2021-10-10/just me - Removed statement checks in GetTable, Prepare, and Query
; 0.0.12.00/2022-09-18/just me - Fixed bug for Bind - type text
; 0.0.13.00/2022-10-03/just me - Fixed bug in Prepare
; 0.0.14.00/2022-10-04/just me - Changed DllCall parameter type PtrP to UPtrP
; Remarks: Names of "private" properties / methods are prefixed with an underscore,
; they must not be set / called by the script!
;
; SQLite3.dll file is assumed to be in the script's folder, otherwise you have to
; provide an INI-File SQLiteDB.ini in the script's folder containing the path:
; [Main]
; DllPath=Path to SQLite3.dll
;
; Encoding of SQLite DBs is assumed to be UTF-8
; Minimum supported SQLite3.dll version is 3.6
; Download the current version of SQLite3.dll (and also SQlite3.exe) from www.sqlite.org
; ======================================================================================================================
; This software is provided 'as-is', without any express or implied warranty.
; In no event will the authors be held liable for any damages arising from the
; use of this software.
; ======================================================================================================================
; CLASS SQliteDB - SQLiteDB main class
; ======================================================================================================================
Class SQLiteDB {
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; PRIVATE Properties and Methods ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Static Version := ""
Static _SQLiteDLL := A_ScriptDir . "\SQLite3.dll"
Static _RefCount := 0
Static _MinVersion := "3.6"
; ===================================================================================================================
; CLASS _Table
; Object returned from method GetTable()
; _Table is an independent object and does not need SQLite after creation at all.
; ===================================================================================================================
Class _Table {
; ----------------------------------------------------------------------------------------------------------------
; CONSTRUCTOR Create instance variables
; ----------------------------------------------------------------------------------------------------------------
__New() {
This.ColumnCount := 0 ; Number of columns in the result table (Integer)
This.RowCount := 0 ; Number of rows in the result table (Integer)
This.ColumnNames := [] ; Names of columns in the result table (Array)
This.Rows := [] ; Rows of the result table (Array of Arrays)
This.HasNames := False ; Does var ColumnNames contain names? (Bool)
This.HasRows := False ; Does var Rows contain rows? (Bool)
This._CurrentRow := 0 ; Row index of last returned row (Integer)
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD GetRow Get row for RowIndex
; Parameters: RowIndex - Index of the row to retrieve, the index of the first row is 1
; ByRef Row - Variable to pass out the row array
; Return values: On failure - False
; On success - True, Row contains a valid array
; Remarks: _CurrentRow is set to RowIndex, so a subsequent call of NextRow() will return the
; following row.
; ----------------------------------------------------------------------------------------------------------------
GetRow(RowIndex, ByRef Row) {
Row := ""
If (RowIndex < 1 || RowIndex > This.RowCount)
Return False
If !This.Rows.HasKey(RowIndex)
Return False
Row := This.Rows[RowIndex]
This._CurrentRow := RowIndex
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Next Get next row depending on _CurrentRow
; Parameters: ByRef Row - Variable to pass out the row array
; Return values: On failure - False, -1 for EOR (end of rows)
; On success - True, Row contains a valid array
; ----------------------------------------------------------------------------------------------------------------
Next(ByRef Row) {
Row := ""
If (This._CurrentRow >= This.RowCount)
Return -1
This._CurrentRow += 1
If !This.Rows.HasKey(This._CurrentRow)
Return False
Row := This.Rows[This._CurrentRow]
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Reset Reset _CurrentRow to zero
; Parameters: None
; Return value: True
; ----------------------------------------------------------------------------------------------------------------
Reset() {
This._CurrentRow := 0
Return True
}
}
; ===================================================================================================================
; CLASS _RecordSet
; Object returned from method Query()
; The records (rows) of a recordset can be accessed sequentially per call of Next() starting with the first record.
; After a call of Reset() calls of Next() will start with the first record again.
; When the recordset isn't needed any more, call Free() to free the resources.
; The lifetime of a recordset depends on the lifetime of the related SQLiteDB object.
; ===================================================================================================================
Class _RecordSet {
; ----------------------------------------------------------------------------------------------------------------
; CONSTRUCTOR Create instance variables
; ----------------------------------------------------------------------------------------------------------------
__New() {
This.ColumnCount := 0 ; Number of columns (Integer)
This.ColumnNames := [] ; Names of columns in the result table (Array)
This.HasNames := False ; Does var ColumnNames contain names? (Bool)
This.HasRows := False ; Does _RecordSet contain rows? (Bool)
This.CurrentRow := 0 ; Index of current row (Integer)
This.ErrorMsg := "" ; Last error message (String)
This.ErrorCode := 0 ; Last SQLite error code / ErrorLevel (Variant)
This._Handle := 0 ; Query handle (Pointer)
This._DB := {} ; SQLiteDB object (Object)
}
; ----------------------------------------------------------------------------------------------------------------
; DESTRUCTOR Clear instance variables
; ----------------------------------------------------------------------------------------------------------------
__Delete() {
If (This._Handle)
This.Free()
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Next Get next row of query result
; Parameters: ByRef Row - Variable to store the row array
; Return values: On success - True, Row contains the row array
; On failure - False, ErrorMsg / ErrorCode contain additional information
; -1 for EOR (end of records)
; ----------------------------------------------------------------------------------------------------------------
Next(ByRef Row) {
Static SQLITE_NULL := 5
Static SQLITE_BLOB := 4
Static EOR := -1
Row := ""
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle) {
This.ErrorMsg := "Invalid query handle!"
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_step", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_step failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC <> This._DB._ReturnCode("SQLITE_ROW")) {
If (RC = This._DB._ReturnCode("SQLITE_DONE")) {
This.ErrorMsg := "EOR"
This.ErrorCode := RC
Return EOR
}
This.ErrorMsg := This._DB.ErrMsg()
This.ErrorCode := RC
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_data_count", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_data_count failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC < 1) {
This.ErrorMsg := "Recordset is empty!"
This.ErrorCode := This._DB._ReturnCode("SQLITE_EMPTY")
Return False
}
Row := []
Loop, %RC% {
Column := A_Index - 1
ColumnType := DllCall("SQlite3.dll\sqlite3_column_type", "Ptr", This._Handle, "Int", Column, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_column_type failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (ColumnType = SQLITE_NULL) {
Row[A_Index] := ""
} Else If (ColumnType = SQLITE_BLOB) {
BlobPtr := DllCall("SQlite3.dll\sqlite3_column_blob", "Ptr", This._Handle, "Int", Column, "Cdecl UPtr")
BlobSize := DllCall("SQlite3.dll\sqlite3_column_bytes", "Ptr", This._Handle, "Int", Column, "Cdecl Int")
If (BlobPtr = 0) || (BlobSize = 0) {
Row[A_Index] := ""
} Else {
Row[A_Index] := {}
Row[A_Index].Size := BlobSize
Row[A_Index].Blob := ""
Row[A_Index].SetCapacity("Blob", BlobSize)
Addr := Row[A_Index].GetAddress("Blob")
DllCall("Kernel32.dll\RtlMoveMemory", "Ptr", Addr, "Ptr", BlobPtr, "Ptr", BlobSize)
}
} Else {
StrPtr := DllCall("SQlite3.dll\sqlite3_column_text", "Ptr", This._Handle, "Int", Column, "Cdecl UPtr")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_column_text failed!"
This.ErrorCode := ErrorLevel
Return False
}
Row[A_Index] := StrGet(StrPtr, "UTF-8")
}
}
This.CurrentRow += 1
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Reset Reset the result pointer
; Parameters: None
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: After a call of this method you can access the query result via Next() again.
; ----------------------------------------------------------------------------------------------------------------
Reset() {
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle) {
This.ErrorMsg := "Invalid query handle!"
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_reset", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_reset failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._DB._ErrMsg()
This.ErrorCode := RC
Return False
}
This.CurrentRow := 0
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Free Free query result
; Parameters: None
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: After the call of this method further access on the query result is impossible.
; ----------------------------------------------------------------------------------------------------------------
Free() {
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle)
Return True
RC := DllCall("SQlite3.dll\sqlite3_finalize", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_finalize failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._DB._ErrMsg()
This.ErrorCode := RC
Return False
}
This._DB._Queries.Delete(This._Handle)
This._Handle := 0
This._DB := 0
Return True
}
}
; ===================================================================================================================
; CLASS _Statement
; Object returned from method Prepare()
; The life-cycle of a prepared statement object usually goes like this:
; 1. Create the prepared statement object (PST) by calling DB.Prepare().
; 2. Bind values to parameters using the PST.Bind_*() methods of the statement object.
; 3. Run the SQL by calling PST.Step() one or more times.
; 4. Reset the prepared statement using PTS.Reset() then go back to step 2. Do this zero or more times.
; 5. Destroy the object using PST.Finalize().
; The lifetime of a prepared statement depends on the lifetime of the related SQLiteDB object.
; ===================================================================================================================
Class _Statement {
; ----------------------------------------------------------------------------------------------------------------
; CONSTRUCTOR Create instance variables
; ----------------------------------------------------------------------------------------------------------------
__New() {
This.ErrorMsg := "" ; Last error message (String)
This.ErrorCode := 0 ; Last SQLite error code / ErrorLevel (Variant)
This.ParamCount := 0 ; Number of SQL parameters for this statement (Integer)
This._Handle := 0 ; Query handle (Pointer)
This._DB := {} ; SQLiteDB object (Object)
}
; ----------------------------------------------------------------------------------------------------------------
; DESTRUCTOR Clear instance variables
; ----------------------------------------------------------------------------------------------------------------
__Delete() {
If (This._Handle)
This.Free()
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Bind Bind values to SQL parameters.
; Parameters: Index - 1-based index of the SQL parameter
; Type - type of the SQL parameter (currently: Blob/Double/Int/Text)
; Param3 - type dependent value
; Param4 - type dependent value
; Param5 - not used
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ----------------------------------------------------------------------------------------------------------------
Bind(Index, Type, Param3 := "", Param4 := 0, Param5 := 0) {
Static SQLITE_STATIC := 0
Static SQLITE_TRANSIENT := -1
Static Types := {Blob: 1, Double: 1, Int: 1, Text: 1}
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle) {
This.ErrorMsg := "Invalid statement handle!"
Return False
}
If (Index < 1) || (Index > This.ParamCount) {
This.ErrorMsg := "Invalid parameter index!"
Return False
}
If (Types[Type] = "") {
This.ErrorMsg := "Invalid parameter type!"
Return False
}
If (Type = "Blob") { ; ----------------------------------------------------------------------------------------
; Param3 = BLOB pointer, Param4 = BLOB size in bytes
If Param3 Is Not Integer
{
This.ErrorMsg := "Invalid blob pointer!"
Return False
}
If Param4 Is Not Integer
{
This.ErrorMsg := "Invalid blob size!"
Return False
}
; Let SQLite always create a copy of the BLOB
RC := DllCall("SQlite3.dll\sqlite3_bind_blob", "Ptr", This._Handle, "Int", Index, "Ptr", Param3
, "Int", Param4, "Ptr", -1, "Cdecl Int")
If (ErrorLeveL) {
This.ErrorMsg := "DllCall sqlite3_bind_blob failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
}
Else If (Type = "Double") { ; ---------------------------------------------------------------------------------
; Param3 = double value
If Param3 Is Not Float
{
This.ErrorMsg := "Invalid value for double!"
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_bind_double", "Ptr", This._Handle, "Int", Index, "Double", Param3
, "Cdecl Int")
If (ErrorLeveL) {
This.ErrorMsg := "DllCall sqlite3_bind_double failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
}
Else If (Type = "Int") { ; ------------------------------------------------------------------------------------
; Param3 = integer value
If Param3 Is Not Integer
{
This.ErrorMsg := "Invalid value for int!"
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_bind_int", "Ptr", This._Handle, "Int", Index, "Int", Param3
, "Cdecl Int")
If (ErrorLeveL) {
This.ErrorMsg := "DllCall sqlite3_bind_int failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
}
Else If (Type = "Text") { ; -----------------------------------------------------------------------------------
; Param3 = zero-terminated string
This._DB._StrToUTF8(Param3, UTF8)
; Let SQLite always create a copy of the text
RC := DllCall("SQlite3.dll\sqlite3_bind_text", "Ptr", This._Handle, "Int", Index, "Ptr", &UTF8
, "Int", -1, "Ptr", -1, "Cdecl Int")
If (ErrorLeveL) {
This.ErrorMsg := "DllCall sqlite3_bind_text failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
}
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Step Evaluate the prepared statement.
; Parameters: None
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: You must call ST.Reset() before you can call ST.Step() again.
; ----------------------------------------------------------------------------------------------------------------
Step() {
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle) {
This.ErrorMsg := "Invalid statement handle!"
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_step", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_step failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC <> This._DB._ReturnCode("SQLITE_DONE"))
&& (RC <> This._DB._ReturnCode("SQLITE_ROW")) {
This.ErrorMsg := This._DB.ErrMsg()
This.ErrorCode := RC
Return False
}
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Reset Reset the prepared statement.
; Parameters: ClearBindings - Clear bound SQL parameter values (True/False)
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: After a call of this method you can access the query result via Next() again.
; ----------------------------------------------------------------------------------------------------------------
Reset(ClearBindings := True) {
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle) {
This.ErrorMsg := "Invalid statement handle!"
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_reset", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_reset failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._DB._ErrMsg()
This.ErrorCode := RC
Return False
}
If (ClearBindings) {
RC := DllCall("SQlite3.dll\sqlite3_clear_bindings", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_clear_bindings failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._DB._ErrMsg()
This.ErrorCode := RC
Return False
}
}
Return True
}
; ----------------------------------------------------------------------------------------------------------------
; METHOD Free Free the prepared statement object.
; Parameters: None
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: After the call of this method further access on the statement object is impossible.
; ----------------------------------------------------------------------------------------------------------------
Free() {
This.ErrorMsg := ""
This.ErrorCode := 0
If !(This._Handle)
Return True
RC := DllCall("SQlite3.dll\sqlite3_finalize", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DllCall sqlite3_finalize failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._DB._ErrMsg()
This.ErrorCode := RC
Return False
}
This._DB._Stmts.Delete(This._Handle)
This._Handle := 0
This._DB := 0
Return True
}
}
; ===================================================================================================================
; CONSTRUCTOR __New
; ===================================================================================================================
__New() {
This._Path := "" ; Database path (String)
This._Handle := 0 ; Database handle (Pointer)
This._Queries := {} ; Valid queries (Object)
This._Stmts := {} ; Valid prepared statements (Object)
If (This.Base._RefCount = 0) {
SQLiteDLL := This.Base._SQLiteDLL
If !FileExist(SQLiteDLL)
If FileExist(A_ScriptDir . "\SQLiteDB.ini") {
IniRead, SQLiteDLL, %A_ScriptDir%\SQLiteDB.ini, Main, DllPath, %SQLiteDLL%
This.Base._SQLiteDLL := SQLiteDLL
}
If !(DLL := DllCall("LoadLibrary", "Str", This.Base._SQLiteDLL, "UPtr")) {
MsgBox, 16, SQLiteDB Error, % "DLL " . SQLiteDLL . " does not exist!"
ExitApp
}
This.Base.Version := StrGet(DllCall("SQlite3.dll\sqlite3_libversion", "Cdecl UPtr"), "UTF-8")
SQLVersion := StrSplit(This.Base.Version, ".")
MinVersion := StrSplit(This.Base._MinVersion, ".")
If (SQLVersion[1] < MinVersion[1]) || ((SQLVersion[1] = MinVersion[1]) && (SQLVersion[2] < MinVersion[2])){
DllCall("FreeLibrary", "Ptr", DLL)
MsgBox, 16, SQLite ERROR, % "Version " . This.Base.Version . " of SQLite3.dll is not supported!`n`n"
. "You can download the current version from www.sqlite.org!"
ExitApp
}
}
This.Base._RefCount += 1
}
; ===================================================================================================================
; DESTRUCTOR __Delete
; ===================================================================================================================
__Delete() {
If (This._Handle)
This.CloseDB()
This.Base._RefCount -= 1
If (This.Base._RefCount = 0) {
If (DLL := DllCall("GetModuleHandle", "Str", This.Base._SQLiteDLL, "UPtr"))
DllCall("FreeLibrary", "Ptr", DLL)
}
}
; ===================================================================================================================
; PRIVATE _StrToUTF8
; ===================================================================================================================
_StrToUTF8(Str, ByRef UTF8) {
VarSetCapacity(UTF8, StrPut(Str, "UTF-8"), 0)
StrPut(Str, &UTF8, "UTF-8")
Return &UTF8
}
; ===================================================================================================================
; PRIVATE _UTF8ToStr
; ===================================================================================================================
_UTF8ToStr(UTF8) {
Return StrGet(UTF8, "UTF-8")
}
; ===================================================================================================================
; PRIVATE _ErrMsg
; ===================================================================================================================
_ErrMsg() {
If (RC := DllCall("SQLite3.dll\sqlite3_errmsg", "Ptr", This._Handle, "Cdecl UPtr"))
Return StrGet(&RC, "UTF-8")
Return ""
}
; ===================================================================================================================
; PRIVATE _ErrCode
; ===================================================================================================================
_ErrCode() {
Return DllCall("SQLite3.dll\sqlite3_errcode", "Ptr", This._Handle, "Cdecl Int")
}
; ===================================================================================================================
; PRIVATE _Changes
; ===================================================================================================================
_Changes() {
Return DllCall("SQLite3.dll\sqlite3_changes", "Ptr", This._Handle, "Cdecl Int")
}
; ===================================================================================================================
; PRIVATE _Returncode
; ===================================================================================================================
_ReturnCode(RC) {
Static RCODE := {SQLITE_OK: 0 ; Successful result
, SQLITE_ERROR: 1 ; SQL error or missing database
, SQLITE_INTERNAL: 2 ; NOT USED. Internal logic error in SQLite
, SQLITE_PERM: 3 ; Access permission denied
, SQLITE_ABORT: 4 ; Callback routine requested an abort
, SQLITE_BUSY: 5 ; The database file is locked
, SQLITE_LOCKED: 6 ; A table in the database is locked
, SQLITE_NOMEM: 7 ; A malloc() failed
, SQLITE_READONLY: 8 ; Attempt to write a readonly database
, SQLITE_INTERRUPT: 9 ; Operation terminated by sqlite3_interrupt()
, SQLITE_IOERR: 10 ; Some kind of disk I/O error occurred
, SQLITE_CORRUPT: 11 ; The database disk image is malformed
, SQLITE_NOTFOUND: 12 ; NOT USED. Table or record not found
, SQLITE_FULL: 13 ; Insertion failed because database is full
, SQLITE_CANTOPEN: 14 ; Unable to open the database file
, SQLITE_PROTOCOL: 15 ; NOT USED. Database lock protocol error
, SQLITE_EMPTY: 16 ; Database is empty
, SQLITE_SCHEMA: 17 ; The database schema changed
, SQLITE_TOOBIG: 18 ; String or BLOB exceeds size limit
, SQLITE_CONSTRAINT: 19 ; Abort due to constraint violation
, SQLITE_MISMATCH: 20 ; Data type mismatch
, SQLITE_MISUSE: 21 ; Library used incorrectly
, SQLITE_NOLFS: 22 ; Uses OS features not supported on host
, SQLITE_AUTH: 23 ; Authorization denied
, SQLITE_FORMAT: 24 ; Auxiliary database format error
, SQLITE_RANGE: 25 ; 2nd parameter to sqlite3_bind out of range
, SQLITE_NOTADB: 26 ; File opened that is not a database file
, SQLITE_ROW: 100 ; sqlite3_step() has another row ready
, SQLITE_DONE: 101} ; sqlite3_step() has finished executing
Return RCODE.HasKey(RC) ? RCODE[RC] : ""
}
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; PUBLIC Interface ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
; ===================================================================================================================
; Properties
; ===================================================================================================================
ErrorMsg := "" ; Error message (String)
ErrorCode := 0 ; SQLite error code / ErrorLevel (Variant)
Changes := 0 ; Changes made by last call of Exec() (Integer)
SQL := "" ; Last executed SQL statement (String)
; ===================================================================================================================
; METHOD OpenDB Open a database
; Parameters: DBPath - Path of the database file
; Access - Wanted access: "R"ead / "W"rite
; Create - Create new database in write mode, if it doesn't exist
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: If DBPath is empty in write mode, a database called ":memory:" is created in memory
; and deletet on call of CloseDB.
; ===================================================================================================================
OpenDB(DBPath, Access := "W", Create := True) {
Static SQLITE_OPEN_READONLY := 0x01 ; Database opened as read-only
Static SQLITE_OPEN_READWRITE := 0x02 ; Database opened as read-write
Static SQLITE_OPEN_CREATE := 0x04 ; Database will be created if not exists
Static MEMDB := ":memory:"
This.ErrorMsg := ""
This.ErrorCode := 0
HDB := 0
If (DBPath = "")
DBPath := MEMDB
If (DBPath = This._Path) && (This._Handle)
Return True
If (This._Handle) {
This.ErrorMsg := "You must first close DB " . This._Path . "!"
Return False
}
Flags := 0
Access := SubStr(Access, 1, 1)
If (Access <> "W") && (Access <> "R")
Access := "R"
Flags := SQLITE_OPEN_READONLY
If (Access = "W") {
Flags := SQLITE_OPEN_READWRITE
If (Create)
Flags |= SQLITE_OPEN_CREATE
}
This._Path := DBPath
This._StrToUTF8(DBPath, UTF8)
RC := DllCall("SQlite3.dll\sqlite3_open_v2", "Ptr", &UTF8, "UPtrP", HDB, "Int", Flags, "Ptr", 0, "Cdecl Int")
If (ErrorLevel) {
This._Path := ""
This.ErrorMsg := "DLLCall sqlite3_open_v2 failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This._Path := ""
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
This._Handle := HDB
Return True
}
; ===================================================================================================================
; METHOD CloseDB Close database
; Parameters: None
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ===================================================================================================================
CloseDB() {
This.ErrorMsg := ""
This.ErrorCode := 0
This.SQL := ""
If !(This._Handle)
Return True
For Each, Query in This._Queries
DllCall("SQlite3.dll\sqlite3_finalize", "Ptr", Query, "Cdecl Int")
RC := DllCall("SQlite3.dll\sqlite3_close", "Ptr", This._Handle, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_close failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
This._Path := ""
This._Handle := ""
This._Queries := []
Return True
}
; ===================================================================================================================
; METHOD AttachDB Add another database file to the current database connection
; http://www.sqlite.org/lang_attach.html
; Parameters: DBPath - Path of the database file
; DBAlias - Database alias name used internally by SQLite
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ===================================================================================================================
AttachDB(DBPath, DBAlias) {
Return This.Exec("ATTACH DATABASE '" . DBPath . "' As " . DBAlias . ";")
}
; ===================================================================================================================
; METHOD DetachDB Detaches an additional database connection previously attached using AttachDB()
; http://www.sqlite.org/lang_detach.html
; Parameters: DBAlias - Database alias name used with AttachDB()
; Return values: On success - True
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ===================================================================================================================
DetachDB(DBAlias) {
Return This.Exec("DETACH DATABASE " . DBAlias . ";")
}
; ===================================================================================================================
; METHOD Exec Execute SQL statement
; Parameters: SQL - Valid SQL statement
; Callback - Name of a callback function to invoke for each result row coming out
; of the evaluated SQL statements.
; The function must accept 4 parameters:
; 1: SQLiteDB object
; 2: Number of columns
; 3: Pointer to an array of pointers to columns text
; 4: Pointer to an array of pointers to column names
; The address of the current SQL string is passed in A_EventInfo.
; If the callback function returns non-zero, DB.Exec() returns SQLITE_ABORT
; without invoking the callback again and without running any subsequent
; SQL statements.
; Return values: On success - True, the number of changed rows is given in property Changes
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ===================================================================================================================
Exec(SQL, Callback := "") {
This.ErrorMsg := ""
This.ErrorCode := 0
This.SQL := SQL
If !(This._Handle) {
This.ErrorMsg := "Invalid database handle!"
Return False
}
CBPtr := 0
Err := 0
If (FO := Func(Callback)) && (FO.MinParams = 4)
CBPtr := RegisterCallback(Callback, "F C", 4, &SQL)
This._StrToUTF8(SQL, UTF8)
RC := DllCall("SQlite3.dll\sqlite3_exec", "Ptr", This._Handle, "Ptr", &UTF8, "Int", CBPtr, "Ptr", Object(This)
, "UPtrP", Err, "Cdecl Int")
CallError := ErrorLevel
If (CBPtr)
DllCall("Kernel32.dll\GlobalFree", "Ptr", CBPtr)
If (CallError) {
This.ErrorMsg := "DLLCall sqlite3_exec failed!"
This.ErrorCode := CallError
Return False
}
If (RC) {
This.ErrorMsg := StrGet(Err, "UTF-8")
This.ErrorCode := RC
DllCall("SQLite3.dll\sqlite3_free", "Ptr", Err, "Cdecl")
Return False
}
This.Changes := This._Changes()
Return True
}
; ===================================================================================================================
; METHOD GetTable Get complete result for SELECT query
; Parameters: SQL - SQL SELECT statement
; ByRef TB - Variable to store the result object (TB _Table)
; MaxResult - Number of rows to return:
; 0 Complete result (default)
; -1 Return only RowCount and ColumnCount
; -2 Return counters and array ColumnNames
; n Return counters and ColumnNames and first n rows
; Return values: On success - True, TB contains the result object
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ===================================================================================================================
GetTable(SQL, ByRef TB, MaxResult := 0) {
TB := ""
This.ErrorMsg := ""
This.ErrorCode := 0
This.SQL := SQL
If !(This._Handle) {
This.ErrorMsg := "Invalid database handle!"
Return False
}
Names := ""
Err := 0, RC := 0, GetRows := 0
I := 0, Rows := Cols := 0
Table := 0
If MaxResult Is Not Integer
MaxResult := 0
If (MaxResult < -2)
MaxResult := 0
This._StrToUTF8(SQL, UTF8)
RC := DllCall("SQlite3.dll\sqlite3_get_table", "Ptr", This._Handle, "Ptr", &UTF8, "UPtrP", Table
, "IntP", Rows, "IntP", Cols, "UPtrP", Err, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_get_table failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := StrGet(Err, "UTF-8")
This.ErrorCode := RC
DllCall("SQLite3.dll\sqlite3_free", "Ptr", Err, "Cdecl")
Return False
}
TB := new This._Table
TB.ColumnCount := Cols
TB.RowCount := Rows
If (MaxResult = -1) {
DllCall("SQLite3.dll\sqlite3_free_table", "Ptr", Table, "Cdecl")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_free_table failed!"
This.ErrorCode := ErrorLevel
Return False
}
Return True
}
If (MaxResult = -2)
GetRows := 0
Else If (MaxResult > 0) && (MaxResult <= Rows)
GetRows := MaxResult
Else
GetRows := Rows
Offset := 0
Names := Array()
Loop, %Cols% {
Names[A_Index] := StrGet(NumGet(Table+0, Offset, "UPtr"), "UTF-8")
Offset += A_PtrSize
}
TB.ColumnNames := Names
TB.HasNames := True
Loop, %GetRows% {
I := A_Index
TB.Rows[I] := []
Loop, %Cols% {
TB.Rows[I][A_Index] := StrGet(NumGet(Table+0, Offset, "UPtr"), "UTF-8")
Offset += A_PtrSize
}
}
If (GetRows)
TB.HasRows := True
DllCall("SQLite3.dll\sqlite3_free_table", "Ptr", Table, "Cdecl")
If (ErrorLevel) {
TB := ""
This.ErrorMsg := "DLLCall sqlite3_free_table failed!"
This.ErrorCode := ErrorLevel
Return False
}
Return True
}
; ===================================================================================================================
; Prepared statement 10:54 2019.07.05. by Dixtroy
; DB := new SQLiteDB
; DB.OpenDB(DBFileName)
; DB.Prepare 1 or more, just once
; DB.Step 1 or more on prepared one, repeatable
; DB.Finalize at the end
; ===================================================================================================================
; ===================================================================================================================
; METHOD Prepare Prepare database table for further actions.
; Parameters: SQL - SQL statement to be compiled
; ByRef ST - Variable to store the statement object (Class _Statement)
; Return values: On success - True, ST contains the statement object
; On failure - False, ErrorMsg / ErrorCode contain additional information
; Remarks: You have to pass one ? for each column you want to assign a value later.
; ===================================================================================================================
Prepare(SQL, ByRef ST) {
This.ErrorMsg := ""
This.ErrorCode := 0
This.SQL := SQL
If !(This._Handle) {
This.ErrorMsg := "Invalid database handle!"
Return False
}
Stmt := 0
This._StrToUTF8(SQL, UTF8)
RC := DllCall("SQlite3.dll\sqlite3_prepare_v2", "Ptr", This._Handle, "Ptr", &UTF8, "Int", -1
, "UPtrP", Stmt, "Ptr", 0, "Cdecl Int")
If (ErrorLeveL) {
This.ErrorMsg := A_ThisFunc . ": DllCall sqlite3_prepare_v2 failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := A_ThisFunc . ": " . This._ErrMsg()
This.ErrorCode := RC
Return False
}
ST := New This._Statement
ST.ParamCount := DllCall("SQlite3.dll\sqlite3_bind_parameter_count", "Ptr", Stmt, "Cdecl Int")
ST._Handle := Stmt
ST._DB := This
This._Stmts[Stmt] := Stmt
Return True
}
; ===================================================================================================================
; METHOD Query Get "recordset" object for prepared SELECT query
; Parameters: SQL - SQL SELECT statement
; ByRef RS - Variable to store the result object (Class _RecordSet)
; Return values: On success - True, RS contains the result object
; On failure - False, ErrorMsg / ErrorCode contain additional information
; ===================================================================================================================
Query(SQL, ByRef RS) {
RS := ""
This.ErrorMsg := ""
This.ErrorCode := 0
This.SQL := SQL
ColumnCount := 0
HasRows := False
If !(This._Handle) {
This.ErrorMsg := "Invalid dadabase handle!"
Return False
}
Query := 0
This._StrToUTF8(SQL, UTF8)
RC := DllCall("SQlite3.dll\sqlite3_prepare_v2", "Ptr", This._Handle, "Ptr", &UTF8, "Int", -1
, "UPtrP", Query, "Ptr", 0, "Cdecl Int")
If (ErrorLeveL) {
This.ErrorMsg := "DLLCall sqlite3_prepare_v2 failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC) {
This.ErrorMsg := This._ErrMsg()
This.ErrorCode := RC
Return False
}
RC := DllCall("SQlite3.dll\sqlite3_column_count", "Ptr", Query, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_column_count failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC < 1) {
This.ErrorMsg := "Query result is empty!"
This.ErrorCode := This._ReturnCode("SQLITE_EMPTY")
Return False
}
ColumnCount := RC
Names := []
Loop, %RC% {
StrPtr := DllCall("SQlite3.dll\sqlite3_column_name", "Ptr", Query, "Int", A_Index - 1, "Cdecl UPtr")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_column_name failed!"
This.ErrorCode := ErrorLevel
Return False
}
Names[A_Index] := StrGet(StrPtr, "UTF-8")
}
RC := DllCall("SQlite3.dll\sqlite3_step", "Ptr", Query, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_step failed!"
This.ErrorCode := ErrorLevel
Return False
}
If (RC = This._ReturnCode("SQLITE_ROW"))
HasRows := True
RC := DllCall("SQlite3.dll\sqlite3_reset", "Ptr", Query, "Cdecl Int")
If (ErrorLevel) {
This.ErrorMsg := "DLLCall sqlite3_reset failed!"
This.ErrorCode := ErrorLevel
Return False
}
RS := new This._RecordSet
RS.ColumnCount := ColumnCount
RS.ColumnNames := Names