-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSQLiteBase.cs
executable file
·1391 lines (1248 loc) · 55.5 KB
/
SQLiteBase.cs
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
/********************************************************
* ADO.NET 2.0 Data Provider for SQLite Version 3.X
* Written by Robert Simpson ([email protected])
*
* Released to the public domain, use at your own risk!
********************************************************/
namespace System.Data.SQLite
{
using System;
using System.Collections.Generic;
#if !PLATFORM_COMPACTFRAMEWORK
using System.Runtime.InteropServices;
#endif
/// <summary>
/// This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement
/// a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite.
/// </summary>
internal abstract class SQLiteBase : SQLiteConvert, IDisposable
{
#region Private Constants
/// <summary>
/// The error code used for logging exceptions caught in user-provided
/// code.
/// </summary>
internal const int COR_E_EXCEPTION = unchecked((int)0x80131500);
#endregion
/////////////////////////////////////////////////////////////////////////
internal SQLiteBase(SQLiteDateFormats fmt, DateTimeKind kind, string fmtString)
: base(fmt, kind, fmtString) { }
/// <summary>
/// Returns a string representing the active version of SQLite
/// </summary>
internal abstract string Version { get; }
/// <summary>
/// Returns an integer representing the active version of SQLite
/// </summary>
internal abstract int VersionNumber { get; }
/// <summary>
/// Returns non-zero if this connection to the database is read-only.
/// </summary>
internal abstract bool IsReadOnly(string name);
/// <summary>
/// Returns the rowid of the most recent successful INSERT into the database from this connection.
/// </summary>
internal abstract long LastInsertRowId { get; }
/// <summary>
/// Returns the number of changes the last executing insert/update caused.
/// </summary>
internal abstract int Changes { get; }
/// <summary>
/// Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection
/// value, it is global to the process.
/// </summary>
internal abstract long MemoryUsed { get; }
/// <summary>
/// Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset.
/// This is not really a per-connection value, it is global to the process.
/// </summary>
internal abstract long MemoryHighwater { get; }
/// <summary>
/// Returns non-zero if the underlying native connection handle is owned by this instance.
/// </summary>
internal abstract bool OwnHandle { get; }
/// <summary>
/// Returns the logical list of functions associated with this connection.
/// </summary>
internal abstract IDictionary<SQLiteFunctionAttribute, SQLiteFunction> Functions { get; }
/// <summary>
/// Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled.
/// If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is
/// global to the process.
/// </summary>
/// <param name="value">Non-zero to enable memory usage tracking, zero otherwise.</param>
/// <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
internal abstract SQLiteErrorCode SetMemoryStatus(bool value);
/// <summary>
/// Attempts to free as much heap memory as possible for the database connection.
/// </summary>
/// <returns>A standard SQLite return code (i.e. zero for success and non-zero for failure).</returns>
internal abstract SQLiteErrorCode ReleaseMemory();
/// <summary>
/// Shutdown the SQLite engine so that it can be restarted with different config options.
/// We depend on auto initialization to recover.
/// </summary>
internal abstract SQLiteErrorCode Shutdown();
/// <summary>
/// Determines if the associated native connection handle is open.
/// </summary>
/// <returns>
/// Non-zero if a database connection is open.
/// </returns>
internal abstract bool IsOpen();
/// <summary>
/// Returns the fully qualified path and file name for the currently open
/// database, if any.
/// </summary>
/// <param name="dbName">
/// The name of the attached database to query.
/// </param>
/// <returns>
/// The fully qualified path and file name for the currently open database,
/// if any.
/// </returns>
internal abstract string GetFileName(string dbName);
/// <summary>
/// Opens a database.
/// </summary>
/// <remarks>
/// Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection
/// to bind all attributed user-defined functions and collating sequences to the new connection.
/// </remarks>
/// <param name="strFilename">The filename of the database to open. SQLite automatically creates it if it doesn't exist.</param>
/// <param name="vfsName">The name of the VFS to use -OR- null to use the default VFS.</param>
/// <param name="connectionFlags">The flags associated with the parent connection object</param>
/// <param name="openFlags">The open flags to use when creating the connection</param>
/// <param name="maxPoolSize">The maximum size of the pool for the given filename</param>
/// <param name="usePool">If true, the connection can be pulled from the connection pool</param>
internal abstract void Open(string strFilename, string vfsName, SQLiteConnectionFlags connectionFlags, SQLiteOpenFlagsEnum openFlags, int maxPoolSize, bool usePool);
/// <summary>
/// Closes the currently-open database.
/// </summary>
/// <remarks>
/// After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated
/// memory associated with the user-defined functions and collating sequences tied to the closed connection.
/// </remarks>
/// <param name="canThrow">Non-zero if the operation is allowed to throw exceptions, zero otherwise.</param>
internal abstract void Close(bool canThrow);
/// <summary>
/// Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command.
/// </summary>
/// <param name="nTimeoutMS">The number of milliseconds to wait before returning SQLITE_BUSY</param>
internal abstract void SetTimeout(int nTimeoutMS);
/// <summary>
/// Returns the text of the last error issued by SQLite
/// </summary>
/// <returns></returns>
internal abstract string GetLastError();
/// <summary>
/// Returns the text of the last error issued by SQLite -OR- the specified default error text if
/// none is available from the SQLite core library.
/// </summary>
/// <param name="defValue">
/// The error text to return in the event that one is not available from the SQLite core library.
/// </param>
/// <returns>
/// The error text.
/// </returns>
internal abstract string GetLastError(string defValue);
/// <summary>
/// When pooling is enabled, force this connection to be disposed rather than returned to the pool
/// </summary>
internal abstract void ClearPool();
/// <summary>
/// When pooling is enabled, returns the number of pool entries matching the current file name.
/// </summary>
/// <returns>The number of pool entries matching the current file name.</returns>
internal abstract int CountPool();
/// <summary>
/// Prepares a SQL statement for execution.
/// </summary>
/// <param name="cnn">The source connection preparing the command. Can be null for any caller except LINQ</param>
/// <param name="strSql">The SQL command text to prepare</param>
/// <param name="previous">The previous statement in a multi-statement command, or null if no previous statement exists</param>
/// <param name="timeoutMS">The timeout to wait before aborting the prepare</param>
/// <param name="strRemain">The remainder of the statement that was not processed. Each call to prepare parses the
/// SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned
/// here for a subsequent call to Prepare() until all the text has been processed.</param>
/// <returns>Returns an initialized SQLiteStatement.</returns>
internal abstract SQLiteStatement Prepare(SQLiteConnection cnn, string strSql, SQLiteStatement previous, uint timeoutMS, ref string strRemain);
/// <summary>
/// Steps through a prepared statement.
/// </summary>
/// <param name="stmt">The SQLiteStatement to step through</param>
/// <returns>True if a row was returned, False if not.</returns>
internal abstract bool Step(SQLiteStatement stmt);
/// <summary>
/// Returns non-zero if the specified statement is read-only in nature.
/// </summary>
/// <param name="stmt">The statement to check.</param>
/// <returns>True if the outer query is read-only.</returns>
internal abstract bool IsReadOnly(SQLiteStatement stmt);
/// <summary>
/// Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA,
/// transparently attempt to rebuild the SQL statement and throw an error if that was not possible.
/// </summary>
/// <param name="stmt">The statement to reset</param>
/// <returns>Returns -1 if the schema changed while resetting, 0 if the reset was sucessful or 6 (SQLITE_LOCKED) if the reset failed due to a lock</returns>
internal abstract SQLiteErrorCode Reset(SQLiteStatement stmt);
/// <summary>
/// Attempts to interrupt the query currently executing on the associated
/// native database connection.
/// </summary>
internal abstract void Cancel();
/// <summary>
/// This function binds a user-defined function to the connection.
/// </summary>
/// <param name="functionAttribute">
/// The <see cref="SQLiteFunctionAttribute"/> object instance containing
/// the metadata for the function to be bound.
/// </param>
/// <param name="function">
/// The <see cref="SQLiteFunction"/> object instance that implements the
/// function to be bound.
/// </param>
/// <param name="flags">
/// The flags associated with the parent connection object.
/// </param>
internal abstract void BindFunction(SQLiteFunctionAttribute functionAttribute, SQLiteFunction function, SQLiteConnectionFlags flags);
/// <summary>
/// This function unbinds a user-defined function from the connection.
/// </summary>
/// <param name="functionAttribute">
/// The <see cref="SQLiteFunctionAttribute"/> object instance containing
/// the metadata for the function to be unbound.
/// </param>
/// <param name="flags">
/// The flags associated with the parent connection object.
/// </param>
/// <returns>Non-zero if the function was unbound.</returns>
internal abstract bool UnbindFunction(SQLiteFunctionAttribute functionAttribute, SQLiteConnectionFlags flags);
internal abstract void Bind_Double(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, double value);
internal abstract void Bind_Int32(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, Int32 value);
internal abstract void Bind_UInt32(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, UInt32 value);
internal abstract void Bind_Int64(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, Int64 value);
internal abstract void Bind_UInt64(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, UInt64 value);
internal abstract void Bind_Boolean(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, bool value);
internal abstract void Bind_Text(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, string value);
internal abstract void Bind_Blob(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, byte[] blobData);
internal abstract void Bind_DateTime(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, DateTime dt);
internal abstract void Bind_Null(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index);
internal abstract int Bind_ParamCount(SQLiteStatement stmt, SQLiteConnectionFlags flags);
internal abstract string Bind_ParamName(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index);
internal abstract int Bind_ParamIndex(SQLiteStatement stmt, SQLiteConnectionFlags flags, string paramName);
internal abstract int ColumnCount(SQLiteStatement stmt);
internal abstract string ColumnName(SQLiteStatement stmt, int index);
internal abstract TypeAffinity ColumnAffinity(SQLiteStatement stmt, int index);
internal abstract string ColumnType(SQLiteStatement stmt, int index, ref TypeAffinity nAffinity);
internal abstract int ColumnIndex(SQLiteStatement stmt, string columnName);
internal abstract string ColumnOriginalName(SQLiteStatement stmt, int index);
internal abstract string ColumnDatabaseName(SQLiteStatement stmt, int index);
internal abstract string ColumnTableName(SQLiteStatement stmt, int index);
internal abstract void ColumnMetaData(string dataBase, string table, string column, ref string dataType, ref string collateSequence, ref bool notNull, ref bool primaryKey, ref bool autoIncrement);
internal abstract void GetIndexColumnExtendedInfo(string database, string index, string column, ref int sortMode, ref int onError, ref string collationSequence);
internal abstract object GetObject(SQLiteStatement stmt, int index);
internal abstract double GetDouble(SQLiteStatement stmt, int index);
internal abstract Boolean GetBoolean(SQLiteStatement stmt, int index);
internal abstract SByte GetSByte(SQLiteStatement stmt, int index);
internal abstract Byte GetByte(SQLiteStatement stmt, int index);
internal abstract Int16 GetInt16(SQLiteStatement stmt, int index);
internal abstract UInt16 GetUInt16(SQLiteStatement stmt, int index);
internal abstract Int32 GetInt32(SQLiteStatement stmt, int index);
internal abstract UInt32 GetUInt32(SQLiteStatement stmt, int index);
internal abstract Int64 GetInt64(SQLiteStatement stmt, int index);
internal abstract UInt64 GetUInt64(SQLiteStatement stmt, int index);
internal abstract string GetText(SQLiteStatement stmt, int index);
internal abstract long GetBytes(SQLiteStatement stmt, int index, int nDataoffset, byte[] bDest, int nStart, int nLength);
internal abstract char GetChar(SQLiteStatement stmt, int index);
internal abstract long GetChars(SQLiteStatement stmt, int index, int nDataoffset, char[] bDest, int nStart, int nLength);
internal abstract DateTime GetDateTime(SQLiteStatement stmt, int index);
internal abstract bool IsNull(SQLiteStatement stmt, int index);
internal abstract SQLiteErrorCode CreateCollation(string strCollation, SQLiteCollation func, SQLiteCollation func16, bool @throw);
internal abstract SQLiteErrorCode CreateFunction(string strFunction, int nArgs, bool needCollSeq, SQLiteCallback func, SQLiteCallback funcstep, SQLiteFinalCallback funcfinal, bool @throw);
internal abstract CollationSequence GetCollationSequence(SQLiteFunction func, IntPtr context);
internal abstract int ContextCollateCompare(CollationEncodingEnum enc, IntPtr context, string s1, string s2);
internal abstract int ContextCollateCompare(CollationEncodingEnum enc, IntPtr context, char[] c1, char[] c2);
internal abstract int AggregateCount(IntPtr context);
internal abstract IntPtr AggregateContext(IntPtr context);
internal abstract long GetParamValueBytes(IntPtr ptr, int nDataOffset, byte[] bDest, int nStart, int nLength);
internal abstract double GetParamValueDouble(IntPtr ptr);
internal abstract int GetParamValueInt32(IntPtr ptr);
internal abstract Int64 GetParamValueInt64(IntPtr ptr);
internal abstract string GetParamValueText(IntPtr ptr);
internal abstract TypeAffinity GetParamValueType(IntPtr ptr);
internal abstract void ReturnBlob(IntPtr context, byte[] value);
internal abstract void ReturnDouble(IntPtr context, double value);
internal abstract void ReturnError(IntPtr context, string value);
internal abstract void ReturnInt32(IntPtr context, Int32 value);
internal abstract void ReturnInt64(IntPtr context, Int64 value);
internal abstract void ReturnNull(IntPtr context);
internal abstract void ReturnText(IntPtr context, string value);
#if INTEROP_VIRTUAL_TABLE
/// <summary>
/// Calls the native SQLite core library in order to create a disposable
/// module containing the implementation of a virtual table.
/// </summary>
/// <param name="module">
/// The module object to be used when creating the native disposable module.
/// </param>
/// <param name="flags">
/// The flags for the associated <see cref="SQLiteConnection" /> object instance.
/// </param>
internal abstract void CreateModule(SQLiteModule module, SQLiteConnectionFlags flags);
/// <summary>
/// Calls the native SQLite core library in order to cleanup the resources
/// associated with a module containing the implementation of a virtual table.
/// </summary>
/// <param name="module">
/// The module object previously passed to the <see cref="CreateModule" />
/// method.
/// </param>
/// <param name="flags">
/// The flags for the associated <see cref="SQLiteConnection" /> object instance.
/// </param>
internal abstract void DisposeModule(SQLiteModule module, SQLiteConnectionFlags flags);
/// <summary>
/// Calls the native SQLite core library in order to declare a virtual table
/// in response to a call into the <see cref="ISQLiteNativeModule.xCreate" />
/// or <see cref="ISQLiteNativeModule.xConnect" /> virtual table methods.
/// </summary>
/// <param name="module">
/// The virtual table module that is to be responsible for the virtual table
/// being declared.
/// </param>
/// <param name="strSql">
/// The string containing the SQL statement describing the virtual table to
/// be declared.
/// </param>
/// <param name="error">
/// Upon success, the contents of this parameter are undefined. Upon failure,
/// it should contain an appropriate error message.
/// </param>
/// <returns>
/// A standard SQLite return code.
/// </returns>
internal abstract SQLiteErrorCode DeclareVirtualTable(SQLiteModule module, string strSql, ref string error);
/// <summary>
/// Calls the native SQLite core library in order to declare a virtual table
/// function in response to a call into the <see cref="ISQLiteNativeModule.xCreate" />
/// or <see cref="ISQLiteNativeModule.xConnect" /> virtual table methods.
/// </summary>
/// <param name="module">
/// The virtual table module that is to be responsible for the virtual table
/// function being declared.
/// </param>
/// <param name="argumentCount">
/// The number of arguments to the function being declared.
/// </param>
/// <param name="name">
/// The name of the function being declared.
/// </param>
/// <param name="error">
/// Upon success, the contents of this parameter are undefined. Upon failure,
/// it should contain an appropriate error message.
/// </param>
/// <returns>
/// A standard SQLite return code.
/// </returns>
internal abstract SQLiteErrorCode DeclareVirtualFunction(SQLiteModule module, int argumentCount, string name, ref string error);
#endif
/// <summary>
/// Enables or disables a configuration option for the database.
/// connection.
/// </summary>
/// <param name="option">
/// The database configuration option to enable or disable.
/// </param>
/// <param name="bOnOff">
/// True to enable loading of extensions, false to disable.
/// </param>
/// <returns>
/// A standard SQLite return code.
/// </returns>
internal abstract SQLiteErrorCode SetConfigurationOption(SQLiteConfigDbOpsEnum option, bool bOnOff);
/// <summary>
/// Enables or disables extension loading by SQLite.
/// </summary>
/// <param name="bOnOff">
/// True to enable loading of extensions, false to disable.
/// </param>
internal abstract void SetLoadExtension(bool bOnOff);
/// <summary>
/// Loads a SQLite extension library from the named file.
/// </summary>
/// <param name="fileName">
/// The name of the dynamic link library file containing the extension.
/// </param>
/// <param name="procName">
/// The name of the exported function used to initialize the extension.
/// If null, the default "sqlite3_extension_init" will be used.
/// </param>
internal abstract void LoadExtension(string fileName, string procName);
/// <summary>
/// Enables or disabled extened result codes returned by SQLite
/// </summary>
/// <param name="bOnOff">true to enable extended result codes, false to disable.</param>
/// <returns></returns>
internal abstract void SetExtendedResultCodes(bool bOnOff);
/// <summary>
/// Returns the numeric result code for the most recent failed SQLite API call
/// associated with the database connection.
/// </summary>
/// <returns>Result code</returns>
internal abstract SQLiteErrorCode ResultCode();
/// <summary>
/// Returns the extended numeric result code for the most recent failed SQLite API call
/// associated with the database connection.
/// </summary>
/// <returns>Extended result code</returns>
internal abstract SQLiteErrorCode ExtendedResultCode();
/// <summary>
/// Add a log message via the SQLite sqlite3_log interface.
/// </summary>
/// <param name="iErrCode">Error code to be logged with the message.</param>
/// <param name="zMessage">String to be logged. Unlike the SQLite sqlite3_log()
/// interface, this should be pre-formatted. Consider using the
/// String.Format() function.</param>
/// <returns></returns>
internal abstract void LogMessage(SQLiteErrorCode iErrCode, string zMessage);
#if INTEROP_CODEC || INTEROP_INCLUDE_SEE
internal abstract void SetPassword(byte[] passwordBytes);
internal abstract void ChangePassword(byte[] newPasswordBytes);
#endif
internal abstract void SetProgressHook(int nOps, SQLiteProgressCallback func);
internal abstract void SetAuthorizerHook(SQLiteAuthorizerCallback func);
internal abstract void SetUpdateHook(SQLiteUpdateCallback func);
internal abstract void SetCommitHook(SQLiteCommitCallback func);
internal abstract void SetTraceCallback(SQLiteTraceCallback func);
internal abstract void SetRollbackHook(SQLiteRollbackCallback func);
internal abstract SQLiteErrorCode SetLogCallback(SQLiteLogCallback func);
/// <summary>
/// Checks if the SQLite core library has been initialized in the current process.
/// </summary>
/// <returns>
/// Non-zero if the SQLite core library has been initialized in the current process,
/// zero otherwise.
/// </returns>
internal abstract bool IsInitialized();
internal abstract int GetCursorForTable(SQLiteStatement stmt, int database, int rootPage);
internal abstract long GetRowIdForCursor(SQLiteStatement stmt, int cursor);
internal abstract object GetValue(SQLiteStatement stmt, SQLiteConnectionFlags flags, int index, SQLiteType typ);
/// <summary>
/// Returns non-zero if the given database connection is in autocommit mode.
/// Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN
/// statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK.
/// </summary>
internal abstract bool AutoCommit
{
get;
}
internal abstract SQLiteErrorCode FileControl(string zDbName, int op, IntPtr pArg);
/// <summary>
/// Creates a new SQLite backup object based on the provided destination
/// database connection. The source database connection is the one
/// associated with this object. The source and destination database
/// connections cannot be the same.
/// </summary>
/// <param name="destCnn">The destination database connection.</param>
/// <param name="destName">The destination database name.</param>
/// <param name="sourceName">The source database name.</param>
/// <returns>The newly created backup object.</returns>
internal abstract SQLiteBackup InitializeBackup(
SQLiteConnection destCnn, string destName,
string sourceName);
/// <summary>
/// Copies up to N pages from the source database to the destination
/// database associated with the specified backup object.
/// </summary>
/// <param name="backup">The backup object to use.</param>
/// <param name="nPage">
/// The number of pages to copy or negative to copy all remaining pages.
/// </param>
/// <param name="retry">
/// Set to true if the operation needs to be retried due to database
/// locking issues.
/// </param>
/// <returns>
/// True if there are more pages to be copied, false otherwise.
/// </returns>
internal abstract bool StepBackup(SQLiteBackup backup, int nPage, ref bool retry);
/// <summary>
/// Returns the number of pages remaining to be copied from the source
/// database to the destination database associated with the specified
/// backup object.
/// </summary>
/// <param name="backup">The backup object to check.</param>
/// <returns>The number of pages remaining to be copied.</returns>
internal abstract int RemainingBackup(SQLiteBackup backup);
/// <summary>
/// Returns the total number of pages in the source database associated
/// with the specified backup object.
/// </summary>
/// <param name="backup">The backup object to check.</param>
/// <returns>The total number of pages in the source database.</returns>
internal abstract int PageCountBackup(SQLiteBackup backup);
/// <summary>
/// Destroys the backup object, rolling back any backup that may be in
/// progess.
/// </summary>
/// <param name="backup">The backup object to destroy.</param>
internal abstract void FinishBackup(SQLiteBackup backup);
///////////////////////////////////////////////////////////////////////////////////////////////
#region IDisposable Members
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
#endregion
///////////////////////////////////////////////////////////////////////////////////////////////
#region IDisposable "Pattern" Members
private bool disposed;
private void CheckDisposed() /* throw */
{
#if THROW_ON_DISPOSED
if (disposed)
throw new ObjectDisposedException(typeof(SQLiteBase).Name);
#endif
}
///////////////////////////////////////////////////////////////////////////////////////////////
protected virtual void Dispose(bool disposing)
{
if (!disposed)
{
//if (disposing)
//{
// ////////////////////////////////////
// // dispose managed resources here...
// ////////////////////////////////////
//}
//////////////////////////////////////
// release unmanaged resources here...
//////////////////////////////////////
disposed = true;
}
}
#endregion
///////////////////////////////////////////////////////////////////////////////////////////////
#region Destructor
~SQLiteBase()
{
Dispose(false);
}
#endregion
///////////////////////////////////////////////////////////////////////////////////////////////
// These statics are here for lack of a better place to put them.
// They exist here because they are called during the finalization of
// a SQLiteStatementHandle, SQLiteConnectionHandle, and SQLiteFunctionCookieHandle.
// Therefore these functions have to be static, and have to be low-level.
///////////////////////////////////////////////////////////////////////////////////////////////
private static string[] _errorMessages = {
/* SQLITE_OK */ "not an error",
/* SQLITE_ERROR */ "SQL logic error or missing database",
/* SQLITE_INTERNAL */ "internal logic error",
/* SQLITE_PERM */ "access permission denied",
/* SQLITE_ABORT */ "callback requested query abort",
/* SQLITE_BUSY */ "database is locked",
/* SQLITE_LOCKED */ "database table is locked",
/* SQLITE_NOMEM */ "out of memory",
/* SQLITE_READONLY */ "attempt to write a readonly database",
/* SQLITE_INTERRUPT */ "interrupted",
/* SQLITE_IOERR */ "disk I/O error",
/* SQLITE_CORRUPT */ "database disk image is malformed",
/* SQLITE_NOTFOUND */ "unknown operation",
/* SQLITE_FULL */ "database or disk is full",
/* SQLITE_CANTOPEN */ "unable to open database file",
/* SQLITE_PROTOCOL */ "locking protocol",
/* SQLITE_EMPTY */ "table contains no data",
/* SQLITE_SCHEMA */ "database schema has changed",
/* SQLITE_TOOBIG */ "string or blob too big",
/* SQLITE_CONSTRAINT */ "constraint failed",
/* SQLITE_MISMATCH */ "datatype mismatch",
/* SQLITE_MISUSE */ "library routine called out of sequence",
/* SQLITE_NOLFS */ "large file support is disabled",
/* SQLITE_AUTH */ "authorization denied",
/* SQLITE_FORMAT */ "auxiliary database format error",
/* SQLITE_RANGE */ "bind or column index out of range",
/* SQLITE_NOTADB */ "file is encrypted or is not a database",
/* SQLITE_NOTICE */ "notification message",
/* SQLITE_WARNING */ "warning message"
};
///////////////////////////////////////////////////////////////////////////////////////////////
/// <summary>
/// Returns the error message for the specified SQLite return code using
/// the internal static lookup table.
/// </summary>
/// <param name="rc">The SQLite return code.</param>
/// <returns>The error message or null if it cannot be found.</returns>
protected static string FallbackGetErrorString(SQLiteErrorCode rc)
{
if (_errorMessages == null)
return null;
int index = (int)rc;
if ((index < 0) || (index >= _errorMessages.Length))
index = (int)SQLiteErrorCode.Error; /* Make into generic error. */
return _errorMessages[index];
}
internal static string GetLastError(SQLiteConnectionHandle hdl, IntPtr db)
{
if ((hdl == null) || (db == IntPtr.Zero))
return "null connection or database handle";
string result = null;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
if (!hdl.IsInvalid && !hdl.IsClosed)
{
#if !SQLITE_STANDARD
int len = 0;
result = UTF8ToString(UnsafeNativeMethods.sqlite3_errmsg_interop(db, ref len), len);
#else
result = UTF8ToString(UnsafeNativeMethods.sqlite3_errmsg(db), -1);
#endif
}
else
{
result = "closed or invalid connection handle";
}
}
}
GC.KeepAlive(hdl);
return result;
}
internal static void FinishBackup(SQLiteConnectionHandle hdl, IntPtr backup)
{
if ((hdl == null) || (backup == IntPtr.Zero)) return;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
#if !SQLITE_STANDARD
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_backup_finish_interop(backup);
#else
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_backup_finish(backup);
#endif
if (n != SQLiteErrorCode.Ok) throw new SQLiteException(n, null);
}
}
}
internal static void CloseBlob(SQLiteConnectionHandle hdl, IntPtr blob)
{
if ((hdl == null) || (blob == IntPtr.Zero)) return;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
#if !SQLITE_STANDARD
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_blob_close_interop(blob);
#else
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_blob_close(blob);
#endif
if (n != SQLiteErrorCode.Ok) throw new SQLiteException(n, null);
}
}
}
internal static void FinalizeStatement(SQLiteConnectionHandle hdl, IntPtr stmt)
{
if ((hdl == null) || (stmt == IntPtr.Zero)) return;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
#if !SQLITE_STANDARD
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_finalize_interop(stmt);
#else
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_finalize(stmt);
#endif
if (n != SQLiteErrorCode.Ok) throw new SQLiteException(n, null);
}
}
}
internal static void CloseConnection(SQLiteConnectionHandle hdl, IntPtr db)
{
if ((hdl == null) || (db == IntPtr.Zero)) return;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
#if !SQLITE_STANDARD
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_close_interop(db);
#else
ResetConnection(hdl, db, false);
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_close(db);
#endif
if (n != SQLiteErrorCode.Ok) throw new SQLiteException(n, GetLastError(hdl, db));
}
}
}
#if !INTEROP_LEGACY_CLOSE
internal static void CloseConnectionV2(SQLiteConnectionHandle hdl, IntPtr db)
{
if ((hdl == null) || (db == IntPtr.Zero)) return;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
#if !SQLITE_STANDARD
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_close_interop(db);
#else
ResetConnection(hdl, db, false);
SQLiteErrorCode n = UnsafeNativeMethods.sqlite3_close_v2(db);
#endif
if (n != SQLiteErrorCode.Ok) throw new SQLiteException(n, GetLastError(hdl, db));
}
}
}
#endif
internal static bool ResetConnection(SQLiteConnectionHandle hdl, IntPtr db, bool canThrow)
{
if ((hdl == null) || (db == IntPtr.Zero)) return false;
bool result = false;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
if (canThrow && hdl.IsInvalid)
throw new InvalidOperationException("The connection handle is invalid.");
if (canThrow && hdl.IsClosed)
throw new InvalidOperationException("The connection handle is closed.");
if (!hdl.IsInvalid && !hdl.IsClosed)
{
IntPtr stmt = IntPtr.Zero;
SQLiteErrorCode n;
do
{
stmt = UnsafeNativeMethods.sqlite3_next_stmt(db, stmt);
if (stmt != IntPtr.Zero)
{
#if !SQLITE_STANDARD
n = UnsafeNativeMethods.sqlite3_reset_interop(stmt);
#else
n = UnsafeNativeMethods.sqlite3_reset(stmt);
#endif
}
} while (stmt != IntPtr.Zero);
//
// NOTE: Is a transaction NOT pending on the connection?
//
if (IsAutocommit(hdl, db))
{
result = true;
}
else
{
n = UnsafeNativeMethods.sqlite3_exec(
db, ToUTF8("ROLLBACK"), IntPtr.Zero, IntPtr.Zero,
ref stmt);
if (n == SQLiteErrorCode.Ok)
{
result = true;
}
else if (canThrow)
{
throw new SQLiteException(n, GetLastError(hdl, db));
}
}
}
}
}
GC.KeepAlive(hdl);
return result;
}
internal static bool IsAutocommit(SQLiteConnectionHandle hdl, IntPtr db)
{
if ((hdl == null) || (db == IntPtr.Zero)) return false;
bool result = false;
try
{
// do nothing.
}
finally /* NOTE: Thread.Abort() protection. */
{
#if PLATFORM_COMPACTFRAMEWORK
lock (hdl.syncRoot)
#else
lock (hdl)
#endif
{
if (!hdl.IsInvalid && !hdl.IsClosed)
result = (UnsafeNativeMethods.sqlite3_get_autocommit(db) == 1);
}
}
GC.KeepAlive(hdl); /* NOTE: Unreachable code. */
return result;
}
}
/// <summary>
///
/// </summary>
public interface ISQLiteSchemaExtensions
{
/// <summary>
/// Creates temporary tables on the connection so schema information can be queried.
/// </summary>
/// <param name="connection">
/// The connection upon which to build the schema tables.
/// </param>
void BuildTempSchema(SQLiteConnection connection);
}
[Flags]
internal enum SQLiteOpenFlagsEnum
{
None = 0,
ReadOnly = 0x1,
ReadWrite = 0x2,
Create = 0x4,
Uri = 0x40,
Memory = 0x80,
Default = ReadWrite | Create,
}
/// <summary>
/// The extra behavioral flags that can be applied to a connection.
/// </summary>
[Flags()]
public enum SQLiteConnectionFlags : long
{
/// <summary>
/// No extra flags.
/// </summary>
None = 0x0,
/// <summary>
/// Enable logging of all SQL statements to be prepared.
/// </summary>
LogPrepare = 0x1,
/// <summary>
/// Enable logging of all bound parameter types and raw values.
/// </summary>
LogPreBind = 0x2,
/// <summary>
/// Enable logging of all bound parameter strongly typed values.
/// </summary>
LogBind = 0x4,
/// <summary>
/// Enable logging of all exceptions caught from user-provided
/// managed code called from native code via delegates.
/// </summary>
LogCallbackException = 0x8,
/// <summary>
/// Enable logging of backup API errors.
/// </summary>
LogBackup = 0x10,
/// <summary>
/// Skip adding the extension functions provided by the native
/// interop assembly.
/// </summary>
NoExtensionFunctions = 0x20,
/// <summary>
/// When binding parameter values with the <see cref="UInt32" />
/// type, use the interop method that accepts an <see cref="Int64" />
/// value.
/// </summary>
BindUInt32AsInt64 = 0x40,
/// <summary>
/// When binding parameter values, always bind them as though they were
/// plain text (i.e. no numeric, date/time, or other conversions should
/// be attempted).
/// </summary>
BindAllAsText = 0x80,