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
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
|
<!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>Various interesting and useful bits of functionality — 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="Exceptions and Errors" href="exceptions.html" />
<link rel="prev" title="Best Practice" href="bestpractice.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"><a class="reference internal" href="apsw.html">APSW Module</a></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 current"><a class="current reference internal" href="#">Various interesting and useful bits of functionality</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pretty-printing">Pretty printing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#logging-and-tracebacks">Logging and tracebacks</a></li>
<li class="toctree-l2"><a class="reference internal" href="#virtual-tables">Virtual Tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#accessing-result-rows-by-column-name">Accessing result rows by column name</a></li>
<li class="toctree-l2"><a class="reference internal" href="#converting-types-into-and-out-of-sqlite">Converting types into and out of SQLite</a></li>
<li class="toctree-l2"><a class="reference internal" href="#detailed-query-information">Detailed Query Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-apsw.ext">API Reference</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.result_string"><code class="docutils literal notranslate"><span class="pre">result_string()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.DataClassRowFactory"><code class="docutils literal notranslate"><span class="pre">DataClassRowFactory</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DataClassRowFactory.get_dataclass"><code class="docutils literal notranslate"><span class="pre">DataClassRowFactory.get_dataclass()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DataClassRowFactory.get_type"><code class="docutils literal notranslate"><span class="pre">DataClassRowFactory.get_type()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DataClassRowFactory.__call__"><code class="docutils literal notranslate"><span class="pre">DataClassRowFactory.__call__()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.SQLiteTypeAdapter"><code class="docutils literal notranslate"><span class="pre">SQLiteTypeAdapter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.SQLiteTypeAdapter.to_sqlite_value"><code class="docutils literal notranslate"><span class="pre">SQLiteTypeAdapter.to_sqlite_value()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.register_adapter"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.register_adapter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.register_converter"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.register_converter()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.__call__"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.__call__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.adapt_value"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.adapt_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.convert_value"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.convert_value()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.wrap_bindings"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.wrap_bindings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.wrap_sequence_bindings"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.wrap_sequence_bindings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.DictAdapter"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.DictAdapter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.TypeConverterCursor"><code class="docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.TypeConverterCursor</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.log_sqlite"><code class="docutils literal notranslate"><span class="pre">log_sqlite()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.print_augmented_traceback"><code class="docutils literal notranslate"><span class="pre">print_augmented_traceback()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.index_info_to_dict"><code class="docutils literal notranslate"><span class="pre">index_info_to_dict()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.dbinfo"><code class="docutils literal notranslate"><span class="pre">dbinfo()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.format_query_table"><code class="docutils literal notranslate"><span class="pre">format_query_table()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.VTColumnAccess"><code class="docutils literal notranslate"><span class="pre">VTColumnAccess</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Index"><code class="docutils literal notranslate"><span class="pre">VTColumnAccess.By_Index</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Name"><code class="docutils literal notranslate"><span class="pre">VTColumnAccess.By_Name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Attr"><code class="docutils literal notranslate"><span class="pre">VTColumnAccess.By_Attr</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.get_column_names"><code class="docutils literal notranslate"><span class="pre">get_column_names()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.make_virtual_module"><code class="docutils literal notranslate"><span class="pre">make_virtual_module()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.generate_series_sqlite"><code class="docutils literal notranslate"><span class="pre">generate_series_sqlite()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.generate_series"><code class="docutils literal notranslate"><span class="pre">generate_series()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.query_info"><code class="docutils literal notranslate"><span class="pre">query_info()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.QueryDetails"><code class="docutils literal notranslate"><span class="pre">QueryDetails</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.query"><code class="docutils literal notranslate"><span class="pre">QueryDetails.query</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.bindings"><code class="docutils literal notranslate"><span class="pre">QueryDetails.bindings</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.first_query"><code class="docutils literal notranslate"><span class="pre">QueryDetails.first_query</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.query_remaining"><code class="docutils literal notranslate"><span class="pre">QueryDetails.query_remaining</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.is_explain"><code class="docutils literal notranslate"><span class="pre">QueryDetails.is_explain</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.is_readonly"><code class="docutils literal notranslate"><span class="pre">QueryDetails.is_readonly</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.has_vdbe"><code class="docutils literal notranslate"><span class="pre">QueryDetails.has_vdbe</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.bindings_count"><code class="docutils literal notranslate"><span class="pre">QueryDetails.bindings_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.bindings_names"><code class="docutils literal notranslate"><span class="pre">QueryDetails.bindings_names</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.description"><code class="docutils literal notranslate"><span class="pre">QueryDetails.description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.description_full"><code class="docutils literal notranslate"><span class="pre">QueryDetails.description_full</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.expanded_sql"><code class="docutils literal notranslate"><span class="pre">QueryDetails.expanded_sql</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.actions"><code class="docutils literal notranslate"><span class="pre">QueryDetails.actions</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.explain"><code class="docutils literal notranslate"><span class="pre">QueryDetails.explain</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryDetails.query_plan"><code class="docutils literal notranslate"><span class="pre">QueryDetails.query_plan</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.QueryAction"><code class="docutils literal notranslate"><span class="pre">QueryAction</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.action"><code class="docutils literal notranslate"><span class="pre">QueryAction.action</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.action_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.action_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.column_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.column_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.database_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.database_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.file_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.file_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.function_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.function_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.module_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.module_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.operation"><code class="docutils literal notranslate"><span class="pre">QueryAction.operation</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.pragma_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.pragma_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.pragma_value"><code class="docutils literal notranslate"><span class="pre">QueryAction.pragma_value</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.table_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.table_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.trigger_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.trigger_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.trigger_or_view"><code class="docutils literal notranslate"><span class="pre">QueryAction.trigger_or_view</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryAction.view_name"><code class="docutils literal notranslate"><span class="pre">QueryAction.view_name</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.QueryPlan"><code class="docutils literal notranslate"><span class="pre">QueryPlan</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryPlan.detail"><code class="docutils literal notranslate"><span class="pre">QueryPlan.detail</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.QueryPlan.sub"><code class="docutils literal notranslate"><span class="pre">QueryPlan.sub</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.VDBEInstruction"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.addr"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.addr</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.opcode"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.opcode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.comment"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.comment</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.p1"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.p1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.p2"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.p2</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.p3"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.p3</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.p4"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.p4</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.VDBEInstruction.p5"><code class="docutils literal notranslate"><span class="pre">VDBEInstruction.p5</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.filename"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.filename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.header"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.header</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.page_size"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.page_size</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.write_format"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.write_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.read_format"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.read_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.reserved_bytes"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.reserved_bytes</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.file_change_counter"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.file_change_counter</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.page_count"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.page_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.freelist_pages"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.freelist_pages</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.schema_cookie"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.schema_cookie</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.schema_format"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.schema_format</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.default_cache_size"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.default_cache_size</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.autovacuum_top_root"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.autovacuum_top_root</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.text_encoding"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.text_encoding</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.user_version"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.user_version</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.incremental_vacuum"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.incremental_vacuum</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.application_id"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.application_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.version_valid_for"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.version_valid_for</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.DatabaseFileInfo.sqlite_version"><code class="docutils literal notranslate"><span class="pre">DatabaseFileInfo.sqlite_version</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.JournalFileInfo"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.filename"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.filename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.header"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.header</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.header_valid"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.header_valid</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.page_count"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.page_count</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.random_nonce"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.random_nonce</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.initial_pages"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.initial_pages</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.sector_size"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.sector_size</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.JournalFileInfo.page_size"><code class="docutils literal notranslate"><span class="pre">JournalFileInfo.page_size</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#apsw.ext.WALFileInfo"><code class="docutils literal notranslate"><span class="pre">WALFileInfo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.filename"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.filename</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.magic_number"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.magic_number</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.format_version"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.format_version</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.page_size"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.page_size</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.checkpoint_sequence_number"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.checkpoint_sequence_number</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.salt_1"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.salt_1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.salt_2"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.salt_2</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.checksum_1"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.checksum_1</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#apsw.ext.WALFileInfo.checksum_2"><code class="docutils literal notranslate"><span class="pre">WALFileInfo.checksum_2</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</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">Various interesting and useful bits of functionality</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/ext.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
<a href="bestpractice.html" class="btn btn-neutral float-left" title="Best Practice" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="exceptions.html" class="btn btn-neutral float-right" title="Exceptions and Errors" 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="various-interesting-and-useful-bits-of-functionality">
<h1>Various interesting and useful bits of functionality<a class="headerlink" href="#various-interesting-and-useful-bits-of-functionality" title="Link to this heading"></a></h1>
<p>You need to import <cite>apsw.ext</cite> to use this module.</p>
<section id="pretty-printing">
<h2>Pretty printing<a class="headerlink" href="#pretty-printing" title="Link to this heading"></a></h2>
<p><a class="reference internal" href="#apsw.ext.format_query_table" title="apsw.ext.format_query_table"><code class="xref py py-meth docutils literal notranslate"><span class="pre">format_query_table()</span></code></a> makes nicely formatted query output - see
the <a class="reference internal" href="example.html#example-format-query"><span class="std std-ref">the example</span></a>.</p>
</section>
<section id="logging-and-tracebacks">
<h2>Logging and tracebacks<a class="headerlink" href="#logging-and-tracebacks" title="Link to this heading"></a></h2>
<p>You can use <a class="reference internal" href="#apsw.ext.log_sqlite" title="apsw.ext.log_sqlite"><code class="xref py py-meth docutils literal notranslate"><span class="pre">log_sqlite()</span></code></a> to forward SQLite log messages
to the <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">logging</span></code></a> module.</p>
<p><a class="reference internal" href="#apsw.ext.print_augmented_traceback" title="apsw.ext.print_augmented_traceback"><code class="xref py py-meth docutils literal notranslate"><span class="pre">print_augmented_traceback()</span></code></a> prints an exception the usual way
but also includes local variables, which <a class="reference internal" href="exceptions.html#augmentedstacktraces"><span class="std std-ref">APSW includes</span></a> to make debugging quicker and easier.</p>
</section>
<section id="virtual-tables">
<h2>Virtual Tables<a class="headerlink" href="#virtual-tables" title="Link to this heading"></a></h2>
<p>Use <a class="reference internal" href="#apsw.ext.index_info_to_dict" title="apsw.ext.index_info_to_dict"><code class="xref py py-meth docutils literal notranslate"><span class="pre">index_info_to_dict()</span></code></a> to get <a class="reference internal" href="vtable.html#apsw.IndexInfo" title="apsw.IndexInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.IndexInfo</span></code></a>
in an easier to print and work with format.</p>
<p>Use <a class="reference internal" href="#apsw.ext.make_virtual_module" title="apsw.ext.make_virtual_module"><code class="xref py py-meth docutils literal notranslate"><span class="pre">make_virtual_module()</span></code></a> to easily turn a Python function
into a virtual table source.</p>
<p><a class="reference internal" href="#apsw.ext.generate_series" title="apsw.ext.generate_series"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_series()</span></code></a> and <a class="reference internal" href="#apsw.ext.generate_series_sqlite" title="apsw.ext.generate_series_sqlite"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_series_sqlite()</span></code></a> provide
<a class="reference external" href="https://sqlite.org/series.html">generate_series</a>.</p>
</section>
<section id="accessing-result-rows-by-column-name">
<h2>Accessing result rows by column name<a class="headerlink" href="#accessing-result-rows-by-column-name" title="Link to this heading"></a></h2>
<p>See <a class="reference internal" href="example.html#example-colnames"><span class="std std-ref">the example</span></a>.</p>
<p>Use <a class="reference internal" href="#apsw.ext.DataClassRowFactory" title="apsw.ext.DataClassRowFactory"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.ext.DataClassRowFactory</span></code></a> as a
<a class="reference internal" href="connection.html#apsw.Connection.row_trace" title="apsw.Connection.row_trace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">apsw.Connection.row_trace</span></code></a> for an entire connection, or
<a class="reference internal" href="cursor.html#apsw.Cursor.row_trace" title="apsw.Cursor.row_trace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">apsw.Cursor.row_trace</span></code></a> for a specific cursor.</p>
</section>
<section id="converting-types-into-and-out-of-sqlite">
<span id="typeconversion"></span><h2>Converting types into and out of SQLite<a class="headerlink" href="#converting-types-into-and-out-of-sqlite" title="Link to this heading"></a></h2>
<p>SQLite only stores and returns 5 types:</p>
<ul class="simple">
<li><p>None</p></li>
<li><p>int</p></li>
<li><p>float</p></li>
<li><p>str</p></li>
<li><p>bytes</p></li>
</ul>
<p>Use <a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory" title="apsw.ext.TypesConverterCursorFactory"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypesConverterCursorFactory</span></code></a> as
<a class="reference internal" href="connection.html#apsw.Connection.cursor_factory" title="apsw.Connection.cursor_factory"><code class="xref py py-attr docutils literal notranslate"><span class="pre">apsw.Connection.cursor_factory</span></code></a> to adapt values going into
SQLite, and convert them coming out. See <a class="reference internal" href="example.html#example-type-conversion"><span class="std std-ref">the example</span></a>.</p>
<p>To convert values going into SQLite, do either of:</p>
<ul class="simple">
<li><p>Inherit from <a class="reference internal" href="#apsw.ext.SQLiteTypeAdapter" title="apsw.ext.SQLiteTypeAdapter"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.ext.SQLiteTypeAdapter</span></code></a> and define a
<em>to_sqlite_value</em> method on the class</p></li>
<li><p>Call <a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.register_adapter" title="apsw.ext.TypesConverterCursorFactory.register_adapter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.register_adapter()</span></code></a> with the
type and a adapter function</p></li>
</ul>
<p>To adapt values coming out of SQLite:</p>
<ul class="simple">
<li><p>Call <a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory.register_converter" title="apsw.ext.TypesConverterCursorFactory.register_converter"><code class="xref py py-meth docutils literal notranslate"><span class="pre">TypesConverterCursorFactory.register_converter()</span></code></a> with the
exact type string in the table and a converter function</p></li>
</ul>
</section>
<section id="detailed-query-information">
<h2>Detailed Query Information<a class="headerlink" href="#detailed-query-information" title="Link to this heading"></a></h2>
<p>SQLite can provide lots of information about queries. The
<a class="reference internal" href="#apsw.ext.query_info" title="apsw.ext.query_info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">query_info()</span></code></a> function can gather them up
for you. This includes:</p>
<ul class="simple">
<li><p><strong>readonly</strong> if the query makes no direct changes</p></li>
<li><p><strong>first_query</strong> if multiple queries are provided</p></li>
<li><p><strong>actions</strong> which databases, tables, columns, functions, views etc
are referenced - see <a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">actions</a></p></li>
<li><p><strong>query_plan</strong> which indices, tables scans etc are used to find the
query results - see <a class="reference external" href="https://sqlite.org/eqp.html">query plans</a></p></li>
<li><p><strong>explain</strong> for the low level steps taken inside SQLite - see
<a class="reference external" href="https://sqlite.org/opcode.html">SQLite bytecode</a></p></li>
</ul>
<p>See <a class="reference internal" href="example.html#example-query-details"><span class="std std-ref">the example</span></a>.</p>
</section>
<section id="module-apsw.ext">
<span id="api-reference"></span><h2>API Reference<a class="headerlink" href="#module-apsw.ext" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.result_string">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">result_string</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/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#result_string"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.result_string" title="Link to this definition"></a></dt>
<dd><p>Turns a result or extended result code into a string.
The appropriate mapping based on the value is used.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.DataClassRowFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">DataClassRowFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rename</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dataclass_kwargs</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#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/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#DataClassRowFactory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.DataClassRowFactory" title="Link to this definition"></a></dt>
<dd><p>Returns each row as a <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclass</span></code></a>, accessible by column name.</p>
<p>To use set an instance as <a class="reference internal" href="connection.html#apsw.Connection.row_trace" title="apsw.Connection.row_trace"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Connection.row_trace</span></code></a> to affect all <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>, or on a specific cursor:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">connection</span><span class="o">.</span><span class="n">row_trace</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">DataClassRowFactory</span><span class="p">()</span>
<span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">connection</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT title, sum(orders) AS total, ..."</span><span class="p">):</span>
<span class="c1"># You can now access by name</span>
<span class="nb">print</span> <span class="p">(</span><span class="n">row</span><span class="o">.</span><span class="n">title</span><span class="p">,</span> <span class="n">row</span><span class="o">.</span><span class="n">total</span><span class="p">)</span>
<span class="c1"># you can get the underlying description</span>
<span class="nb">print</span> <span class="p">(</span><span class="n">row</span><span class="o">.</span><span class="n">__description__</span><span class="p">)</span>
</pre></div>
</div>
<p>You can use as many instances of this class as you want, each across as many
<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> as you want.</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>rename</strong> – Column names could be duplicated, or not
valid in Python (eg a column named <cite>continue</cite>).
If <cite>rename</cite> is True, then invalid/duplicate names are replaced
with <cite>_</cite> and their position starting at zero. For example <cite>title,
total, title, continue</cite> would become <cite>title, total, _2, _3</cite>. If
<cite>rename</cite> is False then problem column names will result in
<a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.12)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> raised by <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#dataclasses.make_dataclass" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">dataclasses.make_dataclass()</span></code></a></p></li>
<li><p><strong>dataclass_kwargs</strong> – Additional parameters when creating the dataclass
as described in <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#dataclasses.dataclass" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">dataclasses.dataclass()</span></code></a>. For example you may
want <cite>frozen = True</cite> to make the dataclass read-only, or <cite>slots = True</cite>
to reduce memory consumption.</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.DataClassRowFactory.get_dataclass">
<span class="sig-name descname"><span class="pre">get_dataclass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</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#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#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><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 class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></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/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</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/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><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apsw/ext.html#DataClassRowFactory.get_dataclass"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.DataClassRowFactory.get_dataclass" title="Link to this definition"></a></dt>
<dd><p>Returns dataclass and tuple of (potentially renamed) column names</p>
<p>The dataclass is what is returned for each row with that
<a class="reference internal" href="cursor.html#apsw.Cursor.get_description" title="apsw.Cursor.get_description"><code class="xref py py-meth docutils literal notranslate"><span class="pre">description</span></code></a></p>
<p>This method caches its results.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.DataClassRowFactory.get_type">
<span class="sig-name descname"><span class="pre">get_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#DataClassRowFactory.get_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.DataClassRowFactory.get_type" title="Link to this definition"></a></dt>
<dd><p>Returns the <a class="reference external" href="https://docs.python.org/3/library/typing.html">type hint</a> to use in the dataclass based on the type in the <a class="reference internal" href="cursor.html#apsw.Cursor.get_description" title="apsw.Cursor.get_description"><code class="xref py py-meth docutils literal notranslate"><span class="pre">description</span></code></a></p>
<p><a class="reference external" href="https://www.sqlite.org/datatype3.html#affname">SQLite’s affinity rules</a> are followed.</p>
<p>The values have no effect on how your program runs, but can be used by tools like
mypy. Column information like whether <cite>null</cite> is allowed is not present, so
this is just a hint.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.DataClassRowFactory.__call__">
<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cursor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><span class="pre">apsw.Cursor</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">row</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.SQLiteValues" title="apsw.SQLiteValues"><span class="pre">apsw.SQLiteValues</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Any</span></span></span><a class="reference internal" href="_modules/apsw/ext.html#DataClassRowFactory.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.DataClassRowFactory.__call__" title="Link to this definition"></a></dt>
<dd><p>What the row tracer calls</p>
<p>This <a class="reference internal" href="#apsw.ext.DataClassRowFactory.get_dataclass" title="apsw.ext.DataClassRowFactory.get_dataclass"><code class="xref py py-meth docutils literal notranslate"><span class="pre">looks</span> <span class="pre">up</span></code></a> the dataclass and column
names, and then returns an instance of the dataclass.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.SQLiteTypeAdapter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">SQLiteTypeAdapter</span></span><a class="reference internal" href="_modules/apsw/ext.html#SQLiteTypeAdapter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.SQLiteTypeAdapter" title="Link to this definition"></a></dt>
<dd><p>A metaclass to indicate conversion to SQLite types is supported</p>
<p>This is one way to indicate your type supports conversion to a
value supported by SQLite. You can either inherit from this class,
or call the register 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">ext</span><span class="o">.</span><span class="n">SQLiteTypeAdapter</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="n">YourClassHere</span><span class="p">)</span>
</pre></div>
</div>
<p>Doing either is entirely sufficient and there is no need to
register with <a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory" title="apsw.ext.TypesConverterCursorFactory"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypesConverterCursorFactory</span></code></a></p>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.SQLiteTypeAdapter.to_sqlite_value">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">to_sqlite_value</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 internal" href="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">apsw.SQLiteValue</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#SQLiteTypeAdapter.to_sqlite_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.SQLiteTypeAdapter.to_sqlite_value" title="Link to this definition"></a></dt>
<dd><p>Return a SQLite compatible value for this object</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">TypesConverterCursorFactory</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">abstract_base_class</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/abc.html#abc.ABCMeta" title="(in Python v3.12)"><span class="pre">ABCMeta</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">SQLiteTypeAdapter</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory" title="Link to this definition"></a></dt>
<dd><p>Provides cursors that can convert objects into one of the types supported by SQLite,
or back from SQLite</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>abstract_base_class</strong> – Which metaclass to consider as conversion capable</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.register_adapter">
<span class="sig-name descname"><span class="pre">register_adapter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">klass</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#type" title="(in Python v3.12)"><span class="pre">type</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">callable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">apsw.SQLiteValue</span></a><span class="p"><span class="pre">]</span></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="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.register_adapter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.register_adapter" title="Link to this definition"></a></dt>
<dd><p>Registers a callable that converts from <cite>klass</cite> to one of the supported SQLite types</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.register_converter">
<span class="sig-name descname"><span class="pre">register_converter</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>, <em class="sig-param"><span class="n"><span class="pre">callable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">apsw.SQLiteValue</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></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="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.register_converter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.register_converter" title="Link to this definition"></a></dt>
<dd><p>Registers a callable that converts from a SQLite value</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.__call__">
<span class="sig-name descname"><span class="pre">__call__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">apsw.Connection</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 internal" href="#apsw.ext.TypesConverterCursorFactory.TypeConverterCursor" title="apsw.ext.TypesConverterCursorFactory.TypeConverterCursor"><span class="pre">TypeConverterCursor</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.__call__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.__call__" title="Link to this definition"></a></dt>
<dd><p>Returns a new convertor <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> for the <cite>connection</cite></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.adapt_value">
<span class="sig-name descname"><span class="pre">adapt_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"><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 internal" href="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">apsw.SQLiteValue</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.adapt_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.adapt_value" title="Link to this definition"></a></dt>
<dd><p>Returns SQLite representation of <cite>value</cite></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.convert_value">
<span class="sig-name descname"><span class="pre">convert_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">schematype</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">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">apsw.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"><span class="pre">Any</span></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.convert_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.convert_value" title="Link to this definition"></a></dt>
<dd><p>Returns Python object from schema type and SQLite value</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.wrap_bindings">
<span class="sig-name descname"><span class="pre">wrap_bindings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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 internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.wrap_bindings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.wrap_bindings" title="Link to this definition"></a></dt>
<dd><p>Wraps bindings that are supplied to underlying execute</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.wrap_sequence_bindings">
<span class="sig-name descname"><span class="pre">wrap_sequence_bindings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sequenceofbindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Generator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.wrap_sequence_bindings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.wrap_sequence_bindings" title="Link to this definition"></a></dt>
<dd><p>Wraps a sequence of bindings that are supplied to the underlying executemany</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.DictAdapter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">DictAdapter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">factory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory" title="apsw.ext.TypesConverterCursorFactory"><span class="pre">TypesConverterCursorFactory</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</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/collections.abc.html#collections.abc.Mapping" title="(in Python v3.12)"><span class="pre">collections.abc.Mapping</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 internal" href="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><span class="pre">apsw.SQLiteValue</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.DictAdapter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.DictAdapter" title="Link to this definition"></a></dt>
<dd><p>Used to wrap dictionaries supplied as bindings</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.TypeConverterCursor">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">TypeConverterCursor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">connection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">Connection</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">factory</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apsw.ext.TypesConverterCursorFactory" title="apsw.ext.TypesConverterCursorFactory"><span class="pre">TypesConverterCursorFactory</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.TypeConverterCursor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.TypeConverterCursor" title="Link to this definition"></a></dt>
<dd><p>Cursor used to do conversions</p>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.TypeConverterCursor.execute">
<span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statements</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">bindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">can_cache</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prepare_flags</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>, <em class="sig-param"><span class="n"><span class="pre">explain</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">-1</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 internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><span class="pre">apsw.Cursor</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.TypeConverterCursor.execute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.TypeConverterCursor.execute" title="Link to this definition"></a></dt>
<dd><p>Executes the statements doing conversions on supplied and returned values</p>
<p>See <a class="reference internal" href="cursor.html#apsw.Cursor.execute" title="apsw.Cursor.execute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">apsw.Cursor.execute()</span></code></a> for parameter details</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="apsw.ext.TypesConverterCursorFactory.TypeConverterCursor.executemany">
<span class="sig-name descname"><span class="pre">executemany</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">statements</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">sequenceofbindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">can_cache</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prepare_flags</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>, <em class="sig-param"><span class="n"><span class="pre">explain</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">-1</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 internal" href="cursor.html#apsw.Cursor" title="apsw.Cursor"><span class="pre">apsw.Cursor</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#TypesConverterCursorFactory.TypeConverterCursor.executemany"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.TypesConverterCursorFactory.TypeConverterCursor.executemany" title="Link to this definition"></a></dt>
<dd><p>Executes the statements against each item in sequenceofbindings, doing conversions on supplied and returned values</p>
<p>See <a class="reference internal" href="cursor.html#apsw.Cursor.executemany" title="apsw.Cursor.executemany"><code class="xref py py-meth docutils literal notranslate"><span class="pre">apsw.Cursor.executemany()</span></code></a> for parameter details</p>
</dd></dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.log_sqlite">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">log_sqlite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</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">logging.ERROR</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logger</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/logging.html#logging.Logger" title="(in Python v3.12)"><span class="pre">Logger</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</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="reference internal" href="_modules/apsw/ext.html#log_sqlite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.log_sqlite" title="Link to this definition"></a></dt>
<dd><p>Send SQLite <a class="reference external" href="https://www.sqlite.org/errlog.html">log messages</a> to <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">logging</span></code></a></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>level</strong> – highest <a class="reference external" href="https://docs.python.org/3/library/logging.html#levels">level</a> to log at</p></li>
<li><p><strong>logger</strong> – Use the specific logger</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.print_augmented_traceback">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">print_augmented_traceback</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exc_type</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#type" title="(in Python v3.12)"><span class="pre">type</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#BaseException" title="(in Python v3.12)"><span class="pre">BaseException</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exc_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/exceptions.html#BaseException" title="(in Python v3.12)"><span class="pre">BaseException</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">exc_traceback</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/types.html#types.TracebackType" title="(in Python v3.12)"><span class="pre">TracebackType</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file</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/typing.html#typing.TextIO" title="(in Python v3.12)"><span class="pre">TextIO</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</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="reference internal" href="_modules/apsw/ext.html#print_augmented_traceback"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.print_augmented_traceback" title="Link to this definition"></a></dt>
<dd><p>Prints a standard exception, but also includes the value of variables in each stack frame
which APSW <a class="reference internal" href="exceptions.html#augmentedstacktraces"><span class="std std-ref">adds</span></a> to help diagnostics and debugging.</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>exc_type</strong> – The exception type</p></li>
<li><p><strong>exc_value</strong> – The exception value</p></li>
<li><p><strong>exc_traceback</strong> – Traceback for the exception</p></li>
<li><p><strong>file</strong> – (default <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code>) Where the print goes</p></li>
</ul>
</dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">try</span><span class="p">:</span>
<span class="o">....</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">print_augmented_traceback</span><span class="p">(</span><span class="o">*</span><span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">())</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.index_info_to_dict">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">index_info_to_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">o</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="vtable.html#apsw.IndexInfo" title="apsw.IndexInfo"><span class="pre">IndexInfo</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">column_names</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#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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rowid_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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'__ROWID__'</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#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/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apsw/ext.html#index_info_to_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.index_info_to_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a <a class="reference internal" href="vtable.html#apsw.IndexInfo" title="apsw.IndexInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.IndexInfo</span></code></a> as a dictionary.</p>
<p>If <em>column_names</em> is supplied then additional keys with column
names are present, using <em>rowid_name</em> for the rowid.</p>
<p>Here is an example response:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">query</span> <span class="o">=</span> <span class="s1">'''</span>
<span class="s1"> SELECT orderid, note FROM sales WHERE</span>
<span class="s1"> price > 74.99</span>
<span class="s1"> AND quantity<=?</span>
<span class="s1"> AND customer in ('Acme Widgets', 'Acme Industries')</span>
<span class="s1"> ORDER BY date desc</span>
<span class="s1"> LIMIT 10'''</span>
<span class="p">{</span><span class="s1">'aConstraint'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'collation'</span><span class="p">:</span> <span class="s1">'BINARY'</span><span class="p">,</span>
<span class="s1">'iColumn'</span><span class="p">:</span> <span class="mi">5</span><span class="p">,</span>
<span class="s1">'iColumn_name'</span><span class="p">:</span> <span class="s1">'price'</span><span class="p">,</span>
<span class="s1">'op'</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s1">'op_str'</span><span class="p">:</span> <span class="s1">'SQLITE_INDEX_CONSTRAINT_GT'</span><span class="p">,</span>
<span class="s1">'rhs'</span><span class="p">:</span> <span class="mf">74.99</span><span class="p">,</span>
<span class="s1">'usable'</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'collation'</span><span class="p">:</span> <span class="s1">'BINARY'</span><span class="p">,</span>
<span class="s1">'iColumn'</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
<span class="s1">'iColumn_name'</span><span class="p">:</span> <span class="s1">'quantity'</span><span class="p">,</span>
<span class="s1">'op'</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
<span class="s1">'op_str'</span><span class="p">:</span> <span class="s1">'SQLITE_INDEX_CONSTRAINT_LE'</span><span class="p">,</span>
<span class="s1">'rhs'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">'usable'</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'collation'</span><span class="p">:</span> <span class="s1">'BINARY'</span><span class="p">,</span>
<span class="s1">'iColumn'</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
<span class="s1">'iColumn_name'</span><span class="p">:</span> <span class="s1">'customer'</span><span class="p">,</span>
<span class="s1">'op'</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
<span class="s1">'op_str'</span><span class="p">:</span> <span class="s1">'SQLITE_INDEX_CONSTRAINT_EQ'</span><span class="p">,</span>
<span class="s1">'rhs'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">'usable'</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'collation'</span><span class="p">:</span> <span class="s1">'BINARY'</span><span class="p">,</span>
<span class="s1">'op'</span><span class="p">:</span> <span class="mi">73</span><span class="p">,</span>
<span class="s1">'op_str'</span><span class="p">:</span> <span class="s1">'SQLITE_INDEX_CONSTRAINT_LIMIT'</span><span class="p">,</span>
<span class="s1">'rhs'</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span>
<span class="s1">'usable'</span><span class="p">:</span> <span class="kc">True</span><span class="p">}],</span>
<span class="s1">'aConstraintUsage'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'argvIndex'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'in'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s1">'omit'</span><span class="p">:</span> <span class="kc">False</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'argvIndex'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'in'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s1">'omit'</span><span class="p">:</span> <span class="kc">False</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'argvIndex'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'in'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'omit'</span><span class="p">:</span> <span class="kc">False</span><span class="p">},</span>
<span class="p">{</span><span class="s1">'argvIndex'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'in'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> <span class="s1">'omit'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}],</span>
<span class="s1">'aOrderBy'</span><span class="p">:</span> <span class="p">[{</span><span class="s1">'desc'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="s1">'iColumn'</span><span class="p">:</span> <span class="mi">9</span><span class="p">,</span> <span class="s1">'iColumn_name'</span><span class="p">:</span> <span class="s1">'date'</span><span class="p">}],</span>
<span class="s1">'colUsed'</span><span class="p">:</span> <span class="p">{</span><span class="mi">0</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">8</span><span class="p">,</span> <span class="mi">9</span><span class="p">},</span>
<span class="s1">'colUsed_names'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'date'</span><span class="p">,</span> <span class="s1">'note'</span><span class="p">,</span> <span class="s1">'customer'</span><span class="p">,</span> <span class="s1">'quantity'</span><span class="p">,</span> <span class="s1">'orderid'</span><span class="p">,</span> <span class="s1">'price'</span><span class="p">},</span>
<span class="s1">'distinct'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'estimatedCost'</span><span class="p">:</span> <span class="mf">5e+98</span><span class="p">,</span>
<span class="s1">'estimatedRows'</span><span class="p">:</span> <span class="mi">25</span><span class="p">,</span>
<span class="s1">'idxFlags'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'idxFlags_set'</span><span class="p">:</span> <span class="nb">set</span><span class="p">(),</span>
<span class="s1">'idxNum'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'idxStr'</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">'nConstraint'</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
<span class="s1">'nOrderBy'</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s1">'orderByConsumed'</span><span class="p">:</span> <span class="kc">False</span><span class="p">}</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.dbinfo">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">dbinfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">Connection</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'main'</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 internal" href="#apsw.ext.DatabaseFileInfo" title="apsw.ext.DatabaseFileInfo"><span class="pre">DatabaseFileInfo</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#apsw.ext.JournalFileInfo" title="apsw.ext.JournalFileInfo"><span class="pre">JournalFileInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#apsw.ext.WALFileInfo" title="apsw.ext.WALFileInfo"><span class="pre">WALFileInfo</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apsw/ext.html#dbinfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.dbinfo" title="Link to this definition"></a></dt>
<dd><p>Extracts fields from the database, journal, and wal files</p>
<p>Based on the <a class="reference external" href="https://www.sqlite.org/fileformat2.html">file format description</a>. The
headers are read using <a class="reference internal" href="connection.html#apsw.Connection.read" title="apsw.Connection.read"><code class="xref py py-meth docutils literal notranslate"><span class="pre">apsw.Connection.read()</span></code></a> so you see inside encrypted, compressed,
zip etc formats, not necessarily the actual on disk file.</p>
<p>Memory databases return <cite>None</cite> for both.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.format_query_table">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">format_query_table</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">apsw.Connection</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</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">bindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">colour</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>, <em class="sig-param"><span class="n"><span class="pre">quote</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>, <em class="sig-param"><span class="n"><span class="pre">string_sanitize</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><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="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="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">0</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">1</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="m"><span class="pre">2</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">binary</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><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 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/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">lambda</span> <span class="pre">x:</span> <span class="pre">...</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">null</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'(null)'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">truncate</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">4096</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">truncate_val</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><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'</span> <span class="pre">...'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text_width</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">80</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_unicode</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">word_wrap</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">True</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#format_query_table"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.format_query_table" title="Link to this definition"></a></dt>
<dd><p>Produces query output in an attractive text table</p>
<p>See <a class="reference internal" href="example.html#example-format-query"><span class="std std-ref">the example</span></a>.</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>db</strong> – Connection to run the query on</p></li>
<li><p><strong>query</strong> – Query to run</p></li>
<li><p><strong>bindings</strong> – Bindings for query (if needed)</p></li>
<li><p><strong>colour</strong> – If True then <a class="reference external" href="https://en.wikipedia.org/wiki/ANSI_escape_code#Colors">ANSI colours</a> are
used to outline the header, and show the type of each value.</p></li>
<li><p><strong>quote</strong> – If True then <a class="reference internal" href="apsw.html#apsw.format_sql_value" title="apsw.format_sql_value"><code class="xref py py-meth docutils literal notranslate"><span class="pre">apsw.format_sql_value()</span></code></a> is used to get a textual representation of a
value</p></li>
<li><p><strong>string_sanitize</strong> – <p>If this is a callable then each string is passed to it for cleaning up.
Bigger numbers give more sanitization to the string. Using an example source string of:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="sd">'''hello \\ \t\f\0日本語 world'''</span>
</pre></div>
</div>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>param</p></th>
<th class="head"><p>example output</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>0</p></td>
<td><p>hello \\ 0日本語 world</p></td>
<td><p>Various whitespace (eg tabs, vertical form feed) are replaced. backslashes
are escaped, embedded nulls become \0</p></td>
</tr>
<tr class="row-odd"><td><p>1</p></td>
<td><p>hello \\ \0{CJK UNIFIED IDEOGRAPH-65E5}{CJK UNIFIED IDEOGRAPH-672C}{CJK UNIFIED IDEOGRAPH-8A9E} world</p></td>
<td><p>After step 0, all non-ascii characters are replaced with their <a class="reference external" href="https://docs.python.org/3/library/unicodedata.html#unicodedata.name" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">unicodedata.name()</span></code></a> or \x and hex value</p></td>
</tr>
<tr class="row-even"><td><p>2</p></td>
<td><p>hello.\……..world</p></td>
<td><p>All non-ascii characters and whitespace are replaced by a dot</p></td>
</tr>
</tbody>
</table>
</p></li>
<li><p><strong>binary</strong> – Called to convert bytes to string</p></li>
<li><p><strong>null</strong> – How to represent the null value</p></li>
<li><p><strong>truncate</strong> – How many characters to truncate long strings at (after sanitization)</p></li>
<li><p><strong>truncate_val</strong> – Appended to truncated strings to show it was truncated</p></li>
<li><p><strong>text_width</strong> – Maximum output width to generate</p></li>
<li><p><strong>use_unicode</strong> – If True then unicode line drawing characters are used. If False then +—+ and | are
used.</p></li>
<li><p><strong>word_wrap</strong> – If True then <a class="reference external" href="https://docs.python.org/3/library/textwrap.html#module-textwrap" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">textwrap</span></code></a> is used to break wide text to fit column width</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.VTColumnAccess">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">VTColumnAccess</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">_not_given</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#VTColumnAccess"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.VTColumnAccess" title="Link to this definition"></a></dt>
<dd><p>How the column value is accessed from a row, for <a class="reference internal" href="#apsw.ext.make_virtual_module" title="apsw.ext.make_virtual_module"><code class="xref py py-meth docutils literal notranslate"><span class="pre">make_virtual_module()</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VTColumnAccess.By_Index">
<span class="sig-name descname"><span class="pre">By_Index</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#apsw.ext.VTColumnAccess.By_Index" title="Link to this definition"></a></dt>
<dd><p>By number like with tuples and lists - eg <code class="code docutils literal notranslate"><span class="pre">row[3]</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VTColumnAccess.By_Name">
<span class="sig-name descname"><span class="pre">By_Name</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#apsw.ext.VTColumnAccess.By_Name" title="Link to this definition"></a></dt>
<dd><p>By name like with dicts - eg <code class="code docutils literal notranslate"><span class="pre">row['quantity']</span></code></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VTColumnAccess.By_Attr">
<span class="sig-name descname"><span class="pre">By_Attr</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#apsw.ext.VTColumnAccess.By_Attr" title="Link to this definition"></a></dt>
<dd><p>By attribute like with <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclasses</span></code></a> - eg <code class="code docutils literal notranslate"><span class="pre">row.quantity</span></code></p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.get_column_names">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">get_column_names</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">row</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/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</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#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/typing.html#typing.Sequence" title="(in Python v3.12)"><span class="pre">Sequence</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="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#apsw.ext.VTColumnAccess" title="apsw.ext.VTColumnAccess"><span class="pre">VTColumnAccess</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apsw/ext.html#get_column_names"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.get_column_names" title="Link to this definition"></a></dt>
<dd><p>Works out column names and access given an example row</p>
<p><em>row</em> can be an instance of a row, or the class used to make
one (eg a <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclass</span></code></a>)</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Access</p></th>
<th class="head"><p>Column names From</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#dataclasses.is_dataclass" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">dataclasses.is_dataclass()</span></code></a></p></td>
<td><p><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Attr" title="apsw.ext.VTColumnAccess.By_Attr"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VTColumnAccess.By_Attr</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#dataclasses.fields" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">dataclasses.fields()</span></code></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#isinstance" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance</span></code></a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>) and <a class="reference external" href="https://docs.python.org/3/library/functions.html#hasattr" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">hasattr</span></code></a>(<code class="code docutils literal notranslate"><span class="pre">"_fields"</span></code>) - eg <a class="reference external" href="https://docs.python.org/3/library/collections.html#collections.namedtuple" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">namedtuple()</span></code></a></p></td>
<td><p><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Index" title="apsw.ext.VTColumnAccess.By_Index"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VTColumnAccess.By_Index</span></code></a></p></td>
<td><p><code class="code docutils literal notranslate"><span class="pre">row._fields</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#hasattr" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">hasattr</span></code></a>(<code class="code docutils literal notranslate"><span class="pre">"__match_args__"</span></code>)</p></td>
<td><p><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Attr" title="apsw.ext.VTColumnAccess.By_Attr"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VTColumnAccess.By_Attr</span></code></a></p></td>
<td><p><code class="code docutils literal notranslate"><span class="pre">row.__match_args__</span></code> (if not empty)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#isinstance" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance</span></code></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>)</p></td>
<td><p><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Name" title="apsw.ext.VTColumnAccess.By_Name"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VTColumnAccess.By_Name</span></code></a></p></td>
<td><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict.keys" title="(in Python v3.12)"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dict.keys()</span></code></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#isinstance" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinstance</span></code></a>(<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a>)</p></td>
<td><p><a class="reference internal" href="#apsw.ext.VTColumnAccess.By_Index" title="apsw.ext.VTColumnAccess.By_Index"><code class="xref py py-attr docutils literal notranslate"><span class="pre">VTColumnAccess.By_Index</span></code></a></p></td>
<td><p><code class="code docutils literal notranslate"><span class="pre">columnX</span></code> where <em>X</em> is zero up to <a class="reference external" href="https://docs.python.org/3/library/functions.html#len" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">len</span></code></a>(<code class="code docutils literal notranslate"><span class="pre">row</span></code>)</p></td>
</tr>
</tbody>
</table>
<p>Example usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">method</span><span class="p">(</span><span class="n">arg1</span><span class="p">,</span> <span class="n">arg2</span><span class="p">):</span>
<span class="k">yield</span> <span class="p">{</span><span class="s2">"fruit"</span><span class="p">:</span> <span class="s2">"orange"</span><span class="p">,</span> <span class="s2">"price"</span><span class="p">:</span> <span class="mi">17</span><span class="p">,</span> <span class="s2">"quantity"</span><span class="p">:</span> <span class="mi">2</span><span class="p">}</span>
<span class="n">example_row</span> <span class="o">=</span> <span class="nb">next</span><span class="p">(</span><span class="n">method</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
<span class="n">method</span><span class="o">.</span><span class="n">columns</span><span class="p">,</span> <span class="n">method</span><span class="o">.</span><span class="n">column_access</span> <span class="o">=</span> <span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">get_column_names</span><span class="p">(</span><span class="n">example_row</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.make_virtual_module">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">make_virtual_module</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">Connection</span></a></span></em>, <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>, <em class="sig-param"><span class="n"><span class="pre">callable</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/typing.html#typing.Callable" title="(in Python v3.12)"><span class="pre">Callable</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eponymous</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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">eponymous_only</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>, <em class="sig-param"><span class="n"><span class="pre">repr_invalid</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#make_virtual_module"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.make_virtual_module" title="Link to this definition"></a></dt>
<dd><p>Registers a read-only virtual table module with <em>db</em> based on
<em>callable</em>. The <em>callable</em> must have an attribute named <em>columns</em>
with a list of column names, and an attribute named <em>column_access</em>
with a <a class="reference internal" href="#apsw.ext.VTColumnAccess" title="apsw.ext.VTColumnAccess"><code class="xref py py-class docutils literal notranslate"><span class="pre">VTColumnAccess</span></code></a> saying how to access columns from a row.
See <a class="reference internal" href="#apsw.ext.get_column_names" title="apsw.ext.get_column_names"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_column_names()</span></code></a> for easily figuring that out.</p>
<p>The goal is to make it very easy to turn a Python function into a
virtual table. For example the following Python function:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">gendata</span><span class="p">(</span><span class="n">start_id</span><span class="p">,</span> <span class="n">end_id</span><span class="o">=</span><span class="mi">1000</span><span class="p">,</span> <span class="n">include_system</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="k">yield</span> <span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="s2">"2020-10-21"</span><span class="p">,</span> <span class="s2">"readme.txt)</span>
<span class="k">yield</span> <span class="p">(</span><span class="mi">11</span><span class="p">,</span> <span class="s2">"2019-05-12"</span><span class="p">,</span> <span class="s2">"john.txt)</span>
<span class="n">gendata</span><span class="o">.</span><span class="n">columns</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"user_id"</span><span class="p">,</span> <span class="s2">"start_date"</span><span class="p">,</span> <span class="s2">"file_name"</span><span class="p">)</span>
<span class="n">gendata</span><span class="o">.</span><span class="n">column_access</span> <span class="o">=</span> <span class="n">VTColumnAccess</span><span class="o">.</span><span class="n">By_Index</span>
</pre></div>
</div>
<p>Will generate a table declared like this, using <a class="reference external" href="https://sqlite.org/vtab.html#hidden_columns_in_virtual_tables">HIDDEN</a>
for parameters:</p>
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="k">CREATE</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="k">table_name</span><span class="p">(</span><span class="n">user_id</span><span class="p">,</span>
<span class="w"> </span><span class="n">start_date</span><span class="p">,</span>
<span class="w"> </span><span class="n">file_name</span><span class="p">,</span>
<span class="w"> </span><span class="n">start_id</span><span class="w"> </span><span class="n">HIDDEN</span><span class="p">,</span>
<span class="w"> </span><span class="n">end_id</span><span class="w"> </span><span class="n">HIDDEN</span><span class="p">,</span>
<span class="w"> </span><span class="n">include_system</span><span class="w"> </span><span class="n">HIDDEN</span><span class="p">);</span>
</pre></div>
</div>
<p><a class="reference external" href="https://docs.python.org/3/library/inspect.html#inspect.signature" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">inspect.signature()</span></code></a> is used to discover parameter names.</p>
<p>Positional parameters to <em>callable</em> come from the table definition.</p>
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">from</span><span class="w"> </span><span class="k">table_name</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span>
</pre></div>
</div>
<p>Keyword arguments come from WHERE clauses.</p>
<div class="highlight-sql notranslate"><div class="highlight"><pre><span></span><span class="k">SELECT</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="k">from</span><span class="w"> </span><span class="k">table_name</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="w"> </span><span class="k">WHERE</span>
<span class="w"> </span><span class="n">include_system</span><span class="o">=</span><span class="mi">1</span><span class="p">;</span>
</pre></div>
</div>
<p><a class="reference external" href="https://docs.python.org/3/library/functions.html#iter" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">iter()</span></code></a> is called on <em>callable</em> with each iteration expected
to return the next row. That means <em>callable</em> can return its data
all at once (eg a list of rows), or <em>yield</em> them one row at a
time. The number of columns must always be the same, no matter
what the parameter values.</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>eponymous</strong> – Lets you use the <em>name</em> as a table name without
having to create a virtual table</p></li>
<li><p><strong>eponymous_only</strong> – Can only reference as a table name</p></li>
<li><p><strong>repr_invalid</strong> – If <em>True</em> then values that are not valid
<a class="reference internal" href="apsw.html#apsw.SQLiteValue" title="apsw.SQLiteValue"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.SQLiteValue</span></code></a> will be converted to a string using
<a class="reference external" href="https://docs.python.org/3/library/functions.html#repr" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">repr()</span></code></a></p></li>
</ul>
</dd>
</dl>
<p>See the <a class="reference internal" href="example.html#example-virtual-tables"><span class="std std-ref">example</span></a></p>
<section id="advanced">
<h3>Advanced<a class="headerlink" href="#advanced" title="Link to this heading"></a></h3>
<p>The <em>callable</em> may also have an attribute named <em>primary_key</em>.
By default the <a class="reference external" href="https://docs.python.org/3/library/functions.html#id" title="(in Python v3.12)"><code class="xref py py-func docutils literal notranslate"><span class="pre">id()</span></code></a> of each row is used as the primary key.
If present then it must be a column number to use as the primary
key. The contents of that column must be unique for every row.</p>
<p>If you specify a parameter to the table and in WHERE, or have
non-equality for WHERE clauses of parameters then the query will
fail with <a class="reference internal" href="exceptions.html#apsw.SQLError" title="apsw.SQLError"><code class="xref py py-class docutils literal notranslate"><span class="pre">apsw.SQLError</span></code></a> and a message from SQLite of
“no query solution”</p>
</section>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.generate_series_sqlite">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">generate_series_sqlite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0xffffffff</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#generate_series_sqlite"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.generate_series_sqlite" title="Link to this definition"></a></dt>
<dd><p>Behaves like SQLite’s <a class="reference external" href="https://sqlite.org/series.html">generate_series</a></p>
<p>Only integers are supported. If <em>step</em> is negative
then values are generated from <em>stop</em> to <em>start</em></p>
<p>To use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">make_virtual_module</span><span class="p">(</span><span class="n">db</span><span class="p">,</span>
<span class="s2">"generate_series"</span><span class="p">,</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">generate_series_sqlite</span><span class="p">)</span>
<span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT value FROM generate_series(1, 10))</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#apsw.ext.generate_series" title="apsw.ext.generate_series"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_series()</span></code></a></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.generate_series">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">generate_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#generate_series"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.generate_series" title="Link to this definition"></a></dt>
<dd><p>Behaves like Postgres and SQL Server</p>
<p><a class="reference external" href="https://www.postgresql.org/docs/current/functions-srf.html">Postgres doc</a>
<a class="reference external" href="https://learn.microsoft.com/en-us/sql/t-sql/functions/generate-series-transact-sql">SQL server doc</a></p>
<p>Operates on floating point as well as integer. If step is not
specified then it is 1 if <em>stop</em> is greater than <em>start</em> and -1 if
<em>stop</em> is less than <em>start</em>.</p>
<p>To use:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">make_virtual_module</span><span class="p">(</span><span class="n">db</span><span class="p">,</span>
<span class="s2">"generate_series"</span><span class="p">,</span>
<span class="n">apsw</span><span class="o">.</span><span class="n">ext</span><span class="o">.</span><span class="n">generate_series</span><span class="p">)</span>
<span class="n">db</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="s2">"SELECT value FROM generate_series(1, 10))</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#apsw.ext.generate_series" title="apsw.ext.generate_series"><code class="xref py py-meth docutils literal notranslate"><span class="pre">generate_series()</span></code></a></p>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="apsw.ext.query_info">
<span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">query_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="connection.html#apsw.Connection" title="apsw.Connection"><span class="pre">apsw.Connection</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</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">bindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prepare_flags</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>, <em class="sig-param"><span class="n"><span class="pre">actions</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>, <em class="sig-param"><span class="n"><span class="pre">expanded_sql</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>, <em class="sig-param"><span class="n"><span class="pre">explain</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>, <em class="sig-param"><span class="n"><span class="pre">explain_query_plan</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 internal" href="#apsw.ext.QueryDetails" title="apsw.ext.QueryDetails"><span class="pre">QueryDetails</span></a></span></span><a class="reference internal" href="_modules/apsw/ext.html#query_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.query_info" title="Link to this definition"></a></dt>
<dd><p>Returns information about the query, without running it.</p>
<p><cite>bindings</cite> can be <cite>None</cite> if you want to find out what the bindings
for the query are.</p>
<p>Set the various parameters to <cite>True</cite> if you also want the
actions, expanded_sql, explain, query_plan etc filled in.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">QueryDetails</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</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">bindings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">first_query</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">query_remaining</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_explain</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">is_readonly</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>, <em class="sig-param"><span class="n"><span class="pre">has_vdbe</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>, <em class="sig-param"><span class="n"><span class="pre">bindings_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>, <em class="sig-param"><span class="n"><span class="pre">bindings_names</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#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="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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</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#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#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><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 class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_full</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#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#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><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/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/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/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 class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">expanded_sql</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">actions</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#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="#apsw.ext.QueryAction" title="apsw.ext.QueryAction"><span class="pre">QueryAction</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">explain</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#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="#apsw.ext.VDBEInstruction" title="apsw.ext.VDBEInstruction"><span class="pre">VDBEInstruction</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">query_plan</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#apsw.ext.QueryPlan" title="apsw.ext.QueryPlan"><span class="pre">QueryPlan</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#QueryDetails"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.QueryDetails" title="Link to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclass</span></code></a> that provides detailed information about a query, returned by <a class="reference internal" href="#apsw.ext.query_info" title="apsw.ext.query_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">query_info()</span></code></a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.query">
<span class="sig-name descname"><span class="pre">query</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.query" title="Link to this definition"></a></dt>
<dd><p>Original query provided</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.bindings">
<span class="sig-name descname"><span class="pre">bindings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="apsw.html#apsw.Bindings" title="apsw.Bindings"><span class="pre">apsw.Bindings</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.bindings" title="Link to this definition"></a></dt>
<dd><p>Bindings provided</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.first_query">
<span class="sig-name descname"><span class="pre">first_query</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.first_query" title="Link to this definition"></a></dt>
<dd><p>The first statement present in query</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.query_remaining">
<span class="sig-name descname"><span class="pre">query_remaining</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.query_remaining" title="Link to this definition"></a></dt>
<dd><p>Query text after the first one if multiple were in query, else None</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.is_explain">
<span class="sig-name descname"><span class="pre">is_explain</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.ext.QueryDetails.is_explain" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="cursor.html#apsw.Cursor.is_explain" title="apsw.Cursor.is_explain"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cursor.is_explain</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.is_readonly">
<span class="sig-name descname"><span class="pre">is_readonly</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.ext.QueryDetails.is_readonly" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="cursor.html#apsw.Cursor.is_readonly" title="apsw.Cursor.is_readonly"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cursor.is_readonly</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.has_vdbe">
<span class="sig-name descname"><span class="pre">has_vdbe</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.ext.QueryDetails.has_vdbe" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="cursor.html#apsw.Cursor.has_vdbe" title="apsw.Cursor.has_vdbe"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cursor.has_vdbe</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.bindings_count">
<span class="sig-name descname"><span class="pre">bindings_count</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.ext.QueryDetails.bindings_count" title="Link to this definition"></a></dt>
<dd><p>How many <a class="reference internal" href="cursor.html#apsw.Cursor.bindings_count" title="apsw.Cursor.bindings_count"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bindings</span></code></a> are in the query</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.bindings_names">
<span class="sig-name descname"><span class="pre">bindings_names</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="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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#apsw.ext.QueryDetails.bindings_names" title="Link to this definition"></a></dt>
<dd><p>The <a class="reference internal" href="cursor.html#apsw.Cursor.bindings_names" title="apsw.Cursor.bindings_names"><code class="xref py py-attr docutils literal notranslate"><span class="pre">names</span></code></a>. The leading marker (<code class="docutils literal notranslate"><span class="pre">?:@$</span></code>) is omitted</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.description">
<span class="sig-name descname"><span class="pre">description</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#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><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 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.ext.QueryDetails.description" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="cursor.html#apsw.Cursor.get_description" title="apsw.Cursor.get_description"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Cursor.get_description</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.description_full">
<span class="sig-name descname"><span class="pre">description_full</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#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><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/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/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/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 class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.description_full" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="cursor.html#apsw.Cursor.description_full" title="apsw.Cursor.description_full"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cursor.description_full</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.expanded_sql">
<span class="sig-name descname"><span class="pre">expanded_sql</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.expanded_sql" title="Link to this definition"></a></dt>
<dd><p><a class="reference internal" href="cursor.html#apsw.Cursor.expanded_sql" title="apsw.Cursor.expanded_sql"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Cursor.expanded_sql</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.actions">
<span class="sig-name descname"><span class="pre">actions</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><a class="reference internal" href="#apsw.ext.QueryAction" title="apsw.ext.QueryAction"><span class="pre">QueryAction</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.actions" title="Link to this definition"></a></dt>
<dd><p>A list of the actions taken by the query, as discovered via
<a class="reference internal" href="connection.html#apsw.Connection.authorizer" title="apsw.Connection.authorizer"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Connection.authorizer</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.explain">
<span class="sig-name descname"><span class="pre">explain</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><a class="reference internal" href="#apsw.ext.VDBEInstruction" title="apsw.ext.VDBEInstruction"><span class="pre">VDBEInstruction</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.explain" title="Link to this definition"></a></dt>
<dd><p>A list of instructions of the <a class="reference external" href="https://sqlite.org/opcode.html">internal code</a>
used by SQLite to execute the query</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryDetails.query_plan">
<span class="sig-name descname"><span class="pre">query_plan</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#apsw.ext.QueryPlan" title="apsw.ext.QueryPlan"><span class="pre">QueryPlan</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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><a class="headerlink" href="#apsw.ext.QueryDetails.query_plan" title="Link to this definition"></a></dt>
<dd><p>The steps taken against tables and indices <a class="reference external" href="https://sqlite.org/eqp.html">described here</a></p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.QueryAction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">QueryAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">action</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">action_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>, <em class="sig-param"><span class="n"><span class="pre">column_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">database_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">operation</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pragma_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pragma_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/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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">table_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trigger_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">trigger_or_view</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">view_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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#QueryAction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.QueryAction" title="Link to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclass</span></code></a> that provides information about one action taken by a query</p>
<p>Depending on the action, only a subset of the fields will have non-None values</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.action">
<span class="sig-name descname"><span class="pre">action</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.ext.QueryAction.action" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://sqlite.org/c3ref/c_alter_table.html">Authorizer code</a> (also present
in <a class="reference internal" href="apsw.html#apsw.mapping_authorizer_function" title="apsw.mapping_authorizer_function"><code class="xref py py-attr docutils literal notranslate"><span class="pre">apsw.mapping_authorizer_function</span></code></a>)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.action_name">
<span class="sig-name descname"><span class="pre">action_name</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.QueryAction.action_name" title="Link to this definition"></a></dt>
<dd><p>The string corresponding to the action. For example <cite>action</cite> could be <cite>21</cite> in which
case <cite>action_name</cite> will be <cite>SQLITE_SELECT</cite></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.column_name">
<span class="sig-name descname"><span class="pre">column_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.column_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.database_name">
<span class="sig-name descname"><span class="pre">database_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.database_name" title="Link to this definition"></a></dt>
<dd><p><cite>main</cite>, <cite>temp</cite>, the name in <a class="reference external" href="https://sqlite.org/lang_attach.html">ATTACH</a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.file_name">
<span class="sig-name descname"><span class="pre">file_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.file_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.function_name">
<span class="sig-name descname"><span class="pre">function_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.function_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.module_name">
<span class="sig-name descname"><span class="pre">module_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.module_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.operation">
<span class="sig-name descname"><span class="pre">operation</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.operation" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.pragma_name">
<span class="sig-name descname"><span class="pre">pragma_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.pragma_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.pragma_value">
<span class="sig-name descname"><span class="pre">pragma_value</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.pragma_value" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.table_name">
<span class="sig-name descname"><span class="pre">table_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.table_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.trigger_name">
<span class="sig-name descname"><span class="pre">trigger_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.trigger_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.trigger_or_view">
<span class="sig-name descname"><span class="pre">trigger_or_view</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.trigger_or_view" title="Link to this definition"></a></dt>
<dd><p>This action is happening due to a trigger or view, and not
directly expressed in the query itself</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryAction.view_name">
<span class="sig-name descname"><span class="pre">view_name</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryAction.view_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.QueryPlan">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">QueryPlan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">detail</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">sub</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#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="#apsw.ext.QueryPlan" title="apsw.ext.QueryPlan"><span class="pre">QueryPlan</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#QueryPlan"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.QueryPlan" title="Link to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclass</span></code></a> for one step of a query plan</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryPlan.detail">
<span class="sig-name descname"><span class="pre">detail</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.QueryPlan.detail" title="Link to this definition"></a></dt>
<dd><p>Description of this step</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.QueryPlan.sub">
<span class="sig-name descname"><span class="pre">sub</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><a class="reference internal" href="#apsw.ext.QueryPlan" title="apsw.ext.QueryPlan"><span class="pre">QueryPlan</span></a><span class="p"><span class="pre">]</span></span><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.QueryPlan.sub" title="Link to this definition"></a></dt>
<dd><p>Steps that run inside this one</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">VDBEInstruction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">addr</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">opcode</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">comment</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p1</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p2</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p3</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p4</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p5</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 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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</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">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apsw/ext.html#VDBEInstruction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.VDBEInstruction" title="Link to this definition"></a></dt>
<dd><p>A <a class="reference external" href="https://docs.python.org/3/library/dataclasses.html#module-dataclasses" title="(in Python v3.12)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">dataclass</span></code></a> representing one instruction and its parameters</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.addr">
<span class="sig-name descname"><span class="pre">addr</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.ext.VDBEInstruction.addr" title="Link to this definition"></a></dt>
<dd><p>Address of this opcode. It will be the target of goto, loops etc</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.opcode">
<span class="sig-name descname"><span class="pre">opcode</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.opcode" title="Link to this definition"></a></dt>
<dd><p>The instruction</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.comment">
<span class="sig-name descname"><span class="pre">comment</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#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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.comment" title="Link to this definition"></a></dt>
<dd><p>Additional human readable information</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.p1">
<span class="sig-name descname"><span class="pre">p1</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><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.p1" title="Link to this definition"></a></dt>
<dd><p>First opcode parameter</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.p2">
<span class="sig-name descname"><span class="pre">p2</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><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.p2" title="Link to this definition"></a></dt>
<dd><p>Second opcode parameter</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.p3">
<span class="sig-name descname"><span class="pre">p3</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><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.p3" title="Link to this definition"></a></dt>
<dd><p>Third opcode parameter</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.p4">
<span class="sig-name descname"><span class="pre">p4</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><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.p4" title="Link to this definition"></a></dt>
<dd><p>Fourth opcode parameter</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.VDBEInstruction.p5">
<span class="sig-name descname"><span class="pre">p5</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><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/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#apsw.ext.VDBEInstruction.p5" title="Link to this definition"></a></dt>
<dd><p>Fifth opcode parameter</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">DatabaseFileInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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">header</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#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">page_size</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">write_format</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">read_format</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">reserved_bytes</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">file_change_counter</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">page_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>, <em class="sig-param"><span class="n"><span class="pre">freelist_pages</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">schema_cookie</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">schema_format</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">default_cache_size</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">autovacuum_top_root</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">text_encoding</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">user_version</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">incremental_vacuum</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>, <em class="sig-param"><span class="n"><span class="pre">application_id</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">version_valid_for</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">sqlite_version</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><a class="reference internal" href="_modules/apsw/ext.html#DatabaseFileInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.DatabaseFileInfo" title="Link to this definition"></a></dt>
<dd><p>Information about the main database file returned by <a class="reference internal" href="#apsw.ext.dbinfo" title="apsw.ext.dbinfo"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dbinfo()</span></code></a></p>
<p>See <a class="reference external" href="https://www.sqlite.org/fileformat.html#the_database_header">file format description</a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.filename">
<span class="sig-name descname"><span class="pre">filename</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.DatabaseFileInfo.filename" title="Link to this definition"></a></dt>
<dd><p>database filena name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.header">
<span class="sig-name descname"><span class="pre">header</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#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></em><a class="headerlink" href="#apsw.ext.DatabaseFileInfo.header" title="Link to this definition"></a></dt>
<dd><p>Header string</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.page_size">
<span class="sig-name descname"><span class="pre">page_size</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.ext.DatabaseFileInfo.page_size" title="Link to this definition"></a></dt>
<dd><p>The database page size in bytes</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.write_format">
<span class="sig-name descname"><span class="pre">write_format</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.ext.DatabaseFileInfo.write_format" title="Link to this definition"></a></dt>
<dd><p>File format write version. 1 for legacy; 2 for WAL</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.read_format">
<span class="sig-name descname"><span class="pre">read_format</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.ext.DatabaseFileInfo.read_format" title="Link to this definition"></a></dt>
<dd><p>File format read version. 1 for legacy; 2 for WAL.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.reserved_bytes">
<span class="sig-name descname"><span class="pre">reserved_bytes</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.ext.DatabaseFileInfo.reserved_bytes" title="Link to this definition"></a></dt>
<dd><p>Bytes of unused “reserved” space at the end of each page. Usually 0</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.file_change_counter">
<span class="sig-name descname"><span class="pre">file_change_counter</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.ext.DatabaseFileInfo.file_change_counter" title="Link to this definition"></a></dt>
<dd><p>File change counter</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.page_count">
<span class="sig-name descname"><span class="pre">page_count</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.ext.DatabaseFileInfo.page_count" title="Link to this definition"></a></dt>
<dd><p>Size of the database file in pages</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.freelist_pages">
<span class="sig-name descname"><span class="pre">freelist_pages</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.ext.DatabaseFileInfo.freelist_pages" title="Link to this definition"></a></dt>
<dd><p>Total number of freelist pages</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.schema_cookie">
<span class="sig-name descname"><span class="pre">schema_cookie</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.ext.DatabaseFileInfo.schema_cookie" title="Link to this definition"></a></dt>
<dd><p>The schema cookie</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.schema_format">
<span class="sig-name descname"><span class="pre">schema_format</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.ext.DatabaseFileInfo.schema_format" title="Link to this definition"></a></dt>
<dd><p>The schema format number. Supported schema formats are 1, 2, 3, and 4</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.default_cache_size">
<span class="sig-name descname"><span class="pre">default_cache_size</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.ext.DatabaseFileInfo.default_cache_size" title="Link to this definition"></a></dt>
<dd><p>The schema format number. Supported schema formats are 1, 2, 3, and 4</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.autovacuum_top_root">
<span class="sig-name descname"><span class="pre">autovacuum_top_root</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.ext.DatabaseFileInfo.autovacuum_top_root" title="Link to this definition"></a></dt>
<dd><p>The page number of the largest root b-tree page when in auto-vacuum or incremental-vacuum modes, or zero otherwise</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.text_encoding">
<span class="sig-name descname"><span class="pre">text_encoding</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.DatabaseFileInfo.text_encoding" title="Link to this definition"></a></dt>
<dd><p>The database text encoding</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.user_version">
<span class="sig-name descname"><span class="pre">user_version</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.ext.DatabaseFileInfo.user_version" title="Link to this definition"></a></dt>
<dd><p>The “user version” as read and set by the user_version pragma.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.incremental_vacuum">
<span class="sig-name descname"><span class="pre">incremental_vacuum</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.ext.DatabaseFileInfo.incremental_vacuum" title="Link to this definition"></a></dt>
<dd><p>True (non-zero) for incremental-vacuum mode. False (zero) otherwise.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.application_id">
<span class="sig-name descname"><span class="pre">application_id</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.ext.DatabaseFileInfo.application_id" title="Link to this definition"></a></dt>
<dd><p>The “Application ID” set by PRAGMA application_id</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.version_valid_for">
<span class="sig-name descname"><span class="pre">version_valid_for</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.ext.DatabaseFileInfo.version_valid_for" title="Link to this definition"></a></dt>
<dd><p>The version-valid-for number.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.DatabaseFileInfo.sqlite_version">
<span class="sig-name descname"><span class="pre">sqlite_version</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.ext.DatabaseFileInfo.sqlite_version" title="Link to this definition"></a></dt>
<dd><p>SQLite version that lost wrote</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">JournalFileInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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">header</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#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_valid</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>, <em class="sig-param"><span class="n"><span class="pre">page_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>, <em class="sig-param"><span class="n"><span class="pre">random_nonce</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">initial_pages</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">sector_size</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">page_size</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><a class="reference internal" href="_modules/apsw/ext.html#JournalFileInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.JournalFileInfo" title="Link to this definition"></a></dt>
<dd><p>Information about the rollback journal returned by <a class="reference internal" href="#apsw.ext.dbinfo" title="apsw.ext.dbinfo"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dbinfo()</span></code></a></p>
<p>See the <a class="reference external" href="https://www.sqlite.org/fileformat2.html#the_rollback_journal">file format description</a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.filename">
<span class="sig-name descname"><span class="pre">filename</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.JournalFileInfo.filename" title="Link to this definition"></a></dt>
<dd><p>journal file name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.header">
<span class="sig-name descname"><span class="pre">header</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#bytes" title="(in Python v3.12)"><span class="pre">bytes</span></a></em><a class="headerlink" href="#apsw.ext.JournalFileInfo.header" title="Link to this definition"></a></dt>
<dd><p>Header string</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.header_valid">
<span class="sig-name descname"><span class="pre">header_valid</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.ext.JournalFileInfo.header_valid" title="Link to this definition"></a></dt>
<dd><p>If the header is the expected bytes</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.page_count">
<span class="sig-name descname"><span class="pre">page_count</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.ext.JournalFileInfo.page_count" title="Link to this definition"></a></dt>
<dd><p>The “Page Count” - The number of pages in the next segment of the journal, or -1 to mean all content to the end of the file</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.random_nonce">
<span class="sig-name descname"><span class="pre">random_nonce</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.ext.JournalFileInfo.random_nonce" title="Link to this definition"></a></dt>
<dd><p>A random nonce for the checksum</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.initial_pages">
<span class="sig-name descname"><span class="pre">initial_pages</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.ext.JournalFileInfo.initial_pages" title="Link to this definition"></a></dt>
<dd><p>Initial size of the database in pages</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.sector_size">
<span class="sig-name descname"><span class="pre">sector_size</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.ext.JournalFileInfo.sector_size" title="Link to this definition"></a></dt>
<dd><p>Size of a disk sector assumed by the process that wrote this journal</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.JournalFileInfo.page_size">
<span class="sig-name descname"><span class="pre">page_size</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.ext.JournalFileInfo.page_size" title="Link to this definition"></a></dt>
<dd><p>Size of pages in this journal</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apsw.ext.</span></span><span class="sig-name descname"><span class="pre">WALFileInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</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">magic_number</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">format_version</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">page_size</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">checkpoint_sequence_number</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">salt_1</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">salt_2</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">checksum_1</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">checksum_2</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><a class="reference internal" href="_modules/apsw/ext.html#WALFileInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apsw.ext.WALFileInfo" title="Link to this definition"></a></dt>
<dd><p>Information about the rollback journal returned by <a class="reference internal" href="#apsw.ext.dbinfo" title="apsw.ext.dbinfo"><code class="xref py py-meth docutils literal notranslate"><span class="pre">dbinfo()</span></code></a></p>
<p>See the <a class="reference external" href="https://www.sqlite.org/fileformat2.html#wal_file_format">file format description</a></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.filename">
<span class="sig-name descname"><span class="pre">filename</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#str" title="(in Python v3.12)"><span class="pre">str</span></a></em><a class="headerlink" href="#apsw.ext.WALFileInfo.filename" title="Link to this definition"></a></dt>
<dd><p>WAL file name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.magic_number">
<span class="sig-name descname"><span class="pre">magic_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.ext.WALFileInfo.magic_number" title="Link to this definition"></a></dt>
<dd><p>Magic number</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.format_version">
<span class="sig-name descname"><span class="pre">format_version</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.ext.WALFileInfo.format_version" title="Link to this definition"></a></dt>
<dd><p>File format version. Currently 3007000</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.page_size">
<span class="sig-name descname"><span class="pre">page_size</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.ext.WALFileInfo.page_size" title="Link to this definition"></a></dt>
<dd><p>Database page size</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.checkpoint_sequence_number">
<span class="sig-name descname"><span class="pre">checkpoint_sequence_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.ext.WALFileInfo.checkpoint_sequence_number" title="Link to this definition"></a></dt>
<dd><p>Checkpoint sequence number</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.salt_1">
<span class="sig-name descname"><span class="pre">salt_1</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.ext.WALFileInfo.salt_1" title="Link to this definition"></a></dt>
<dd><p>Salt-1: random integer incremented with each checkpoint</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.salt_2">
<span class="sig-name descname"><span class="pre">salt_2</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.ext.WALFileInfo.salt_2" title="Link to this definition"></a></dt>
<dd><p>Salt-2: a different random number for each checkpoint</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.checksum_1">
<span class="sig-name descname"><span class="pre">checksum_1</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.ext.WALFileInfo.checksum_1" title="Link to this definition"></a></dt>
<dd><p>Checksum-1: First part of a checksum on the first 24 bytes of header</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="apsw.ext.WALFileInfo.checksum_2">
<span class="sig-name descname"><span class="pre">checksum_2</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.ext.WALFileInfo.checksum_2" title="Link to this definition"></a></dt>
<dd><p>Checksum-2: Second part of the checksum on the first 24 bytes of header</p>
</dd></dl>
</dd></dl>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="bestpractice.html" class="btn btn-neutral float-left" title="Best Practice" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="exceptions.html" class="btn btn-neutral float-right" title="Exceptions and Errors" 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>
|
