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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>APSW Module — APSW 3.46.0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=72bcf2f2" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/apsw.css?v=3c7e2631" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=d98f5d2b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="Connections to a database" href="connection.html" />
<link rel="prev" title="Extensions" href="extensions.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
APSW
<img src="_static/apswlogo.png" class="logo" alt="Logo"/>
</a>
<div class="version">
3.46.0.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
<li class="toctree-l1"><a class="reference internal" href="tips.html">Tips</a></li>
<li class="toctree-l1"><a class="reference internal" href="example.html">Example/Tour</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation and customization</a></li>
<li class="toctree-l1"><a class="reference internal" href="extensions.html">Extensions</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">APSW Module</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#type-annotations">Type Annotations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apsw.SQLiteValue"><code class="docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.SQLiteValues"><code class="docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.Bindings"><code class="docutils literal notranslate"><span class="pre">Bindings</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.AggregateT"><code class="docutils literal notranslate"><span class="pre">AggregateT</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.AggregateStep"><code class="docutils literal notranslate"><span class="pre">AggregateStep</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.AggregateFinal"><code class="docutils literal notranslate"><span class="pre">AggregateFinal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.AggregateFactory"><code class="docutils literal notranslate"><span class="pre">AggregateFactory</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ScalarProtocol"><code class="docutils literal notranslate"><span class="pre">ScalarProtocol</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.WindowT"><code class="docutils literal notranslate"><span class="pre">WindowT</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.WindowStep"><code class="docutils literal notranslate"><span class="pre">WindowStep</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.WindowFinal"><code class="docutils literal notranslate"><span class="pre">WindowFinal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.WindowValue"><code class="docutils literal notranslate"><span class="pre">WindowValue</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.WindowInverse"><code class="docutils literal notranslate"><span class="pre">WindowInverse</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.WindowFactory"><code class="docutils literal notranslate"><span class="pre">WindowFactory</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.RowTracer"><code class="docutils literal notranslate"><span class="pre">RowTracer</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ExecTracer"><code class="docutils literal notranslate"><span class="pre">ExecTracer</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.Authorizer"><code class="docutils literal notranslate"><span class="pre">Authorizer</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.CommitHook"><code class="docutils literal notranslate"><span class="pre">CommitHook</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#api-reference">API Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apsw.SQLITE_VERSION_NUMBER"><code class="docutils literal notranslate"><span class="pre">SQLITE_VERSION_NUMBER</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.allow_missing_dict_bindings"><code class="docutils literal notranslate"><span class="pre">allow_missing_dict_bindings()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.apsw_version"><code class="docutils literal notranslate"><span class="pre">apsw_version()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.compile_options"><code class="docutils literal notranslate"><span class="pre">compile_options</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.complete"><code class="docutils literal notranslate"><span class="pre">complete()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.config"><code class="docutils literal notranslate"><span class="pre">config()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.connection_hooks"><code class="docutils literal notranslate"><span class="pre">connection_hooks</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.connections"><code class="docutils literal notranslate"><span class="pre">connections()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.enable_shared_cache"><code class="docutils literal notranslate"><span class="pre">enable_shared_cache()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.exception_for"><code class="docutils literal notranslate"><span class="pre">exception_for()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.fork_checker"><code class="docutils literal notranslate"><span class="pre">fork_checker()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.format_sql_value"><code class="docutils literal notranslate"><span class="pre">format_sql_value()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.hard_heap_limit"><code class="docutils literal notranslate"><span class="pre">hard_heap_limit()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.initialize"><code class="docutils literal notranslate"><span class="pre">initialize()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.keywords"><code class="docutils literal notranslate"><span class="pre">keywords</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.log"><code class="docutils literal notranslate"><span class="pre">log()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.memory_high_water"><code class="docutils literal notranslate"><span class="pre">memory_high_water()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.memory_used"><code class="docutils literal notranslate"><span class="pre">memory_used()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.no_change"><code class="docutils literal notranslate"><span class="pre">no_change</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.randomness"><code class="docutils literal notranslate"><span class="pre">randomness()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.release_memory"><code class="docutils literal notranslate"><span class="pre">release_memory()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.set_default_vfs"><code class="docutils literal notranslate"><span class="pre">set_default_vfs()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.shutdown"><code class="docutils literal notranslate"><span class="pre">shutdown()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.sleep"><code class="docutils literal notranslate"><span class="pre">sleep()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.soft_heap_limit"><code class="docutils literal notranslate"><span class="pre">soft_heap_limit()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.sqlite3_sourceid"><code class="docutils literal notranslate"><span class="pre">sqlite3_sourceid()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.sqlite_lib_version"><code class="docutils literal notranslate"><span class="pre">sqlite_lib_version()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.status"><code class="docutils literal notranslate"><span class="pre">status()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.strglob"><code class="docutils literal notranslate"><span class="pre">strglob()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.stricmp"><code class="docutils literal notranslate"><span class="pre">stricmp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.strlike"><code class="docutils literal notranslate"><span class="pre">strlike()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.strnicmp"><code class="docutils literal notranslate"><span class="pre">strnicmp()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.unregister_vfs"><code class="docutils literal notranslate"><span class="pre">unregister_vfs()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.using_amalgamation"><code class="docutils literal notranslate"><span class="pre">using_amalgamation</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.vfs_details"><code class="docutils literal notranslate"><span class="pre">vfs_details()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.vfs_names"><code class="docutils literal notranslate"><span class="pre">vfs_names()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#sqlite-constants">SQLite constants</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_access"><code class="docutils literal notranslate"><span class="pre">mapping_access</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_authorizer_function"><code class="docutils literal notranslate"><span class="pre">mapping_authorizer_function</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_authorizer_return_codes"><code class="docutils literal notranslate"><span class="pre">mapping_authorizer_return_codes</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_bestindex_constraints"><code class="docutils literal notranslate"><span class="pre">mapping_bestindex_constraints</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_config"><code class="docutils literal notranslate"><span class="pre">mapping_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_conflict_resolution_modes"><code class="docutils literal notranslate"><span class="pre">mapping_conflict_resolution_modes</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_db_config"><code class="docutils literal notranslate"><span class="pre">mapping_db_config</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_db_status"><code class="docutils literal notranslate"><span class="pre">mapping_db_status</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_device_characteristics"><code class="docutils literal notranslate"><span class="pre">mapping_device_characteristics</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_extended_result_codes"><code class="docutils literal notranslate"><span class="pre">mapping_extended_result_codes</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_file_control"><code class="docutils literal notranslate"><span class="pre">mapping_file_control</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_function_flags"><code class="docutils literal notranslate"><span class="pre">mapping_function_flags</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_limits"><code class="docutils literal notranslate"><span class="pre">mapping_limits</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_locking_level"><code class="docutils literal notranslate"><span class="pre">mapping_locking_level</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_open_flags"><code class="docutils literal notranslate"><span class="pre">mapping_open_flags</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_prepare_flags"><code class="docutils literal notranslate"><span class="pre">mapping_prepare_flags</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_result_codes"><code class="docutils literal notranslate"><span class="pre">mapping_result_codes</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_statement_status"><code class="docutils literal notranslate"><span class="pre">mapping_statement_status</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_status"><code class="docutils literal notranslate"><span class="pre">mapping_status</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_sync"><code class="docutils literal notranslate"><span class="pre">mapping_sync</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_trace_codes"><code class="docutils literal notranslate"><span class="pre">mapping_trace_codes</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_txn_state"><code class="docutils literal notranslate"><span class="pre">mapping_txn_state</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_virtual_table_configuration_options"><code class="docutils literal notranslate"><span class="pre">mapping_virtual_table_configuration_options</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_virtual_table_scan_flags"><code class="docutils literal notranslate"><span class="pre">mapping_virtual_table_scan_flags</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_wal_checkpoint"><code class="docutils literal notranslate"><span class="pre">mapping_wal_checkpoint</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.mapping_xshmlock_flags"><code class="docutils literal notranslate"><span class="pre">mapping_xshmlock_flags</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="connection.html">Connections to a database</a></li>
<li class="toctree-l1"><a class="reference internal" href="cursor.html">Cursors (executing SQL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="blob.html">Blob Input/Output</a></li>
<li class="toctree-l1"><a class="reference internal" href="backup.html">Backup</a></li>
<li class="toctree-l1"><a class="reference internal" href="vtable.html">Virtual Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="vfs.html">Virtual File System (VFS)</a></li>
<li class="toctree-l1"><a class="reference internal" href="shell.html">Shell</a></li>
<li class="toctree-l1"><a class="reference internal" href="bestpractice.html">Best Practice</a></li>
<li class="toctree-l1"><a class="reference internal" href="ext.html">Various interesting and useful bits of functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions and Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="execution.html">Execution and tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="dbapi.html">DBAPI notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="pysqlite.html">sqlite3 module differences</a></li>
<li class="toctree-l1"><a class="reference internal" href="benchmarking.html">Benchmarking</a></li>
<li class="toctree-l1"><a class="reference internal" href="copyright.html">Copyright and License</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Change History</a></li>
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">APSW</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content style-external-links">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">APSW Module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apsw.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="extensions.html" class="btn btn-neutral float-left" title="Extensions" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="connection.html" class="btn btn-neutral float-right" title="Connections to a database" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="apsw-module">
<span id="module-apsw"></span><h1>APSW Module<a class="headerlink" href="#apsw-module" title="Link to this heading"></a></h1>
<p>The module is the main interface to SQLite. Methods and data on the
module have process wide effects.</p>
<section id="type-annotations">
<span id="type-stubs"></span><h2>Type Annotations<a class="headerlink" href="#type-annotations" title="Link to this heading"></a></h2>
<p>Comprehensive <a class="reference external" href="https://docs.python.org/3/library/typing.html">type annotations</a> <a class="reference external" href="https://github.com/rogerbinns/apsw/blob/master/apsw/__init__.pyi">are included</a>,
and your code can be checked using tools like <a class="reference external" href="https://mypy-lang.org/">mypy</a>. You can refer to the types below for your
annotations (eg as <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.SQLiteValue</span></code></a>)</p>
<p>Your source files should include:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These types are <strong>not</strong> available at run time, and have no effect when
your code is running. They are only referenced when running a type
checker, or using an <a class="reference external" href="https://en.wikipedia.org/wiki/Language_Server_Protocol">IDE</a>.</p>
</div>
<p>You will require a recent version of Python to use the type
annotations.</p>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.SQLiteValue">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">SQLiteValue</span></span><a class="headerlink" href="#apsw.SQLiteValue" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a> | <a class="reference external" href="https://docs.python.org/3/library/functions.html#int">int</a> | <a class="reference external" href="https://docs.python.org/3/library/functions.html#float">float</a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes">bytes</a> | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a></div>
</div>
<p>SQLite supports 5 types - <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a> (NULL), 64 bit signed <a class="reference external" href="https://docs.python.org/3/library/functions.html#int">int</a>, 64 bit
<a class="reference external" href="https://docs.python.org/3/library/functions.html#float">float</a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes">bytes</a>, and <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a> (unicode text)</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.SQLiteValues">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">SQLiteValues</span></span><a class="headerlink" href="#apsw.SQLiteValues" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple">tuple</a>[()] | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple">tuple</a>[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, …]</div>
</div>
<p>A sequence of zero or more <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.Bindings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">Bindings</span></span><a class="headerlink" href="#apsw.Bindings" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence">Sequence</a>[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a> | <a class="reference internal" href="blob.html#apsw.zeroblob" title="apsw.zeroblob"><code class="xref py py-class docutils literal notranslate"><span class="pre">zeroblob</span></code></a>] | <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Mapping">Mapping</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a> | <a class="reference internal" href="blob.html#apsw.zeroblob" title="apsw.zeroblob"><code class="xref py py-class docutils literal notranslate"><span class="pre">zeroblob</span></code></a>]</div>
</div>
<p>Query bindings are either a sequence of <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, or a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict">dict</a> mapping names
to <a class="reference internal" href="#apsw.SQLiteValues" title="apsw.SQLiteValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a>. You can also provide <a class="reference internal" href="blob.html#apsw.zeroblob" title="apsw.zeroblob"><code class="xref py py-class docutils literal notranslate"><span class="pre">zeroblob</span></code></a> in <a class="reference internal" href="#apsw.Bindings" title="apsw.Bindings"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bindings</span></code></a>. You can use
<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict">dict</a> subclasses or any type registered with <a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Mapping" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.abc.Mapping</span></code></a>
for named bindings</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.AggregateT">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">AggregateT</span></span><a class="headerlink" href="#apsw.AggregateT" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any">Any</a></div>
</div>
<p>An object provided as first parameter of step and final aggregate functions</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.AggregateStep">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">AggregateStep</span></span><a class="headerlink" href="#apsw.AggregateStep" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line-block">
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
</div>
</div>
<p><a class="reference internal" href="#apsw.AggregateStep" title="apsw.AggregateStep"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateStep</span></code></a> is called on each matching row with the relevant number of <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.AggregateFinal">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">AggregateFinal</span></span><a class="headerlink" href="#apsw.AggregateFinal" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
</div>
<p>Final is called after all matching rows have been processed by step, and returns a <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.AggregateFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">AggregateFactory</span></span><a class="headerlink" href="#apsw.AggregateFactory" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[], AggregateClass | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple">tuple</a>[<a class="reference internal" href="#apsw.AggregateT" title="apsw.AggregateT"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateT</span></code></a>, <a class="reference internal" href="#apsw.AggregateStep" title="apsw.AggregateStep"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateStep</span></code></a>, <a class="reference internal" href="#apsw.AggregateFinal" title="apsw.AggregateFinal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AggregateFinal</span></code></a>]]</div>
</div>
<p>Called each time for the start of a new calculation using an aggregate function,
returning an object, a step function and a final function</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ScalarProtocol">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">ScalarProtocol</span></span><a class="headerlink" href="#apsw.ScalarProtocol" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line-block">
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
</div>
</div>
<p>Scalar callbacks take zero or more <a class="reference internal" href="#apsw.SQLiteValues" title="apsw.SQLiteValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a>, and return a <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.WindowT">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">WindowT</span></span><a class="headerlink" href="#apsw.WindowT" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any">Any</a></div>
</div>
<p>An object provided as first parameter of the 4 window functions, if not using class based callbacks</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.WindowStep">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">WindowStep</span></span><a class="headerlink" href="#apsw.WindowStep" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line-block">
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
</div>
</div>
<p>Window function step takes zero or more <a class="reference internal" href="#apsw.SQLiteValues" title="apsw.SQLiteValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.WindowFinal">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">WindowFinal</span></span><a class="headerlink" href="#apsw.WindowFinal" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line-block">
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
</div>
</div>
<p>Window function final takes zero or more <a class="reference internal" href="#apsw.SQLiteValues" title="apsw.SQLiteValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a>, and returns a <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.WindowValue">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">WindowValue</span></span><a class="headerlink" href="#apsw.WindowValue" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>], <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>]</div>
</div>
<p>Window function value returns the current <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.WindowInverse">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">WindowInverse</span></span><a class="headerlink" href="#apsw.WindowInverse" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line-block">
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
<div class="line">| <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValue</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>]</div>
</div>
</div>
<p>Window function inverse takes zero or more <a class="reference internal" href="#apsw.SQLiteValues" title="apsw.SQLiteValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a></p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.WindowFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">WindowFactory</span></span><a class="headerlink" href="#apsw.WindowFactory" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[], WindowClass | <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple">tuple</a>[<a class="reference internal" href="#apsw.WindowT" title="apsw.WindowT"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowT</span></code></a>, <a class="reference internal" href="#apsw.WindowStep" title="apsw.WindowStep"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowStep</span></code></a>, <a class="reference internal" href="#apsw.WindowFinal" title="apsw.WindowFinal"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowFinal</span></code></a>, <a class="reference internal" href="#apsw.WindowValue" title="apsw.WindowValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowValue</span></code></a>, <a class="reference internal" href="#apsw.WindowInverse" title="apsw.WindowInverse"><code class="xref py py-class docutils literal notranslate"><span class="pre">WindowInverse</span></code></a>]]</div>
</div>
<p>Called each time at the start of a new window function execution. It should return either an object
with relevant methods or an object used as the first parameter and the 4 methods</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.RowTracer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">RowTracer</span></span><a class="headerlink" href="#apsw.RowTracer" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cursor</span></code></a>, <a class="reference internal" href="#apsw.SQLiteValues" title="apsw.SQLiteValues"><code class="xref py py-class docutils literal notranslate"><span class="pre">SQLiteValues</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any">Any</a>]</div>
</div>
<p>Row tracers are called with the <a class="reference internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cursor</span></code></a>, and the row that would
be returned. If you return <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>, then no row is returned, otherwise
whatever is returned is returned as a result row for the query</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ExecTracer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">ExecTracer</span></span><a class="headerlink" href="#apsw.ExecTracer" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cursor</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="reference internal" href="#apsw.Bindings" title="apsw.Bindings"><code class="xref py py-class docutils literal notranslate"><span class="pre">Bindings</span></code></a>]], <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool">bool</a>]</div>
</div>
<p>Execution tracers are called with the cursor, sql query text, and the bindings
used. Return False/<a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a> to abort execution, or True to continue</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.Authorizer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">Authorizer</span></span><a class="headerlink" href="#apsw.Authorizer" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int">int</a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>], <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional">Optional</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str">str</a>]], <a class="reference external" href="https://docs.python.org/3/library/functions.html#int">int</a>]</div>
</div>
<p>Authorizers are called with an operation code and 4 strings (which could be <a class="reference external" href="https://docs.python.org/3/library/constants.html#None">None</a>) depending
on the operatation. Return SQLITE_OK, SQLITE_DENY, or SQLITE_IGNORE</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.CommitHook">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">CommitHook</span></span><a class="headerlink" href="#apsw.CommitHook" title="Link to this definition"></a></dt>
<dd><div class="line-block">
<div class="line"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable">Callable</a>[[], <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool">bool</a>]</div>
</div>
<p>Commit hook is called with no arguments and should return True to abort the commit and False
to let it continue</p>
</dd></dl>
</section>
<section id="api-reference">
<h2>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading"></a></h2>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.SQLITE_VERSION_NUMBER">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">SQLITE_VERSION_NUMBER</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></em><a class="headerlink" href="#apsw.SQLITE_VERSION_NUMBER" title="Link to this definition"></a></dt>
<dd><p>The integer version number of SQLite that APSW was compiled
against. For example SQLite 3.44.1 will have the value <em>3440100</em>.
This number may be different than the actual library in use if the
library is shared and has been updated. Call
<a class="reference internal" href="#apsw.sqlite_lib_version" title="apsw.sqlite_lib_version"><code class="xref py py-meth docutils literal notranslate"><span class="pre">sqlite_lib_version()</span></code></a> to get the actual library version.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.allow_missing_dict_bindings">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">allow_missing_dict_bindings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#apsw.allow_missing_dict_bindings" title="Link to this definition"></a></dt>
<dd><p>Changes how missing bindings are handled when using a <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>.
Historically missing bindings were treated as <em>None</em>. It was
anticipated that dict bindings would be used when there were lots
of columns, so having missing ones defaulting to <em>None</em> was
convenient.</p>
<p>Unfortunately this also has the side effect of not catching typos
and similar issues.</p>
<p>APSW 3.41.0.0 changed the default so that missing dict entries
will result in an exception. Call this with <em>True</em> to restore
the earlier behaviour, and <em>False</em> to have an exception.</p>
<p>The previous value is returned.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.apsw_version">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">apsw_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#apsw.apsw_version" title="Link to this definition"></a></dt>
<dd><p>Returns the APSW version.</p>
</dd></dl>
<dl class="py attribute" id="index-0">
<dt class="sig sig-object py" id="apsw.compile_options">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">compile_options</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.compile_options" title="Link to this definition"></a></dt>
<dd><p>A tuple of the options used to compile SQLite. For example it
will be something like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="s1">'ENABLE_LOCKING_STYLE=0'</span><span class="p">,</span> <span class="s1">'TEMP_STORE=1'</span><span class="p">,</span> <span class="s1">'THREADSAFE=1'</span><span class="p">)</span>
</pre></div>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/compileoption_get.html">sqlite3_compileoption_get</a></p>
</dd></dl>
<dl class="py method" id="index-1">
<dt class="sig sig-object py" id="apsw.complete">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">complete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#apsw.complete" title="Link to this definition"></a></dt>
<dd><p>Returns True if the input string comprises one or more complete SQL
statements by looking for an unquoted trailing semi-colon. It does
not consider comments or blank lines to be complete.</p>
<p>An example use would be if you were prompting the user for SQL
statements and needed to know if you had a whole statement, or
needed to ask for another line:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">statement</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">"SQL> "</span><span class="p">)</span>
<span class="k">while</span> <span class="ow">not</span> <span class="n">apsw</span><span class="o">.</span><span class="n">complete</span><span class="p">(</span><span class="n">statement</span><span class="p">):</span>
<span class="n">more</span> <span class="o">=</span> <span class="nb">input</span><span class="p">(</span><span class="s2">" .. "</span><span class="p">)</span>
<span class="n">statement</span> <span class="o">=</span> <span class="n">statement</span> <span class="o">+</span> <span class="s2">"</span><span class="se">\\</span><span class="s2">n"</span> <span class="o">+</span> <span class="n">more</span>
</pre></div>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/complete.html">sqlite3_complete</a></p>
</dd></dl>
<dl class="py method" id="index-2">
<dt class="sig sig-object py" id="apsw.config">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.config" title="Link to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>op</strong> – A <a class="reference external" href="https://sqlite.org/c3ref/c_config_chunkalloc.html">configuration operation</a></p></li>
<li><p><strong>args</strong> – Zero or more arguments as appropriate for <em>op</em></p></li>
</ul>
</dd>
</dl>
<p>Some operations don’t make sense from a Python program. All the
remaining are supported.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/config.html">sqlite3_config</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.connection_hooks">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">connection_hooks</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">Connection</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.connection_hooks" title="Link to this definition"></a></dt>
<dd><p>The purpose of the hooks is to allow the easy registration of
<a class="reference internal" href="connection.html#apsw.Connection.create_scalar_function" title="apsw.Connection.create_scalar_function"><code class="xref py py-meth docutils literal notranslate"><span class="pre">functions</span></code></a>,
<a class="reference internal" href="vtable.html#virtualtables"><span class="std std-ref">virtual tables</span></a> or similar items with
each <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a> as it is created. The default value is an empty
list. Whenever a Connection is created, each item in
apsw.connection_hooks is invoked with a single parameter being
the new Connection object. If the hook raises an exception then
the creation of the Connection fails.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.connections">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">connections</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">Connection</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#apsw.connections" title="Link to this definition"></a></dt>
<dd><p>Returns a list of the connections</p>
</dd></dl>
<dl class="py method" id="index-3">
<dt class="sig sig-object py" id="apsw.enable_shared_cache">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">enable_shared_cache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">enable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.enable_shared_cache" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/sharedcache.html#use_of_shared_cache_is_discouraged">Discouraged</a>.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/enable_shared_cache.html">sqlite3_enable_shared_cache</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.exception_for">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">exception_for</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.12)"><span class="pre">Exception</span></a></span></span><a class="headerlink" href="#apsw.exception_for" title="Link to this definition"></a></dt>
<dd><p>If you would like to raise an exception that corresponds to a
particular SQLite <a class="reference external" href="https://sqlite.org/c3ref/c_abort.html">error code</a> then call this function.
It also understands <a class="reference external" href="https://sqlite.org/c3ref/c_ioerr_access.html">extended error codes</a>.</p>
<p>For example to raise <a class="reference external" href="https://sqlite.org/c3ref/c_ioerr_access.html">SQLITE_IOERR_ACCESS</a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">raise</span> <span class="n">apsw</span><span class="o">.</span><span class="n">exception_for</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_IOERR_ACCESS</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.fork_checker">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">fork_checker</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.fork_checker" title="Link to this definition"></a></dt>
<dd><p><strong>Note</strong> This method is not available on Windows as it does not
support the fork system call.</p>
<p>SQLite does not allow the use of database connections across <a class="reference external" href="https://en.wikipedia.org/wiki/Fork_(operating_system)">forked</a> processes
(see the <a class="reference external" href="https://sqlite.org/faq.html#q6">SQLite FAQ Q6</a>).
(Forking creates a child process that is a duplicate of the parent
including the state of all data structures in the program. If you
do this to SQLite then parent and child would both consider
themselves owners of open databases and silently corrupt each
other’s work and interfere with each other’s locks.)</p>
<p>One example of how you may end up using fork is if you use the
<a class="reference external" href="https://docs.python.org/3/library/multiprocessing.html">multiprocessing module</a> which can use
fork to make child processes.</p>
<p>If you do use fork or multiprocessing on a platform that supports
fork then you <strong>must</strong> ensure database connections and their objects
(cursors, backup, blobs etc) are not used in the parent process, or
are all closed before calling fork or starting a <a class="reference external" href="https://docs.python.org/3/library/multiprocessing.html#process-and-exceptions">Process</a>.
(Note you must call close to ensure the underlying SQLite objects
are closed. It is also a good idea to call <a class="reference external" href="https://docs.python.org/3/library/gc.html#gc.collect">gc.collect(2)</a> to ensure
anything you may have missed is also deallocated.)</p>
<p>Once you run this method, extra checking code is inserted into
SQLite’s mutex operations (at a very small performance penalty) that
verifies objects are not used across processes. You will get a
<a class="reference internal" href="exceptions.html#apsw.ForkingViolationError" title="apsw.ForkingViolationError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ForkingViolationError</span></code></a> if you do so. Note that due to the way
Python’s internals work, the exception will be delivered to
<cite>sys.excepthook</cite> in addition to the normal exception mechanisms and
may be reported by Python after the line where the issue actually
arose. (Destructors of objects you didn’t close also run between
lines.)</p>
<p>You should only call this method as the first line after importing
APSW, as it has to shutdown and re-initialize SQLite. If you have
any SQLite objects already allocated when calling the method then
the program will later crash. The recommended use is to use the fork
checking as part of your test suite.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.format_sql_value">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">format_sql_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">SQLiteValue</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#apsw.format_sql_value" title="Link to this definition"></a></dt>
<dd><p>Returns a Python string representing the supplied value in SQLite
syntax.</p>
<p>Note that SQLite represents floating point <a class="reference external" href="https://en.wikipedia.org/wiki/NaN">Nan</a> as <code class="code docutils literal notranslate"><span class="pre">NULL</span></code>, infinity as
<code class="code docutils literal notranslate"><span class="pre">1e999</span></code> and loses the sign on <a class="reference external" href="https://en.wikipedia.org/wiki/Signed_zero">negative zero</a>.</p>
</dd></dl>
<dl class="py method" id="index-4">
<dt class="sig sig-object py" id="apsw.hard_heap_limit">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">hard_heap_limit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.hard_heap_limit" title="Link to this definition"></a></dt>
<dd><p>Enforces SQLite keeping memory usage below <em>limit</em> bytes and
returns the previous limit.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#apsw.soft_heap_limit" title="apsw.soft_heap_limit"><code class="xref py py-meth docutils literal notranslate"><span class="pre">soft_heap_limit()</span></code></a></p>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/hard_heap_limit64.html">sqlite3_hard_heap_limit64</a></p>
</dd></dl>
<dl class="py method" id="index-5">
<dt class="sig sig-object py" id="apsw.initialize">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">initialize</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.initialize" title="Link to this definition"></a></dt>
<dd><p>It is unlikely you will want to call this method as SQLite automatically initializes.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/initialize.html">sqlite3_initialize</a></p>
</dd></dl>
<dl class="py attribute" id="index-6">
<dt class="sig sig-object py" id="apsw.keywords">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.12)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.keywords" title="Link to this definition"></a></dt>
<dd><p>A set containing every SQLite keyword</p>
<dl class="simple">
<dt>Calls:</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://sqlite.org/c3ref/keyword_check.html">sqlite3_keyword_count</a></p></li>
<li><p><a class="reference external" href="https://sqlite.org/c3ref/keyword_check.html">sqlite3_keyword_name</a></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method" id="index-7">
<dt class="sig sig-object py" id="apsw.log">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">log</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">errorcode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.log" title="Link to this definition"></a></dt>
<dd><p>Calls the SQLite logging interface. You must format the
message before passing it to this method:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apsw</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="n">apsw</span><span class="o">.</span><span class="n">SQLITE_NOMEM</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"Need </span><span class="si">{</span><span class="w"> </span><span class="n">needed</span><span class="w"> </span><span class="si">}</span><span class="s2"> bytes of memory"</span><span class="p">)</span>
</pre></div>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/log.html">sqlite3_log</a></p>
</dd></dl>
<dl class="py method" id="index-8">
<dt class="sig sig-object py" id="apsw.memory_high_water">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">memory_high_water</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.memory_high_water" title="Link to this definition"></a></dt>
<dd><p>Returns the maximum amount of memory SQLite has used. If <em>reset</em> is
True then the high water mark is reset to the current value.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#apsw.status" title="apsw.status"><code class="xref py py-meth docutils literal notranslate"><span class="pre">status()</span></code></a></p>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/memory_highwater.html">sqlite3_memory_highwater</a></p>
</dd></dl>
<dl class="py method" id="index-9">
<dt class="sig sig-object py" id="apsw.memory_used">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">memory_used</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.memory_used" title="Link to this definition"></a></dt>
<dd><p>Returns the amount of memory SQLite is currently using.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#apsw.status" title="apsw.status"><code class="xref py py-meth docutils literal notranslate"><span class="pre">status()</span></code></a></p>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/memory_highwater.html">sqlite3_memory_used</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.no_change">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">no_change</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><span class="pre">object</span></a></em><a class="headerlink" href="#apsw.no_change" title="Link to this definition"></a></dt>
<dd><p>A sentinel value used to indicate no change in a value when
used with <a class="reference internal" href="vtable.html#apsw.VTCursor.ColumnNoChange" title="apsw.VTCursor.ColumnNoChange"><code class="xref py py-meth docutils literal notranslate"><span class="pre">VTCursor.ColumnNoChange()</span></code></a> and
<a class="reference internal" href="vtable.html#apsw.VTTable.UpdateChangeRow" title="apsw.VTTable.UpdateChangeRow"><code class="xref py py-meth docutils literal notranslate"><span class="pre">VTTable.UpdateChangeRow()</span></code></a></p>
</dd></dl>
<dl class="py method" id="index-10">
<dt class="sig sig-object py" id="apsw.randomness">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">randomness</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">amount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></span><a class="headerlink" href="#apsw.randomness" title="Link to this definition"></a></dt>
<dd><p>Gets random data from SQLite’s random number generator.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>amount</strong> – How many bytes to return</p>
</dd>
</dl>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/randomness.html">sqlite3_randomness</a></p>
</dd></dl>
<dl class="py method" id="index-11">
<dt class="sig sig-object py" id="apsw.release_memory">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">release_memory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">amount</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.release_memory" title="Link to this definition"></a></dt>
<dd><p>Requests SQLite try to free <em>amount</em> bytes of memory. Returns how
many bytes were freed.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/release_memory.html">sqlite3_release_memory</a></p>
</dd></dl>
<dl class="py method" id="index-12">
<dt class="sig sig-object py" id="apsw.set_default_vfs">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">set_default_vfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.set_default_vfs" title="Link to this definition"></a></dt>
<dd><p>Sets the default vfs to <em>name</em> which must be an existing vfs.
See <a class="reference internal" href="#apsw.vfs_names" title="apsw.vfs_names"><code class="xref py py-meth docutils literal notranslate"><span class="pre">vfs_names()</span></code></a>.</p>
<dl class="simple">
<dt>Calls:</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://sqlite.org/c3ref/vfs_find.html">sqlite3_vfs_register</a></p></li>
<li><p><a class="reference external" href="https://sqlite.org/c3ref/vfs_find.html">sqlite3_vfs_find</a></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method" id="index-13">
<dt class="sig sig-object py" id="apsw.shutdown">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">shutdown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.shutdown" title="Link to this definition"></a></dt>
<dd><p>It is unlikely you will want to call this method and there is no
need to do so. It is a <strong>really</strong> bad idea to call it unless you
are absolutely sure all <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">connections</span></code></a>,
<a class="reference internal" href="blob.html#apsw.Blob" title="apsw.Blob"><code class="xref py py-class docutils literal notranslate"><span class="pre">blobs</span></code></a>, <a class="reference internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><code class="xref py py-class docutils literal notranslate"><span class="pre">cursors</span></code></a>, <a class="reference internal" href="vfs.html#apsw.VFS" title="apsw.VFS"><code class="xref py py-class docutils literal notranslate"><span class="pre">vfs</span></code></a>
etc have been closed, deleted and garbage collected.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/initialize.html">sqlite3_shutdown</a></p>
</dd></dl>
<dl class="py method" id="index-14">
<dt class="sig sig-object py" id="apsw.sleep">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">sleep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">milliseconds</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.sleep" title="Link to this definition"></a></dt>
<dd><p>Sleep for at least the number of <cite>milliseconds</cite>, returning how many
milliseconds were requested from the operating system.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/sleep.html">sqlite3_sleep</a></p>
</dd></dl>
<dl class="py method" id="index-15">
<dt class="sig sig-object py" id="apsw.soft_heap_limit">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">soft_heap_limit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.soft_heap_limit" title="Link to this definition"></a></dt>
<dd><p>Requests SQLite try to keep memory usage below <em>limit</em> bytes and
returns the previous limit.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#apsw.hard_heap_limit" title="apsw.hard_heap_limit"><code class="xref py py-meth docutils literal notranslate"><span class="pre">hard_heap_limit()</span></code></a></p>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/hard_heap_limit64.html">sqlite3_soft_heap_limit64</a></p>
</dd></dl>
<dl class="py method" id="index-16">
<dt class="sig sig-object py" id="apsw.sqlite3_sourceid">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">sqlite3_sourceid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#apsw.sqlite3_sourceid" title="Link to this definition"></a></dt>
<dd><p>Returns the exact checkin information for the SQLite 3 source
being used.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/libversion.html">sqlite3_sourceid</a></p>
</dd></dl>
<dl class="py method" id="index-17">
<dt class="sig sig-object py" id="apsw.sqlite_lib_version">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">sqlite_lib_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="headerlink" href="#apsw.sqlite_lib_version" title="Link to this definition"></a></dt>
<dd><p>Returns the version of the SQLite library. This value is queried at
run time from the library so if you use shared libraries it will be
the version in the shared library.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/libversion.html">sqlite3_libversion</a></p>
</dd></dl>
<dl class="py method" id="index-18">
<dt class="sig sig-object py" id="apsw.status">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">op</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><span class="pre">tuple</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#apsw.status" title="Link to this definition"></a></dt>
<dd><p>Returns current and highwater measurements.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>op</strong> – A <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_size.html">status parameter</a></p></li>
<li><p><strong>reset</strong> – If <em>True</em> then the highwater is set to the current value</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A tuple of current value and highwater value</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="connection.html#apsw.Connection.status" title="apsw.Connection.status"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Connection.status()</span></code></a> for statistics about a <a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><code class="xref py py-class docutils literal notranslate"><span class="pre">Connection</span></code></a></p></li>
<li><p><a class="reference internal" href="example.html#example-status"><span class="std std-ref">Status example</span></a></p></li>
</ul>
</div>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/status.html">sqlite3_status64</a></p>
</dd></dl>
<dl class="py method" id="index-19">
<dt class="sig sig-object py" id="apsw.strglob">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">strglob</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">glob</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.strglob" title="Link to this definition"></a></dt>
<dd><p>Does string GLOB matching. Zero is returned on a match.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/strglob.html">sqlite3_strglob</a></p>
</dd></dl>
<dl class="py method" id="index-20">
<dt class="sig sig-object py" id="apsw.stricmp">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">stricmp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.stricmp" title="Link to this definition"></a></dt>
<dd><p>Does string case-insensitive comparison. Zero is returned
on a match.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/stricmp.html">sqlite3_stricmp</a></p>
</dd></dl>
<dl class="py method" id="index-21">
<dt class="sig sig-object py" id="apsw.strlike">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">strlike</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">glob</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">escape</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.strlike" title="Link to this definition"></a></dt>
<dd><p>Does string LIKE matching. Zero is returned on a match.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/strlike.html">sqlite3_strlike</a></p>
</dd></dl>
<dl class="py method" id="index-22">
<dt class="sig sig-object py" id="apsw.strnicmp">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">strnicmp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">string1</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">string2</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#apsw.strnicmp" title="Link to this definition"></a></dt>
<dd><p>Does string case-insensitive comparison. Zero is returned
on a match.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/stricmp.html">sqlite3_strnicmp</a></p>
</dd></dl>
<dl class="py method" id="index-23">
<dt class="sig sig-object py" id="apsw.unregister_vfs">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">unregister_vfs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#apsw.unregister_vfs" title="Link to this definition"></a></dt>
<dd><p>Unregisters the named vfs. See <a class="reference internal" href="#apsw.vfs_names" title="apsw.vfs_names"><code class="xref py py-meth docutils literal notranslate"><span class="pre">vfs_names()</span></code></a>.</p>
<dl class="simple">
<dt>Calls:</dt><dd><ul class="simple">
<li><p><a class="reference external" href="https://sqlite.org/c3ref/vfs_find.html">sqlite3_vfs_unregister</a></p></li>
<li><p><a class="reference external" href="https://sqlite.org/c3ref/vfs_find.html">sqlite3_vfs_find</a></p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.using_amalgamation">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">using_amalgamation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></em><a class="headerlink" href="#apsw.using_amalgamation" title="Link to this definition"></a></dt>
<dd><p>If True then <a class="reference external" href="https://www.sqlite.org/amalgamation.html">SQLite amalgamation</a> is in
use (statically compiled into APSW). Using the amalgamation means
that SQLite shared libraries are not used and will not affect your
code.</p>
</dd></dl>
<dl class="py method" id="index-24">
<dt class="sig sig-object py" id="apsw.vfs_details">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">vfs_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#apsw.vfs_details" title="Link to this definition"></a></dt>
<dd></dd></dl>
<p>Returns a list with details of each <a class="reference internal" href="vfs.html#vfs"><span class="std std-ref">vfs</span></a>. The detail is a
dictionary with the keys being the names of the <a class="reference external" href="https://sqlite.org/c3ref/vfs.html">sqlite3_vfs</a> data structure, and their
corresponding values.</p>
<p>Pointers are converted using <a class="reference external" href="https://docs.python.org/3/c-api/long.html?highlight=voidptr#c.PyLong_FromVoidPtr">PyLong_FromVoidPtr</a>.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/vfs_find.html">sqlite3_vfs_find</a></p>
<dl class="py method" id="index-25">
<dt class="sig sig-object py" id="apsw.vfs_names">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">vfs_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#apsw.vfs_names" title="Link to this definition"></a></dt>
<dd><p>Returns a list of the currently installed <a class="reference internal" href="vfs.html#vfs"><span class="std std-ref">vfs</span></a>. The first
item in the list is the default vfs.</p>
<p>Calls: <a class="reference external" href="https://sqlite.org/c3ref/vfs_find.html">sqlite3_vfs_find</a></p>
</dd></dl>
</section>
<section id="sqlite-constants">
<span id="sqliteconstants"></span><h2>SQLite constants<a class="headerlink" href="#sqlite-constants" title="Link to this heading"></a></h2>
<p>SQLite has <a class="reference external" href="https://sqlite.org/c3ref/constlist.html">many constants</a> used in various
interfaces. To use a constant such as <em>SQLITE_OK</em>, just
use <code class="docutils literal notranslate"><span class="pre">apsw.SQLITE_OK</span></code>.</p>
<p>The same values can be used in different contexts. For example
<em>SQLITE_OK</em> and <em>SQLITE_CREATE_INDEX</em> both have a value
of zero. For each group of constants there is also a mapping (dict)
available that you can supply a string to and get the corresponding
numeric value, or supply a numeric value and get the corresponding
string. These can help improve diagnostics/logging, calling other
modules etc. For example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apsw</span><span class="o">.</span><span class="n">mapping_authorizer_function</span><span class="p">[</span><span class="s2">"SQLITE_READ"</span><span class="p">]</span> <span class="o">==</span> <span class="mi">20</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">mapping_authorizer_function</span><span class="p">[</span><span class="mi">20</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"SQLITE_READ"</span>
</pre></div>
</div>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_access">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_access</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_access" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">Flags for the xAccess VFS method</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">SQLITE_ACCESS_EXISTS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">SQLITE_ACCESS_READ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_access_exists.html">SQLITE_ACCESS_READWRITE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_authorizer_function">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_authorizer_function</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_authorizer_function" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">Authorizer Action Codes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_ALTER_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_ANALYZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_ATTACH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_COPY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TEMP_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_CREATE_VTABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DELETE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DETACH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_INDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TEMP_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_DROP_VTABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_FUNCTION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_INSERT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_PRAGMA</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_READ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_RECURSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_REINDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_SAVEPOINT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_SELECT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_TRANSACTION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">SQLITE_UPDATE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_authorizer_return_codes">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_authorizer_return_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_authorizer_return_codes" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">Authorizer Return Codes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">SQLITE_DENY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">SQLITE_IGNORE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ok">SQLITE_OK</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_bestindex_constraints">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_bestindex_constraints</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_bestindex_constraints" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">Virtual Table Constraint Operator Codes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_EQ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_FUNCTION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_GE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_GLOB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_GT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_IS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_ISNOT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_ISNOTNULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_ISNULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LIKE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LIMIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_LT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_MATCH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_NE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_OFFSET</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_index_constraint_eq.html">SQLITE_INDEX_CONSTRAINT_REGEXP</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_config">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_config" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html">Configuration Options</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigcoveringindexscan">SQLITE_CONFIG_COVERING_INDEX_SCAN</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetmalloc">SQLITE_CONFIG_GETMALLOC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetmutex">SQLITE_CONFIG_GETMUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetpcache">SQLITE_CONFIG_GETPCACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiggetpcache2">SQLITE_CONFIG_GETPCACHE2</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigheap">SQLITE_CONFIG_HEAP</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiglog">SQLITE_CONFIG_LOG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiglookaside">SQLITE_CONFIG_LOOKASIDE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmalloc">SQLITE_CONFIG_MALLOC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmemdbmaxsize">SQLITE_CONFIG_MEMDB_MAXSIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmemstatus">SQLITE_CONFIG_MEMSTATUS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmmapsize">SQLITE_CONFIG_MMAP_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmultithread">SQLITE_CONFIG_MULTITHREAD</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigmutex">SQLITE_CONFIG_MUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpcache">SQLITE_CONFIG_PCACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpcache2">SQLITE_CONFIG_PCACHE2</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpcachehdrsz">SQLITE_CONFIG_PCACHE_HDRSZ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigpmasz">SQLITE_CONFIG_PMASZ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigscratch">SQLITE_CONFIG_SCRATCH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigserialized">SQLITE_CONFIG_SERIALIZED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigsinglethread">SQLITE_CONFIG_SINGLETHREAD</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigsmallmalloc">SQLITE_CONFIG_SMALL_MALLOC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigsorterrefsize">SQLITE_CONFIG_SORTERREF_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigsqllog">SQLITE_CONFIG_SQLLOG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigstmtjrnlspill">SQLITE_CONFIG_STMTJRNL_SPILL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfiguri">SQLITE_CONFIG_URI</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_config_covering_index_scan.html#sqliteconfigwin32heapsize">SQLITE_CONFIG_WIN32_HEAPSIZE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_conflict_resolution_modes">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_conflict_resolution_modes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_conflict_resolution_modes" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">Conflict resolution modes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/rescode.html#abort">SQLITE_ABORT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">SQLITE_FAIL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deny.html">SQLITE_IGNORE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">SQLITE_REPLACE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fail.html">SQLITE_ROLLBACK</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_db_config">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_db_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_db_config" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html">Database Connection Configuration Options</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigdefensive">SQLITE_DBCONFIG_DEFENSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigdqsddl">SQLITE_DBCONFIG_DQS_DDL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigdqsdml">SQLITE_DBCONFIG_DQS_DML</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigenablefkey">SQLITE_DBCONFIG_ENABLE_FKEY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigenablefts3tokenizer">SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigenableloadextension">SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigenableqpsg">SQLITE_DBCONFIG_ENABLE_QPSG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigenabletrigger">SQLITE_DBCONFIG_ENABLE_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigenableview">SQLITE_DBCONFIG_ENABLE_VIEW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfiglegacyaltertable">SQLITE_DBCONFIG_LEGACY_ALTER_TABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfiglegacyfileformat">SQLITE_DBCONFIG_LEGACY_FILE_FORMAT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfiglookaside">SQLITE_DBCONFIG_LOOKASIDE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigmaindbname">SQLITE_DBCONFIG_MAINDBNAME</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html">SQLITE_DBCONFIG_MAX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfignockptonclose">SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigresetdatabase">SQLITE_DBCONFIG_RESET_DATABASE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigreversescanorder">SQLITE_DBCONFIG_REVERSE_SCANORDER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigstmtscanstatus">SQLITE_DBCONFIG_STMT_SCANSTATUS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigtriggereqp">SQLITE_DBCONFIG_TRIGGER_EQP</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigtrustedschema">SQLITE_DBCONFIG_TRUSTED_SCHEMA</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbconfig_defensive.html#sqlitedbconfigwritableschema">SQLITE_DBCONFIG_WRITABLE_SCHEMA</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_db_status">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_db_status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_db_status" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html">Status Parameters for database connections</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachehit">SQLITE_DBSTATUS_CACHE_HIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachemiss">SQLITE_DBSTATUS_CACHE_MISS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachespill">SQLITE_DBSTATUS_CACHE_SPILL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscacheused">SQLITE_DBSTATUS_CACHE_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscacheusedshared">SQLITE_DBSTATUS_CACHE_USED_SHARED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuscachewrite">SQLITE_DBSTATUS_CACHE_WRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatusdeferredfks">SQLITE_DBSTATUS_DEFERRED_FKS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasidehit">SQLITE_DBSTATUS_LOOKASIDE_HIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasidemissfull">SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasidemisssize">SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatuslookasideused">SQLITE_DBSTATUS_LOOKASIDE_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html">SQLITE_DBSTATUS_MAX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatusschemaused">SQLITE_DBSTATUS_SCHEMA_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_dbstatus_options.html#sqlitedbstatusstmtused">SQLITE_DBSTATUS_STMT_USED</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_device_characteristics">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_device_characteristics</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_device_characteristics" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">Device Characteristics</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC16K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC1K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC2K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC32K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC4K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC512</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC64K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_ATOMIC8K</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_BATCH_ATOMIC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_IMMUTABLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_POWERSAFE_OVERWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_SAFE_APPEND</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_SEQUENTIAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_iocap_atomic.html">SQLITE_IOCAP_UNDELETABLE_WHEN_OPEN</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_extended_result_codes">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_extended_result_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_extended_result_codes" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/rescode.html">Extended Result Codes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/rescode.html#abort_rollback">SQLITE_ABORT_ROLLBACK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#auth_user">SQLITE_AUTH_USER</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy_recovery">SQLITE_BUSY_RECOVERY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy_snapshot">SQLITE_BUSY_SNAPSHOT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy_timeout">SQLITE_BUSY_TIMEOUT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_convpath">SQLITE_CANTOPEN_CONVPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_dirtywal">SQLITE_CANTOPEN_DIRTYWAL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_fullpath">SQLITE_CANTOPEN_FULLPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_isdir">SQLITE_CANTOPEN_ISDIR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_notempdir">SQLITE_CANTOPEN_NOTEMPDIR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen_symlink">SQLITE_CANTOPEN_SYMLINK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_check">SQLITE_CONSTRAINT_CHECK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_commithook">SQLITE_CONSTRAINT_COMMITHOOK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_datatype">SQLITE_CONSTRAINT_DATATYPE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_foreignkey">SQLITE_CONSTRAINT_FOREIGNKEY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_function">SQLITE_CONSTRAINT_FUNCTION</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_notnull">SQLITE_CONSTRAINT_NOTNULL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_pinned">SQLITE_CONSTRAINT_PINNED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_primarykey">SQLITE_CONSTRAINT_PRIMARYKEY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_rowid">SQLITE_CONSTRAINT_ROWID</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_trigger">SQLITE_CONSTRAINT_TRIGGER</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_unique">SQLITE_CONSTRAINT_UNIQUE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint_vtab">SQLITE_CONSTRAINT_VTAB</a>, <a class="reference external" href="https://sqlite.org/rescode.html#corrupt_index">SQLITE_CORRUPT_INDEX</a>, <a class="reference external" href="https://sqlite.org/rescode.html#corrupt_sequence">SQLITE_CORRUPT_SEQUENCE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#corrupt_vtab">SQLITE_CORRUPT_VTAB</a>, <a class="reference external" href="https://sqlite.org/rescode.html#error_missing_collseq">SQLITE_ERROR_MISSING_COLLSEQ</a>, <a class="reference external" href="https://sqlite.org/rescode.html#error_retry">SQLITE_ERROR_RETRY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#error_snapshot">SQLITE_ERROR_SNAPSHOT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_access">SQLITE_IOERR_ACCESS</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_auth">SQLITE_IOERR_AUTH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_begin_atomic">SQLITE_IOERR_BEGIN_ATOMIC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_blocked">SQLITE_IOERR_BLOCKED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_checkreservedlock">SQLITE_IOERR_CHECKRESERVEDLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_close">SQLITE_IOERR_CLOSE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_commit_atomic">SQLITE_IOERR_COMMIT_ATOMIC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_convpath">SQLITE_IOERR_CONVPATH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_corruptfs">SQLITE_IOERR_CORRUPTFS</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_data">SQLITE_IOERR_DATA</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_delete">SQLITE_IOERR_DELETE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_delete_noent">SQLITE_IOERR_DELETE_NOENT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_dir_close">SQLITE_IOERR_DIR_CLOSE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_dir_fsync">SQLITE_IOERR_DIR_FSYNC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_fstat">SQLITE_IOERR_FSTAT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_fsync">SQLITE_IOERR_FSYNC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_gettemppath">SQLITE_IOERR_GETTEMPPATH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_abort_rollback.html">SQLITE_IOERR_IN_PAGE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_lock">SQLITE_IOERR_LOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_mmap">SQLITE_IOERR_MMAP</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_nomem">SQLITE_IOERR_NOMEM</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_rdlock">SQLITE_IOERR_RDLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_read">SQLITE_IOERR_READ</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_rollback_atomic">SQLITE_IOERR_ROLLBACK_ATOMIC</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_seek">SQLITE_IOERR_SEEK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmlock">SQLITE_IOERR_SHMLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmmap">SQLITE_IOERR_SHMMAP</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmopen">SQLITE_IOERR_SHMOPEN</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_shmsize">SQLITE_IOERR_SHMSIZE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_short_read">SQLITE_IOERR_SHORT_READ</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_truncate">SQLITE_IOERR_TRUNCATE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_unlock">SQLITE_IOERR_UNLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_vnode">SQLITE_IOERR_VNODE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr_write">SQLITE_IOERR_WRITE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#locked_sharedcache">SQLITE_LOCKED_SHAREDCACHE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#locked_vtab">SQLITE_LOCKED_VTAB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_abort_rollback.html">SQLITE_NOTICE_RBU</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notice_recover_rollback">SQLITE_NOTICE_RECOVER_ROLLBACK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notice_recover_wal">SQLITE_NOTICE_RECOVER_WAL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ok_load_permanently">SQLITE_OK_LOAD_PERMANENTLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_abort_rollback.html">SQLITE_OK_SYMLINK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_cantinit">SQLITE_READONLY_CANTINIT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_cantlock">SQLITE_READONLY_CANTLOCK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_dbmoved">SQLITE_READONLY_DBMOVED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_directory">SQLITE_READONLY_DIRECTORY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_recovery">SQLITE_READONLY_RECOVERY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly_rollback">SQLITE_READONLY_ROLLBACK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#warning_autoindex">SQLITE_WARNING_AUTOINDEX</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_file_control">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_file_control</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_file_control" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html">Standard File Control Opcodes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlbeginatomicwrite">SQLITE_FCNTL_BEGIN_ATOMIC_WRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlbusyhandler">SQLITE_FCNTL_BUSYHANDLER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlchunksize">SQLITE_FCNTL_CHUNK_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlckptdone">SQLITE_FCNTL_CKPT_DONE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlckptstart">SQLITE_FCNTL_CKPT_START</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlcksmfile">SQLITE_FCNTL_CKSM_FILE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlcommitatomicwrite">SQLITE_FCNTL_COMMIT_ATOMIC_WRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlcommitphasetwo">SQLITE_FCNTL_COMMIT_PHASETWO</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntldataversion">SQLITE_FCNTL_DATA_VERSION</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlexternalreader">SQLITE_FCNTL_EXTERNAL_READER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlfilepointer">SQLITE_FCNTL_FILE_POINTER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html">SQLITE_FCNTL_GET_LOCKPROXYFILE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlhasmoved">SQLITE_FCNTL_HAS_MOVED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntljournalpointer">SQLITE_FCNTL_JOURNAL_POINTER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html">SQLITE_FCNTL_LAST_ERRNO</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntllockstate">SQLITE_FCNTL_LOCKSTATE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntllocktimeout">SQLITE_FCNTL_LOCK_TIMEOUT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlmmapsize">SQLITE_FCNTL_MMAP_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntloverwrite">SQLITE_FCNTL_OVERWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html">SQLITE_FCNTL_PDB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlpersistwal">SQLITE_FCNTL_PERSIST_WAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlpowersafeoverwrite">SQLITE_FCNTL_POWERSAFE_OVERWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlpragma">SQLITE_FCNTL_PRAGMA</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlrbu">SQLITE_FCNTL_RBU</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html">SQLITE_FCNTL_RESERVE_BYTES</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlresetcache">SQLITE_FCNTL_RESET_CACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlrollbackatomicwrite">SQLITE_FCNTL_ROLLBACK_ATOMIC_WRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html">SQLITE_FCNTL_SET_LOCKPROXYFILE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlsizehint">SQLITE_FCNTL_SIZE_HINT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlsizelimit">SQLITE_FCNTL_SIZE_LIMIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlsync">SQLITE_FCNTL_SYNC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlsyncomitted">SQLITE_FCNTL_SYNC_OMITTED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntltempfilename">SQLITE_FCNTL_TEMPFILENAME</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntltrace">SQLITE_FCNTL_TRACE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlvfsname">SQLITE_FCNTL_VFSNAME</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlvfspointer">SQLITE_FCNTL_VFS_POINTER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlwalblock">SQLITE_FCNTL_WAL_BLOCK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlwin32avretry">SQLITE_FCNTL_WIN32_AV_RETRY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlwin32gethandle">SQLITE_FCNTL_WIN32_GET_HANDLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlwin32sethandle">SQLITE_FCNTL_WIN32_SET_HANDLE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlzipvfs">SQLITE_FCNTL_ZIPVFS</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_function_flags">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_function_flags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_function_flags" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_deterministic.html">Function Flags</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_deterministic.html#sqlitedeterministic">SQLITE_DETERMINISTIC</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deterministic.html#sqlitedirectonly">SQLITE_DIRECTONLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deterministic.html#sqliteinnocuous">SQLITE_INNOCUOUS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deterministic.html#sqliteresultsubtype">SQLITE_RESULT_SUBTYPE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_deterministic.html#sqlitesubtype">SQLITE_SUBTYPE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_limits">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_limits</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_limits" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html">Run-Time Limit Categories</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitattached">SQLITE_LIMIT_ATTACHED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitcolumn">SQLITE_LIMIT_COLUMN</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitcompoundselect">SQLITE_LIMIT_COMPOUND_SELECT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitexprdepth">SQLITE_LIMIT_EXPR_DEPTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitfunctionarg">SQLITE_LIMIT_FUNCTION_ARG</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitlength">SQLITE_LIMIT_LENGTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitlikepatternlength">SQLITE_LIMIT_LIKE_PATTERN_LENGTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitsqllength">SQLITE_LIMIT_SQL_LENGTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimittriggerdepth">SQLITE_LIMIT_TRIGGER_DEPTH</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitvariablenumber">SQLITE_LIMIT_VARIABLE_NUMBER</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitvdbeop">SQLITE_LIMIT_VDBE_OP</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_limit_attached.html#sqlitelimitworkerthreads">SQLITE_LIMIT_WORKER_THREADS</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_locking_level">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_locking_level</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_locking_level" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">File Locking Levels</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_EXCLUSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_NONE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_PENDING</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_RESERVED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_lock_exclusive.html">SQLITE_LOCK_SHARED</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_open_flags">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_open_flags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_open_flags" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">Flags For File Open Operations</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_AUTOPROXY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_CREATE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_DELETEONCLOSE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_EXCLUSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_EXRESCODE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_FULLMUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MAIN_DB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MAIN_JOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_MEMORY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_NOFOLLOW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_NOMUTEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_PRIVATECACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_READONLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_READWRITE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_SHAREDCACHE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_SUBJOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_SUPER_JOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_TEMP_DB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_TEMP_JOURNAL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_TRANSIENT_DB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_URI</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_open_autoproxy.html">SQLITE_OPEN_WAL</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_prepare_flags">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_prepare_flags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_prepare_flags" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_prepare_normalize.html">Prepare Flags</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_prepare_normalize.html#sqlitepreparenormalize">SQLITE_PREPARE_NORMALIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_prepare_normalize.html#sqlitepreparenovtab">SQLITE_PREPARE_NO_VTAB</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_prepare_normalize.html#sqlitepreparepersistent">SQLITE_PREPARE_PERSISTENT</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_result_codes">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_result_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_result_codes" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/rescode.html">Result Codes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/rescode.html#abort">SQLITE_ABORT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#auth">SQLITE_AUTH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#busy">SQLITE_BUSY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#cantopen">SQLITE_CANTOPEN</a>, <a class="reference external" href="https://sqlite.org/rescode.html#constraint">SQLITE_CONSTRAINT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#corrupt">SQLITE_CORRUPT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#done">SQLITE_DONE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#empty">SQLITE_EMPTY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#error">SQLITE_ERROR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#format">SQLITE_FORMAT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#full">SQLITE_FULL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#internal">SQLITE_INTERNAL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#interrupt">SQLITE_INTERRUPT</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ioerr">SQLITE_IOERR</a>, <a class="reference external" href="https://sqlite.org/rescode.html#locked">SQLITE_LOCKED</a>, <a class="reference external" href="https://sqlite.org/rescode.html#mismatch">SQLITE_MISMATCH</a>, <a class="reference external" href="https://sqlite.org/rescode.html#misuse">SQLITE_MISUSE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#nolfs">SQLITE_NOLFS</a>, <a class="reference external" href="https://sqlite.org/rescode.html#nomem">SQLITE_NOMEM</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notadb">SQLITE_NOTADB</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notfound">SQLITE_NOTFOUND</a>, <a class="reference external" href="https://sqlite.org/rescode.html#notice">SQLITE_NOTICE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#ok">SQLITE_OK</a>, <a class="reference external" href="https://sqlite.org/rescode.html#perm">SQLITE_PERM</a>, <a class="reference external" href="https://sqlite.org/rescode.html#protocol">SQLITE_PROTOCOL</a>, <a class="reference external" href="https://sqlite.org/rescode.html#range">SQLITE_RANGE</a>, <a class="reference external" href="https://sqlite.org/rescode.html#readonly">SQLITE_READONLY</a>, <a class="reference external" href="https://sqlite.org/rescode.html#row">SQLITE_ROW</a>, <a class="reference external" href="https://sqlite.org/rescode.html#schema">SQLITE_SCHEMA</a>, <a class="reference external" href="https://sqlite.org/rescode.html#toobig">SQLITE_TOOBIG</a>, <a class="reference external" href="https://sqlite.org/rescode.html#warning">SQLITE_WARNING</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_statement_status">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_statement_status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_statement_status" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html">Status Parameters for prepared statements</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusautoindex">SQLITE_STMTSTATUS_AUTOINDEX</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html">SQLITE_STMTSTATUS_FILTER_HIT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusfiltermiss">SQLITE_STMTSTATUS_FILTER_MISS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusfullscanstep">SQLITE_STMTSTATUS_FULLSCAN_STEP</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusmemused">SQLITE_STMTSTATUS_MEMUSED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusreprepare">SQLITE_STMTSTATUS_REPREPARE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusrun">SQLITE_STMTSTATUS_RUN</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatussort">SQLITE_STMTSTATUS_SORT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_stmtstatus_counter.html#sqlitestmtstatusvmstep">SQLITE_STMTSTATUS_VM_STEP</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_status">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_status" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html">Status Parameters</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusmalloccount">SQLITE_STATUS_MALLOC_COUNT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusmallocsize">SQLITE_STATUS_MALLOC_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusmemoryused">SQLITE_STATUS_MEMORY_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatuspagecacheoverflow">SQLITE_STATUS_PAGECACHE_OVERFLOW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatuspagecachesize">SQLITE_STATUS_PAGECACHE_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatuspagecacheused">SQLITE_STATUS_PAGECACHE_USED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusparserstack">SQLITE_STATUS_PARSER_STACK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusscratchoverflow">SQLITE_STATUS_SCRATCH_OVERFLOW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusscratchsize">SQLITE_STATUS_SCRATCH_SIZE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_status_malloc_count.html#sqlitestatusscratchused">SQLITE_STATUS_SCRATCH_USED</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_sync">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_sync</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_sync" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">Synchronization Type Flags</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">SQLITE_SYNC_DATAONLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">SQLITE_SYNC_FULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_sync_dataonly.html">SQLITE_SYNC_NORMAL</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_trace_codes">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_trace_codes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_trace_codes" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_trace.html">SQL Trace Event Codes</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_trace.html#sqlitetraceclose">SQLITE_TRACE_CLOSE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_trace.html#sqlitetraceprofile">SQLITE_TRACE_PROFILE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_trace.html#sqlitetracerow">SQLITE_TRACE_ROW</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_trace.html#sqlitetracestmt">SQLITE_TRACE_STMT</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_txn_state">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_txn_state</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_txn_state" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_txn_none.html">Allowed return values from sqlite3_txn_state()</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_txn_none.html#sqlitetxnnone">SQLITE_TXN_NONE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_txn_none.html#sqlitetxnread">SQLITE_TXN_READ</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_txn_none.html#sqlitetxnwrite">SQLITE_TXN_WRITE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_virtual_table_configuration_options">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_virtual_table_configuration_options</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_virtual_table_configuration_options" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html">Virtual Table Configuration Options</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html#sqlitevtabconstraintsupport">SQLITE_VTAB_CONSTRAINT_SUPPORT</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html#sqlitevtabdirectonly">SQLITE_VTAB_DIRECTONLY</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html#sqlitevtabinnocuous">SQLITE_VTAB_INNOCUOUS</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_vtab_constraint_support.html#sqlitevtabusesallschemas">SQLITE_VTAB_USES_ALL_SCHEMAS</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_virtual_table_scan_flags">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_virtual_table_scan_flags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_virtual_table_scan_flags" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_index_scan_unique.html">Virtual Table Scan Flags</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_index_scan_unique.html">SQLITE_INDEX_SCAN_UNIQUE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_wal_checkpoint">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_wal_checkpoint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_wal_checkpoint" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">Checkpoint Mode Values</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_FULL</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_PASSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_RESTART</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_checkpoint_full.html">SQLITE_CHECKPOINT_TRUNCATE</a></p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="apsw.mapping_xshmlock_flags">
<span class="sig-prename descclassname"><span class="pre">apsw.</span></span><span class="sig-name descname"><span class="pre">mapping_xshmlock_flags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.mapping_xshmlock_flags" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">Flags for the xShmLock VFS method</a> constants</p>
<p><a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_EXCLUSIVE</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_LOCK</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_SHARED</a>, <a class="reference external" href="https://sqlite.org/c3ref/c_shm_exclusive.html">SQLITE_SHM_UNLOCK</a></p>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="extensions.html" class="btn btn-neutral float-left" title="Extensions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="connection.html" class="btn btn-neutral float-right" title="Connections to a database" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© <a href="copyright.html">Copyright</a> 2004-2024, Roger Binns <rogerb@rogerbinns.com>.
<span class="lastupdated">Last updated on Jun 16, 2024.
</span></p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
