forked from brian8544/Honorbuddy-434
-
Notifications
You must be signed in to change notification settings - Fork 0
/
System.Data.SQLite.xml
3634 lines (3629 loc) · 177 KB
/
System.Data.SQLite.xml
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
<?xml version="1.0"?>
<doc>
<members>
<member name="F:System.Data.SQLite.SQLiteConnectionPool._connections">
<summary>
The connection pool object
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnectionPool._poolVersion">
<summary>
The default version number new pools will get
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnectionPool.Remove(System.String,System.Int32,System.Int32@)">
<summary>
Attempt to pull a pooled connection out of the queue for active duty
</summary>
<param name="fileName">The filename for a desired connection</param>
<param name="maxPoolSize">The maximum size the connection pool for the filename can be</param>
<param name="version">The pool version the returned connection will belong to</param>
<returns>Returns NULL if no connections were available. Even if none are, the poolversion will still be a valid pool version</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearAllPools">
<summary>
Clears out all pooled connections and rev's up the default pool version to force all old active objects
not in the pool to get discarded rather than returned to their pools.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnectionPool.ClearPool(System.String)">
<summary>
Clear a given pool for a given filename. Discards anything in the pool for the given file, and revs the pool
version so current active objects on the old version of the pool will get discarded rather than be returned to the pool.
</summary>
<param name="fileName">The filename of the pool to clear</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnectionPool.Add(System.String,System.Data.SQLite.SQLiteConnectionHandle,System.Int32)">
<summary>
Return a connection to the pool for someone else to use.
</summary>
<param name="fileName">The filename of the pool to use</param>
<param name="hdl">The connection handle to pool</param>
<param name="version">The pool version the handle was created under</param>
<remarks>
If the version numbers don't match between the connection and the pool, then the handle is discarded.
</remarks>
</member>
<member name="M:System.Data.SQLite.SQLiteConnectionPool.ResizePool(System.Data.SQLite.SQLiteConnectionPool.Pool,System.Boolean)">
<summary>
We don't have to thread-lock anything in this function, because it's only called by other functions above
which already have a thread-safe lock.
</summary>
<param name="queue">The queue to resize</param>
<param name="forAdding">If a function intends to add to the pool, this is true, which forces the resize
to take one more than it needs from the pool</param>
</member>
<member name="T:System.Data.SQLite.SQLiteConnectionPool.Pool">
<summary>
Keeps track of connections made on a specified file. The PoolVersion dictates whether old objects get
returned to the pool or discarded when no longer in use.
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteConnection">
<summary>
SQLite implentation of DbConnection.
</summary>
<remarks>
The <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString">ConnectionString</see> property of the SQLiteConnection class can contain the following parameter(s), delimited with a semi-colon:
<list type="table">
<listheader>
<term>Parameter</term>
<term>Values</term>
<term>Required</term>
<term>Default</term>
</listheader>
<item>
<description>Data Source</description>
<description>{filename}</description>
<description>Y</description>
<description></description>
</item>
<item>
<description>Version</description>
<description>3</description>
<description>N</description>
<description>3</description>
</item>
<item>
<description>UseUTF16Encoding</description>
<description><b>True</b><br/><b>False</b></description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>DateTimeFormat</description>
<description><b>Ticks</b> - Use DateTime.Ticks<br/><b>ISO8601</b> - Use ISO8601 DateTime format</description>
<description>N</description>
<description>ISO8601</description>
</item>
<item>
<description>BinaryGUID</description>
<description><b>True</b> - Store GUID columns in binary form<br/><b>False</b> - Store GUID columns as text</description>
<description>N</description>
<description>True</description>
</item>
<item>
<description>Cache Size</description>
<description>{size in bytes}</description>
<description>N</description>
<description>2000</description>
</item>
<item>
<description>Synchronous</description>
<description><b>Normal</b> - Normal file flushing behavior<br/><b>Full</b> - Full flushing after all writes<br/><b>Off</b> - Underlying OS flushes I/O's</description>
<description>N</description>
<description>Normal</description>
</item>
<item>
<description>Page Size</description>
<description>{size in bytes}</description>
<description>N</description>
<description>1024</description>
</item>
<item>
<description>Password</description>
<description>{password}</description>
<description>N</description>
<description></description>
</item>
<item>
<description>Enlist</description>
<description><b>Y</b> - Automatically enlist in distributed transactions<br/><b>N</b> - No automatic enlistment</description>
<description>N</description>
<description>Y</description>
</item>
<item>
<description>Pooling</description>
<description><b>True</b> - Use connection pooling<br/><b>False</b> - Do not use connection pooling</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>FailIfMissing</description>
<description><b>True</b> - Don't create the database if it does not exist, throw an error instead<br/><b>False</b> - Automatically create the database if it does not exist</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>Max Page Count</description>
<description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description>
<description>N</description>
<description>0</description>
</item>
<item>
<description>Legacy Format</description>
<description><b>True</b> - Use the more compatible legacy 3.x database format<br/><b>False</b> - Use the newer 3.3x database format which compresses numbers more effectively</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>Default Timeout</description>
<description>{time in seconds}<br/>The default command timeout</description>
<description>N</description>
<description>30</description>
</item>
<item>
<description>Journal Mode</description>
<description><b>Delete</b> - Delete the journal file after a commit<br/><b>Persist</b> - Zero out and leave the journal file on disk after a commit<br/><b>Off</b> - Disable the rollback journal entirely</description>
<description>N</description>
<description>Delete</description>
</item>
<item>
<description>Read Only</description>
<description><b>True</b> - Open the database for read only access<br/><b>False</b> - Open the database for normal read/write access</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>Max Pool Size</description>
<description>The maximum number of connections for the given connection string that can be in the connection pool</description>
<description>N</description>
<description>100</description>
</item>
<item>
<description>Default IsolationLevel</description>
<description>The default transaciton isolation level</description>
<description>N</description>
<description>Serializable</description>
</item>
</list>
</remarks>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._connectionState">
<summary>
State of the current connection
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._connectionString">
<summary>
The connection string
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._transactionLevel">
<summary>
Nesting level of the transactions open on the connection
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._defaultIsolation">
<summary>
The default isolation level for new transactions
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._enlistment">
<summary>
Whether or not the connection is enlisted in a distrubuted transaction
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._sql">
<summary>
The base SQLite object to interop with
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._dataSource">
<summary>
The database filename minus path and extension
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._password">
<summary>
Temporary password storage, emptied after the database has been opened
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConnection._defaultTimeout">
<summary>
Default command timeout
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor">
<overloads>
Constructs a new SQLiteConnection object
</overloads>
<summary>
Default constructor
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.String)">
<summary>
Initializes the connection with the specified connection string
</summary>
<param name="connectionString">The connection string to use on the connection</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.#ctor(System.Data.SQLite.SQLiteConnection)">
<summary>
Clones the settings and connection string from an existing connection. If the existing connection is already open, this
function will open its own connection, enumerate any attached databases of the original connection, and automatically
attach to them.
</summary>
<param name="connection"></param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Clone">
<summary>
Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection
will also be opened.
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Dispose(System.Boolean)">
<summary>
Disposes of the SQLiteConnection, closing it if it is active.
</summary>
<param name="disposing">True if the connection is being explicitly closed.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.CreateFile(System.String)">
<summary>
Creates a database file. This just creates a zero-byte file which SQLite
will turn into a database when the file is opened properly.
</summary>
<param name="databaseFileName">The file to create</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.OnStateChange(System.Data.ConnectionState)">
<summary>
Raises the state change event when the state of the connection changes
</summary>
<param name="newState">The new state. If it is different from the previous state, an event is raised.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel,System.Boolean)">
<summary>
OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection.
</summary>
<param name="isolationLevel">This parameter is ignored.</param>
<param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested.
When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer
environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param>
<returns>Returns a SQLiteTransaction object.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Boolean)">
<summary>
OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection.
</summary>
<param name="deferredLock">When TRUE, SQLite defers obtaining a write lock until a write operation is requested.
When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer
environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock.</param>
<returns>Returns a SQLiteTransaction object.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction(System.Data.IsolationLevel)">
<summary>
Creates a new SQLiteTransaction if one isn't already active on the connection.
</summary>
<param name="isolationLevel">Supported isolation levels are Serializable, ReadCommitted and Unspecified.</param>
<remarks>
Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the
connection string, Serializable is used.
Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads
may begin a transaction. Other threads may read from the database, but not write.
With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start
a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread
has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached.
</remarks>
<returns>Returns a SQLiteTransaction object.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.BeginTransaction">
<summary>
Creates a new SQLiteTransaction if one isn't already active on the connection.
</summary>
<returns>Returns a SQLiteTransaction object.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.BeginDbTransaction(System.Data.IsolationLevel)">
<summary>
Forwards to the local BeginTransaction() function
</summary>
<param name="isolationLevel">Supported isolation levels are Unspecified, Serializable, and ReadCommitted</param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ChangeDatabase(System.String)">
<summary>
Not implemented
</summary>
<param name="databaseName"></param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Close">
<summary>
When the database connection is closed, all commands linked to this connection are automatically reset.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ClearPool(System.Data.SQLite.SQLiteConnection)">
<summary>
Clears the connection pool associated with the connection. Any other active connections using the same database file
will be discarded instead of returned to the pool when they are closed.
</summary>
<param name="connection"></param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ClearAllPools">
<summary>
Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.CreateCommand">
<summary>
Create a new SQLiteCommand and associate it with this connection.
</summary>
<returns>Returns an instantiated SQLiteCommand object already assigned to this connection.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.CreateDbCommand">
<summary>
Forwards to the local CreateCommand() function
</summary>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ParseConnectionString(System.String)">
<summary>
Parses the connection string into component parts
</summary>
<param name="connectionString">The connection string to parse</param>
<returns>An array of key-value pairs representing each parameter of the connection string</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.EnlistTransaction(System.Transactions.Transaction)">
<summary>
Manual distributed transaction enlistment support
</summary>
<param name="transaction">The distributed transaction to enlist in</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.FindKey(System.Collections.Generic.SortedList{System.String,System.String},System.String,System.String)">
<summary>
Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value
</summary>
<param name="items">The list to look in</param>
<param name="key">The key to find</param>
<param name="defValue">The default value to return if the key is not found</param>
<returns>The value corresponding to the specified key, or the default value if not found.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Open">
<summary>
Opens the connection using the parameters found in the <see cref="P:System.Data.SQLite.SQLiteConnection.ConnectionString">ConnectionString</see>
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.String)">
<summary>
Change the password (or assign a password) to an open database.
</summary>
<remarks>
No readers or writers may be active for this process. The database must already be open
and if it already was password protected, the existing password must already have been supplied.
</remarks>
<param name="newPassword">The new password to assign to the database</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ChangePassword(System.Byte[])">
<summary>
Change the password (or assign a password) to an open database.
</summary>
<remarks>
No readers or writers may be active for this process. The database must already be open
and if it already was password protected, the existing password must already have been supplied.
</remarks>
<param name="newPassword">The new password to assign to the database</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.String)">
<summary>
Sets the password for a password-protected database. A password-protected database is
unusable for any operation until the password has been set.
</summary>
<param name="databasePassword">The password for the database</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.SetPassword(System.Byte[])">
<summary>
Sets the password for a password-protected database. A password-protected database is
unusable for any operation until the password has been set.
</summary>
<param name="databasePassword">The password for the database</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.ExpandFileName(System.String)">
<summary>
Expand the filename of the data source, resolving the |DataDirectory| macro as appropriate.
</summary>
<param name="sourceFile">The database filename to expand</param>
<returns>The expanded path and filename of the filename</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.GetSchema">
<overloads>
The following commands are used to extract schema information out of the database. Valid schema types are:
<list type="bullet">
<item>
<description>MetaDataCollections</description>
</item>
<item>
<description>DataSourceInformation</description>
</item>
<item>
<description>Catalogs</description>
</item>
<item>
<description>Columns</description>
</item>
<item>
<description>ForeignKeys</description>
</item>
<item>
<description>Indexes</description>
</item>
<item>
<description>IndexColumns</description>
</item>
<item>
<description>Tables</description>
</item>
<item>
<description>Views</description>
</item>
<item>
<description>ViewColumns</description>
</item>
</list>
</overloads>
<summary>
Returns the MetaDataCollections schema
</summary>
<returns>A DataTable of the MetaDataCollections schema</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String)">
<summary>
Returns schema information of the specified collection
</summary>
<param name="collectionName">The schema collection to retrieve</param>
<returns>A DataTable of the specified collection</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.GetSchema(System.String,System.String[])">
<summary>
Retrieves schema information using the specified constraint(s) for the specified collection
</summary>
<param name="collectionName">The collection to retrieve</param>
<param name="restrictionValues">The restrictions to impose</param>
<returns>A DataTable of the specified collection</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_MetaDataCollections">
<summary>
Builds a MetaDataCollections schema datatable
</summary>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_DataSourceInformation">
<summary>
Builds a DataSourceInformation datatable
</summary>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Columns(System.String,System.String,System.String)">
<summary>
Build a Columns schema
</summary>
<param name="strCatalog">The catalog (attached database) to query, can be null</param>
<param name="strTable">The table to retrieve schema information for, must not be null</param>
<param name="strColumn">The column to retrieve schema information for, can be null</param>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Indexes(System.String,System.String,System.String)">
<summary>
Returns index information for the given database and catalog
</summary>
<param name="strCatalog">The catalog (attached database) to query, can be null</param>
<param name="strIndex">The name of the index to retrieve information for, can be null</param>
<param name="strTable">The table to retrieve index information for, can be null</param>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Tables(System.String,System.String,System.String)">
<summary>
Retrieves table schema information for the database and catalog
</summary>
<param name="strCatalog">The catalog (attached database) to retrieve tables on</param>
<param name="strTable">The table to retrieve, can be null</param>
<param name="strType">The table type, can be null</param>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Views(System.String,System.String)">
<summary>
Retrieves view schema information for the database
</summary>
<param name="strCatalog">The catalog (attached database) to retrieve views on</param>
<param name="strView">The view name, can be null</param>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_Catalogs(System.String)">
<summary>
Retrieves catalog (attached databases) schema information for the database
</summary>
<param name="strCatalog">The catalog to retrieve, can be null</param>
<returns>DataTable</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_IndexColumns(System.String,System.String,System.String,System.String)">
<summary>
Returns the base column information for indexes in a database
</summary>
<param name="strCatalog">The catalog to retrieve indexes for (can be null)</param>
<param name="strTable">The table to restrict index information by (can be null)</param>
<param name="strIndex">The index to restrict index information by (can be null)</param>
<param name="strColumn">The source column to restrict index information by (can be null)</param>
<returns>A DataTable containing the results</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_ViewColumns(System.String,System.String,System.String)">
<summary>
Returns detailed column information for a specified view
</summary>
<param name="strCatalog">The catalog to retrieve columns for (can be null)</param>
<param name="strView">The view to restrict column information by (can be null)</param>
<param name="strColumn">The source column to restrict column information by (can be null)</param>
<returns>A DataTable containing the results</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConnection.Schema_ForeignKeys(System.String,System.String,System.String)">
<summary>
Retrieves foreign key information from the specified set of filters
</summary>
<param name="strCatalog">An optional catalog to restrict results on</param>
<param name="strTable">An optional table to restrict results on</param>
<param name="strKeyName">An optional foreign key name to restrict results on</param>
<returns>A DataTable with the results of the query</returns>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.DbProviderFactory">
<summary>
Returns a SQLiteProviderFactory object.
</summary>
</member>
<member name="E:System.Data.SQLite.SQLiteConnection.StateChange">
<summary>
This event is raised whenever the database is opened or closed.
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.ConnectionString">
<summary>
The connection string containing the parameters for the connection
</summary>
<remarks>
<list type="table">
<listheader>
<term>Parameter</term>
<term>Values</term>
<term>Required</term>
<term>Default</term>
</listheader>
<item>
<description>Data Source</description>
<description>{filename}</description>
<description>Y</description>
<description></description>
</item>
<item>
<description>Version</description>
<description>3</description>
<description>N</description>
<description>3</description>
</item>
<item>
<description>UseUTF16Encoding</description>
<description><b>True</b><br/><b>False</b></description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>DateTimeFormat</description>
<description><b>Ticks</b> - Use DateTime.Ticks<br/><b>ISO8601</b> - Use ISO8601 DateTime format<br/><b>JulianDay</b> - Use JulianDay format</description>
<description>N</description>
<description>ISO8601</description>
</item>
<item>
<description>BinaryGUID</description>
<description><b>Yes/On/1</b> - Store GUID columns in binary form<br/><b>No/Off/0</b> - Store GUID columns as text</description>
<description>N</description>
<description>On</description>
</item>
<item>
<description>Cache Size</description>
<description>{size in bytes}</description>
<description>N</description>
<description>2000</description>
</item>
<item>
<description>Synchronous</description>
<description><b>Normal</b> - Normal file flushing behavior<br/><b>Full</b> - Full flushing after all writes<br/><b>Off</b> - Underlying OS flushes I/O's</description>
<description>N</description>
<description>Normal</description>
</item>
<item>
<description>Page Size</description>
<description>{size in bytes}</description>
<description>N</description>
<description>1024</description>
</item>
<item>
<description>Password</description>
<description>{password}</description>
<description>N</description>
<description></description>
</item>
<item>
<description>Enlist</description>
<description><B>Y</B> - Automatically enlist in distributed transactions<br/><b>N</b> - No automatic enlistment</description>
<description>N</description>
<description>Y</description>
</item>
<item>
<description>Pooling</description>
<description><b>True</b> - Use connection pooling<br/><b>False</b> - Do not use connection pooling</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>FailIfMissing</description>
<description><b>True</b> - Don't create the database if it does not exist, throw an error instead<br/><b>False</b> - Automatically create the database if it does not exist</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>Max Page Count</description>
<description>{size in pages} - Limits the maximum number of pages (limits the size) of the database</description>
<description>N</description>
<description>0</description>
</item>
<item>
<description>Legacy Format</description>
<description><b>True</b> - Use the more compatible legacy 3.x database format<br/><b>False</b> - Use the newer 3.3x database format which compresses numbers more effectively</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>Default Timeout</description>
<description>{time in seconds}<br/>The default command timeout</description>
<description>N</description>
<description>30</description>
</item>
<item>
<description>Journal Mode</description>
<description><b>Delete</b> - Delete the journal file after a commit<br/><b>Persist</b> - Zero out and leave the journal file on disk after a commit<br/><b>Off</b> - Disable the rollback journal entirely</description>
<description>N</description>
<description>Delete</description>
</item>
<item>
<description>Read Only</description>
<description><b>True</b> - Open the database for read only access<br/><b>False</b> - Open the database for normal read/write access</description>
<description>N</description>
<description>False</description>
</item>
<item>
<description>Max Pool Size</description>
<description>The maximum number of connections for the given connection string that can be in the connection pool</description>
<description>N</description>
<description>100</description>
</item>
<item>
<description>Default IsolationLevel</description>
<description>The default transaciton isolation level</description>
<description>N</description>
<description>Serializable</description>
</item>
</list>
</remarks>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.DataSource">
<summary>
Returns the filename without extension or path
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.Database">
<summary>
Returns an empty string
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.DefaultTimeout">
<summary>
Gets/sets the default command timeout for newly-created commands. This is especially useful for
commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible.
This can also be set in the ConnectionString with "Default Timeout"
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.ServerVersion">
<summary>
Returns the version of the underlying SQLite database engine
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.SQLiteVersion">
<summary>
Returns the version of the underlying SQLite database engine
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteConnection.State">
<summary>
Returns the state of the connection.
</summary>
</member>
<member name="E:System.Data.SQLite.SQLiteConnection.Update">
<summary>
This event is raised whenever SQLite makes an update/delete/insert into the database on
this connection. It only applies to the given connection.
</summary>
</member>
<member name="E:System.Data.SQLite.SQLiteConnection.Commit">
<summary>
This event is raised whenever SQLite is committing a transaction.
Return non-zero to trigger a rollback
</summary>
</member>
<member name="E:System.Data.SQLite.SQLiteConnection.RollBack">
<summary>
This event is raised whenever SQLite is committing a transaction.
Return non-zero to trigger a rollback
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteDataAdapter">
<summary>
SQLite implementation of DbDataAdapter.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor">
<overloads>
This class is just a shell around the DbDataAdapter. Nothing from DbDataAdapter is overridden here, just a few constructors are defined.
</overloads>
<summary>
Default constructor.
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.Data.SQLite.SQLiteCommand)">
<summary>
Constructs a data adapter using the specified select command.
</summary>
<param name="cmd">The select command to associate with the adapter.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.Data.SQLite.SQLiteConnection)">
<summary>
Constructs a data adapter with the supplied select command text and associated with the specified connection.
</summary>
<param name="commandText">The select command text to associate with the data adapter.</param>
<param name="connection">The connection to associate with the select command.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteDataAdapter.#ctor(System.String,System.String)">
<summary>
Constructs a data adapter with the specified select command text, and using the specified database connection string.
</summary>
<param name="commandText">The select command text to use to construct a select command.</param>
<param name="connectionString">A connection string suitable for passing to a new SQLiteConnection, which is associated with the select command.</param>
</member>
<member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)">
<summary>
Raised by the underlying DbDataAdapter when a row is being updated
</summary>
<param name="value">The event's specifics</param>
</member>
<member name="M:System.Data.SQLite.SQLiteDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)">
<summary>
Raised by DbDataAdapter after a row is updated
</summary>
<param name="value">The event's specifics</param>
</member>
<member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdating">
<summary>
Row updating event handler
</summary>
</member>
<member name="E:System.Data.SQLite.SQLiteDataAdapter.RowUpdated">
<summary>
Row updated event handler
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteDataAdapter.SelectCommand">
<summary>
Gets/sets the select command for this DataAdapter
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteDataAdapter.InsertCommand">
<summary>
Gets/sets the insert command for this DataAdapter
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteDataAdapter.UpdateCommand">
<summary>
Gets/sets the update command for this DataAdapter
</summary>
</member>
<member name="P:System.Data.SQLite.SQLiteDataAdapter.DeleteCommand">
<summary>
Gets/sets the delete command for this DataAdapter
</summary>
</member>
<member name="T:System.Data.SQLite.SQLiteConvert">
<summary>
This base class provides datatype conversion services for the SQLite provider.
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormats">
<summary>
An array of ISO8601 datetime formats we support conversion from
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._utf8">
<summary>
An UTF-8 Encoding instance, so we can convert strings to and from UTF-8
</summary>
</member>
<member name="F:System.Data.SQLite.SQLiteConvert._datetimeFormat">
<summary>
The default DateTime format for this instance
</summary>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.#ctor(System.Data.SQLite.SQLiteDateFormats)">
<summary>
Initializes the conversion class
</summary>
<param name="fmt">The default date/time format to use for this instance</param>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.String)">
<summary>
Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character.
</summary>
<param name="sourceText">The string to convert to UTF-8</param>
<returns>A byte array containing the converted string plus an extra 0 terminating byte at the end of the array.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToUTF8(System.DateTime)">
<summary>
Convert a DateTime to a UTF-8 encoded, zero-terminated byte array.
</summary>
<remarks>
This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the
string result.
</remarks>
<param name="dateTimeValue">The DateTime to convert.</param>
<returns>The UTF-8 encoded string, including a 0 terminating byte at the end of the array.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.IntPtr,System.Int32)">
<summary>
Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
</summary>
<param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
<param name="nativestringlen">The number of bytes to decode</param>
<returns>A string containing the translated character(s)</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.UTF8ToString(System.IntPtr,System.Int32)">
<summary>
Converts a UTF-8 encoded IntPtr of the specified length into a .NET string
</summary>
<param name="nativestring">The pointer to the memory where the UTF-8 string is encoded</param>
<param name="nativestringlen">The number of bytes to decode</param>
<returns>A string containing the translated character(s)</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.String)">
<summary>
Converts a string into a DateTime, using the current DateTimeFormat specified for the connection when it was opened.
</summary>
<remarks>
Acceptable ISO8601 DateTime formats are:
yyyy-MM-dd HH:mm:ss
yyyyMMddHHmmss
yyyyMMddTHHmmssfffffff
yyyy-MM-dd
yy-MM-dd
yyyyMMdd
HH:mm:ss
THHmmss
</remarks>
<param name="dateText">The string containing either a Tick value, a JulianDay double, or an ISO8601-format string</param>
<returns>A DateTime value</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.Double)">
<summary>
Converts a julianday value into a DateTime
</summary>
<param name="julianDay">The value to convert</param>
<returns>A .NET DateTime</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToJulianDay(System.DateTime)">
<summary>
Converts a DateTime struct to a JulianDay double
</summary>
<param name="value">The DateTime to convert</param>
<returns>The JulianDay value the Datetime represents</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToString(System.DateTime)">
<summary>
Converts a DateTime to a string value, using the current DateTimeFormat specified for the connection when it was opened.
</summary>
<param name="dateValue">The DateTime value to convert</param>
<returns>Either a string consisting of the tick count for DateTimeFormat.Ticks, a JulianDay double, or a date/time in ISO8601 format.</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToDateTime(System.IntPtr,System.Int32)">
<summary>
Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime.
</summary>
<remarks>
This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls
ToDateTime() on the string to return a DateTime.
</remarks>
<param name="ptr">A pointer to the UTF-8 encoded string</param>
<param name="len">The length in bytes of the string</param>
<returns>The parsed DateTime value</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.Split(System.String,System.Char)">
<summary>
Smart method of splitting a string. Skips quoted elements, removes the quotes.
</summary>
<remarks>
This split function works somewhat like the String.Split() function in that it breaks apart a string into
pieces and returns the pieces as an array. The primary differences are:
<list type="bullet">
<item><description>Only one character can be provided as a separator character</description></item>
<item><description>Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed.</description></item>
</list>
Thus, if splitting the following string looking for a comma:<br/>
One,Two, "Three, Four", Five<br/>
<br/>
The resulting array would contain<br/>
[0] One<br/>
[1] Two<br/>
[2] Three, Four<br/>
[3] Five<br/>
<br/>
Note that the leading and trailing spaces were removed from each item during the split.
</remarks>
<param name="source">Source string to split apart</param>
<param name="separator">Separator character</param>
<returns>A string array of the split up elements</returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.Object)">
<summary>
Convert a value to true or false.
</summary>
<param name="source">A string or number representing true or false</param>
<returns></returns>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ToBoolean(System.String)">
<summary>
Convert a string to true or false.
</summary>
<param name="source">A string representing true or false</param>
<returns></returns>
<remarks>
"yes", "no", "y", "n", "0", "1", "on", "off" as well as Boolean.FalseString and Boolean.TrueString will all be
converted to a proper boolean value.
</remarks>
</member>
<member name="M:System.Data.SQLite.SQLiteConvert.ColumnToType(System.Data.SQLite.SQLiteStatement,System.Int32,System.Data.SQLite.SQLiteType)">
<summary>
Determines the data type of a column in a statement
</summary>
<param name="stmt">The statement to retrieve information for</param>
<param name="i">The column to retrieve type information on</param>
<param name="typ">The SQLiteType to receive the affinity for the given column</param>
</member>