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
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::Database Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="classXapian_1_1Database.html">Database</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classXapian_1_1Database-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::Database Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class is used to access a database, or a group of databases.
<a href="classXapian_1_1Database.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Xapian::Database:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classXapian_1_1Database__inherit__graph.png" border="0" usemap="#Xapian_1_1Database_inherit__map" alt="Inheritance graph"/></div>
<map name="Xapian_1_1Database_inherit__map" id="Xapian_1_1Database_inherit__map">
<area shape="rect" id="node2" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. " alt="" coords="5,80,180,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2fc5aa368a7097ca787a831211a2e3bc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a2fc5aa368a7097ca787a831211a2e3bc">add_database</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &database)</td></tr>
<tr class="memdesc:a2fc5aa368a7097ca787a831211a2e3bc"><td class="mdescLeft"> </td><td class="mdescRight">Add an existing database (or group of databases) to those accessed by this object. <a href="#a2fc5aa368a7097ca787a831211a2e3bc">More...</a><br /></td></tr>
<tr class="separator:a2fc5aa368a7097ca787a831211a2e3bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24f8197f3ac8bfd8c2526e0b8dff4ff7"><td class="memItemLeft" align="right" valign="top"><a id="a24f8197f3ac8bfd8c2526e0b8dff4ff7"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a24f8197f3ac8bfd8c2526e0b8dff4ff7">Database</a> ()</td></tr>
<tr class="memdesc:a24f8197f3ac8bfd8c2526e0b8dff4ff7"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a> with no databases in. <br /></td></tr>
<tr class="separator:a24f8197f3ac8bfd8c2526e0b8dff4ff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a1a60feaa21613473dd404585fb25dd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a1a1a60feaa21613473dd404585fb25dd">Database</a> (const std::string &path, int flags=0)</td></tr>
<tr class="memdesc:a1a1a60feaa21613473dd404585fb25dd"><td class="mdescLeft"> </td><td class="mdescRight">Open a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a>, automatically determining the database backend to use. <a href="#a1a1a60feaa21613473dd404585fb25dd">More...</a><br /></td></tr>
<tr class="separator:a1a1a60feaa21613473dd404585fb25dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa882e42d12defaf578e68ac9a4fe36f0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#aa882e42d12defaf578e68ac9a4fe36f0">Database</a> (int fd, int flags=0)</td></tr>
<tr class="memdesc:aa882e42d12defaf578e68ac9a4fe36f0"><td class="mdescLeft"> </td><td class="mdescRight">Open a single-file <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a>. <a href="#aa882e42d12defaf578e68ac9a4fe36f0">More...</a><br /></td></tr>
<tr class="separator:aa882e42d12defaf578e68ac9a4fe36f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0352b3a47dca16d57c071252e84f1043"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a0352b3a47dca16d57c071252e84f1043">~Database</a> ()</td></tr>
<tr class="memdesc:a0352b3a47dca16d57c071252e84f1043"><td class="mdescLeft"> </td><td class="mdescRight">Destroy this handle on the database. <a href="#a0352b3a47dca16d57c071252e84f1043">More...</a><br /></td></tr>
<tr class="separator:a0352b3a47dca16d57c071252e84f1043"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaae498b70286ba1c588b7cbeb0972d38"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#aaae498b70286ba1c588b7cbeb0972d38">Database</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &other)</td></tr>
<tr class="memdesc:aaae498b70286ba1c588b7cbeb0972d38"><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="#aaae498b70286ba1c588b7cbeb0972d38">More...</a><br /></td></tr>
<tr class="separator:aaae498b70286ba1c588b7cbeb0972d38"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e8badea7a9d7292c13f99429c6a2b79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a4e8badea7a9d7292c13f99429c6a2b79">operator=</a> (const <a class="el" href="classXapian_1_1Database.html">Database</a> &other)</td></tr>
<tr class="memdesc:a4e8badea7a9d7292c13f99429c6a2b79"><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed. <a href="#a4e8badea7a9d7292c13f99429c6a2b79">More...</a><br /></td></tr>
<tr class="separator:a4e8badea7a9d7292c13f99429c6a2b79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af316aa13ee123e2af75f4b44e1f23db9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#af316aa13ee123e2af75f4b44e1f23db9">reopen</a> ()</td></tr>
<tr class="memdesc:af316aa13ee123e2af75f4b44e1f23db9"><td class="mdescLeft"> </td><td class="mdescRight">Re-open the database. <a href="#af316aa13ee123e2af75f4b44e1f23db9">More...</a><br /></td></tr>
<tr class="separator:af316aa13ee123e2af75f4b44e1f23db9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59f5f8b137723dcaaabdbdccbc0cf1eb"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a59f5f8b137723dcaaabdbdccbc0cf1eb">close</a> ()</td></tr>
<tr class="memdesc:a59f5f8b137723dcaaabdbdccbc0cf1eb"><td class="mdescLeft"> </td><td class="mdescRight">Close the database. <a href="#a59f5f8b137723dcaaabdbdccbc0cf1eb">More...</a><br /></td></tr>
<tr class="separator:a59f5f8b137723dcaaabdbdccbc0cf1eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa028bd89f8a6f2b82520d6a58c19dc29"><td class="memItemLeft" align="right" valign="top"><a id="aa028bd89f8a6f2b82520d6a58c19dc29"></a>
virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#aa028bd89f8a6f2b82520d6a58c19dc29">get_description</a> () const</td></tr>
<tr class="memdesc:aa028bd89f8a6f2b82520d6a58c19dc29"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:aa028bd89f8a6f2b82520d6a58c19dc29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a117ac642b800b21e3b9411931374d9df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a117ac642b800b21e3b9411931374d9df">postlist_begin</a> (const std::string &tname) const</td></tr>
<tr class="memdesc:a117ac642b800b21e3b9411931374d9df"><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to the start of the postlist for a given term. <a href="#a117ac642b800b21e3b9411931374d9df">More...</a><br /></td></tr>
<tr class="separator:a117ac642b800b21e3b9411931374d9df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e752d10963ba93bbf16149f77e6c0d7"><td class="memItemLeft" align="right" valign="top"><a id="a4e752d10963ba93bbf16149f77e6c0d7"></a>
<a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a4e752d10963ba93bbf16149f77e6c0d7">postlist_end</a> (const std::string &) const</td></tr>
<tr class="memdesc:a4e752d10963ba93bbf16149f77e6c0d7"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to <a class="el" href="classXapian_1_1Database.html#a117ac642b800b21e3b9411931374d9df" title="An iterator pointing to the start of the postlist for a given term. ">postlist_begin()</a>. <br /></td></tr>
<tr class="separator:a4e752d10963ba93bbf16149f77e6c0d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cf15b9cb9f818b0cadce792562f9b27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a6cf15b9cb9f818b0cadce792562f9b27">termlist_begin</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did) const</td></tr>
<tr class="memdesc:a6cf15b9cb9f818b0cadce792562f9b27"><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to the start of the termlist for a given document. <a href="#a6cf15b9cb9f818b0cadce792562f9b27">More...</a><br /></td></tr>
<tr class="separator:a6cf15b9cb9f818b0cadce792562f9b27"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae08dcc72562c276399ed1f44fe55a56b"><td class="memItemLeft" align="right" valign="top"><a id="ae08dcc72562c276399ed1f44fe55a56b"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ae08dcc72562c276399ed1f44fe55a56b">termlist_end</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a>) const</td></tr>
<tr class="memdesc:ae08dcc72562c276399ed1f44fe55a56b"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to <a class="el" href="classXapian_1_1Database.html#a6cf15b9cb9f818b0cadce792562f9b27" title="An iterator pointing to the start of the termlist for a given document. ">termlist_begin()</a>. <br /></td></tr>
<tr class="separator:ae08dcc72562c276399ed1f44fe55a56b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada86a7c8cc944c49ba2358615465219f"><td class="memItemLeft" align="right" valign="top"><a id="ada86a7c8cc944c49ba2358615465219f"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ada86a7c8cc944c49ba2358615465219f">has_positions</a> () const</td></tr>
<tr class="memdesc:ada86a7c8cc944c49ba2358615465219f"><td class="mdescLeft"> </td><td class="mdescRight">Does this database have any positional information? <br /></td></tr>
<tr class="separator:ada86a7c8cc944c49ba2358615465219f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afeafd91c34a7465a7fe18a7078e24e1d"><td class="memItemLeft" align="right" valign="top"><a id="afeafd91c34a7465a7fe18a7078e24e1d"></a>
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#afeafd91c34a7465a7fe18a7078e24e1d">positionlist_begin</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did, const std::string &tname) const</td></tr>
<tr class="memdesc:afeafd91c34a7465a7fe18a7078e24e1d"><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to the start of the position list for a given term in a given document. <br /></td></tr>
<tr class="separator:afeafd91c34a7465a7fe18a7078e24e1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd64f4505639e163a6e6d17e235770a0"><td class="memItemLeft" align="right" valign="top"><a id="afd64f4505639e163a6e6d17e235770a0"></a>
<a class="el" href="classXapian_1_1PositionIterator.html">PositionIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#afd64f4505639e163a6e6d17e235770a0">positionlist_end</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a>, const std::string &) const</td></tr>
<tr class="memdesc:afd64f4505639e163a6e6d17e235770a0"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to <a class="el" href="classXapian_1_1Database.html#afeafd91c34a7465a7fe18a7078e24e1d" title="An iterator pointing to the start of the position list for a given term in a given document...">positionlist_begin()</a>. <br /></td></tr>
<tr class="separator:afd64f4505639e163a6e6d17e235770a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf8de9d7fe351a347e7fa9af605a71bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#abf8de9d7fe351a347e7fa9af605a71bb">allterms_begin</a> (const std::string &prefix=std::string()) const</td></tr>
<tr class="memdesc:abf8de9d7fe351a347e7fa9af605a71bb"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which runs across all terms with a given prefix. <a href="#abf8de9d7fe351a347e7fa9af605a71bb">More...</a><br /></td></tr>
<tr class="separator:abf8de9d7fe351a347e7fa9af605a71bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7c34007e5cbd3bbcdae6ccb973c28a3"><td class="memItemLeft" align="right" valign="top"><a id="ad7c34007e5cbd3bbcdae6ccb973c28a3"></a>
<a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ad7c34007e5cbd3bbcdae6ccb973c28a3">allterms_end</a> (const std::string &=std::string()) const</td></tr>
<tr class="memdesc:ad7c34007e5cbd3bbcdae6ccb973c28a3"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to allterms_begin(prefix). <br /></td></tr>
<tr class="separator:ad7c34007e5cbd3bbcdae6ccb973c28a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcb111f71b7d4b8eee4c50930175072b"><td class="memItemLeft" align="right" valign="top"><a id="adcb111f71b7d4b8eee4c50930175072b"></a>
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#adcb111f71b7d4b8eee4c50930175072b">get_doccount</a> () const</td></tr>
<tr class="memdesc:adcb111f71b7d4b8eee4c50930175072b"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of documents in the database. <br /></td></tr>
<tr class="separator:adcb111f71b7d4b8eee4c50930175072b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf49691f63b285d575e1f1e44e79ac55"><td class="memItemLeft" align="right" valign="top"><a id="adf49691f63b285d575e1f1e44e79ac55"></a>
<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#adf49691f63b285d575e1f1e44e79ac55">get_lastdocid</a> () const</td></tr>
<tr class="memdesc:adf49691f63b285d575e1f1e44e79ac55"><td class="mdescLeft"> </td><td class="mdescRight">Get the highest document id which has been used in the database. <br /></td></tr>
<tr class="separator:adf49691f63b285d575e1f1e44e79ac55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a389dcaf7377d4562112bc1f8bd7d2dde"><td class="memItemLeft" align="right" valign="top"><a id="a389dcaf7377d4562112bc1f8bd7d2dde"></a>
<a class="el" href="namespaceXapian.html#a63b13d3a36fcab9975658e32643d86b5">Xapian::doclength</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a389dcaf7377d4562112bc1f8bd7d2dde">get_avlength</a> () const</td></tr>
<tr class="memdesc:a389dcaf7377d4562112bc1f8bd7d2dde"><td class="mdescLeft"> </td><td class="mdescRight">Get the average length of the documents in the database. <br /></td></tr>
<tr class="separator:a389dcaf7377d4562112bc1f8bd7d2dde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d0eca00055e52358d68c98c15395c8c"><td class="memItemLeft" align="right" valign="top"><a id="a9d0eca00055e52358d68c98c15395c8c"></a>
<a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a9d0eca00055e52358d68c98c15395c8c">get_termfreq</a> (const std::string &tname) const</td></tr>
<tr class="memdesc:a9d0eca00055e52358d68c98c15395c8c"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of documents in the database indexed by a given term. <br /></td></tr>
<tr class="separator:a9d0eca00055e52358d68c98c15395c8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad53ea363158a152ade8231c89b625d9f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ad53ea363158a152ade8231c89b625d9f">term_exists</a> (const std::string &tname) const</td></tr>
<tr class="memdesc:ad53ea363158a152ade8231c89b625d9f"><td class="mdescLeft"> </td><td class="mdescRight">Check if a given term exists in the database. <a href="#ad53ea363158a152ade8231c89b625d9f">More...</a><br /></td></tr>
<tr class="separator:ad53ea363158a152ade8231c89b625d9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78e85ae6f00d4bdd656906eacffbe2f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a78e85ae6f00d4bdd656906eacffbe2f4">get_collection_freq</a> (const std::string &tname) const</td></tr>
<tr class="memdesc:a78e85ae6f00d4bdd656906eacffbe2f4"><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of occurrences of the given term. <a href="#a78e85ae6f00d4bdd656906eacffbe2f4">More...</a><br /></td></tr>
<tr class="separator:a78e85ae6f00d4bdd656906eacffbe2f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae042528f17c284298444706845a70cc0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ae042528f17c284298444706845a70cc0">get_value_freq</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot) const</td></tr>
<tr class="memdesc:ae042528f17c284298444706845a70cc0"><td class="mdescLeft"> </td><td class="mdescRight">Return the frequency of a given value slot. <a href="#ae042528f17c284298444706845a70cc0">More...</a><br /></td></tr>
<tr class="separator:ae042528f17c284298444706845a70cc0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ecd343f41ed751d60b924b2099603b6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a2ecd343f41ed751d60b924b2099603b6">get_value_lower_bound</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot) const</td></tr>
<tr class="memdesc:a2ecd343f41ed751d60b924b2099603b6"><td class="mdescLeft"> </td><td class="mdescRight">Get a lower bound on the values stored in the given value slot. <a href="#a2ecd343f41ed751d60b924b2099603b6">More...</a><br /></td></tr>
<tr class="separator:a2ecd343f41ed751d60b924b2099603b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ded2510f626182edd6da82cfc2f3b3f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a7ded2510f626182edd6da82cfc2f3b3f">get_value_upper_bound</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot) const</td></tr>
<tr class="memdesc:a7ded2510f626182edd6da82cfc2f3b3f"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the values stored in the given value slot. <a href="#a7ded2510f626182edd6da82cfc2f3b3f">More...</a><br /></td></tr>
<tr class="separator:a7ded2510f626182edd6da82cfc2f3b3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62b82e621157bca6263d9f85adbaf9a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a62b82e621157bca6263d9f85adbaf9a9">get_doclength_lower_bound</a> () const</td></tr>
<tr class="memdesc:a62b82e621157bca6263d9f85adbaf9a9"><td class="mdescLeft"> </td><td class="mdescRight">Get a lower bound on the length of a document in this DB. <a href="#a62b82e621157bca6263d9f85adbaf9a9">More...</a><br /></td></tr>
<tr class="separator:a62b82e621157bca6263d9f85adbaf9a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af650145b2623f6af193af865a85f7114"><td class="memItemLeft" align="right" valign="top"><a id="af650145b2623f6af193af865a85f7114"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#af650145b2623f6af193af865a85f7114">get_doclength_upper_bound</a> () const</td></tr>
<tr class="memdesc:af650145b2623f6af193af865a85f7114"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the length of a document in this DB. <br /></td></tr>
<tr class="separator:af650145b2623f6af193af865a85f7114"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a24dbd0b34571455a298426e9c5141b"><td class="memItemLeft" align="right" valign="top"><a id="a0a24dbd0b34571455a298426e9c5141b"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a0a24dbd0b34571455a298426e9c5141b">get_wdf_upper_bound</a> (const std::string &term) const</td></tr>
<tr class="memdesc:a0a24dbd0b34571455a298426e9c5141b"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the wdf of term <em>term</em>. <br /></td></tr>
<tr class="separator:a0a24dbd0b34571455a298426e9c5141b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1854c98fd180753ddc349b03c98fd638"><td class="memItemLeft" align="right" valign="top"><a id="a1854c98fd180753ddc349b03c98fd638"></a>
<a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a1854c98fd180753ddc349b03c98fd638">valuestream_begin</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> slot) const</td></tr>
<tr class="memdesc:a1854c98fd180753ddc349b03c98fd638"><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator over the value in slot <em>slot</em> for each document. <br /></td></tr>
<tr class="separator:a1854c98fd180753ddc349b03c98fd638"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a48da9cfbaf125e02335c56822fba94"><td class="memItemLeft" align="right" valign="top"><a id="a2a48da9cfbaf125e02335c56822fba94"></a>
<a class="el" href="classXapian_1_1ValueIterator.html">ValueIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a2a48da9cfbaf125e02335c56822fba94">valuestream_end</a> (<a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a>) const</td></tr>
<tr class="memdesc:a2a48da9cfbaf125e02335c56822fba94"><td class="mdescLeft"> </td><td class="mdescRight">Return end iterator corresponding to <a class="el" href="classXapian_1_1Database.html#a1854c98fd180753ddc349b03c98fd638" title="Return an iterator over the value in slot slot for each document. ">valuestream_begin()</a>. <br /></td></tr>
<tr class="separator:a2a48da9cfbaf125e02335c56822fba94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6581a9f018585b502b57dbb511d0c87"><td class="memItemLeft" align="right" valign="top"><a id="aa6581a9f018585b502b57dbb511d0c87"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#aa6581a9f018585b502b57dbb511d0c87">get_doclength</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did) const</td></tr>
<tr class="memdesc:aa6581a9f018585b502b57dbb511d0c87"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of a document. <br /></td></tr>
<tr class="separator:aa6581a9f018585b502b57dbb511d0c87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afff524ea098c959644cf209b62c698e3"><td class="memItemLeft" align="right" valign="top"><a id="afff524ea098c959644cf209b62c698e3"></a>
<a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#afff524ea098c959644cf209b62c698e3">get_unique_terms</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did) const</td></tr>
<tr class="memdesc:afff524ea098c959644cf209b62c698e3"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of unique terms in document. <br /></td></tr>
<tr class="separator:afff524ea098c959644cf209b62c698e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a759d1fde0d3d8a2ed74b83c0ebd10974"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a759d1fde0d3d8a2ed74b83c0ebd10974">keep_alive</a> ()</td></tr>
<tr class="memdesc:a759d1fde0d3d8a2ed74b83c0ebd10974"><td class="mdescLeft"> </td><td class="mdescRight">Send a "keep-alive" to remote databases to stop them timing out. <a href="#a759d1fde0d3d8a2ed74b83c0ebd10974">More...</a><br /></td></tr>
<tr class="separator:a759d1fde0d3d8a2ed74b83c0ebd10974"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1538016d90d8afc5fea870cd1d3a8bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ab1538016d90d8afc5fea870cd1d3a8bc">get_document</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did) const</td></tr>
<tr class="memdesc:ab1538016d90d8afc5fea870cd1d3a8bc"><td class="mdescLeft"> </td><td class="mdescRight">Get a document from the database, given its document id. <a href="#ab1538016d90d8afc5fea870cd1d3a8bc">More...</a><br /></td></tr>
<tr class="separator:ab1538016d90d8afc5fea870cd1d3a8bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a478d9e6ccef471bcb661eaf03ddfa2f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a478d9e6ccef471bcb661eaf03ddfa2f7">get_document</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did, unsigned flags) const</td></tr>
<tr class="memdesc:a478d9e6ccef471bcb661eaf03ddfa2f7"><td class="mdescLeft"> </td><td class="mdescRight">Get a document from the database, given its document id. <a href="#a478d9e6ccef471bcb661eaf03ddfa2f7">More...</a><br /></td></tr>
<tr class="separator:a478d9e6ccef471bcb661eaf03ddfa2f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3575c96a597a5555e474360d91b7622b"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a3575c96a597a5555e474360d91b7622b">get_spelling_suggestion</a> (const std::string &word, unsigned max_edit_distance=2) const</td></tr>
<tr class="memdesc:a3575c96a597a5555e474360d91b7622b"><td class="mdescLeft"> </td><td class="mdescRight">Suggest a spelling correction. <a href="#a3575c96a597a5555e474360d91b7622b">More...</a><br /></td></tr>
<tr class="separator:a3575c96a597a5555e474360d91b7622b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1b78757307bb9dfea21fcde470dd71f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ae1b78757307bb9dfea21fcde470dd71f">spellings_begin</a> () const</td></tr>
<tr class="memdesc:ae1b78757307bb9dfea21fcde470dd71f"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all the spelling correction targets. <a href="#ae1b78757307bb9dfea21fcde470dd71f">More...</a><br /></td></tr>
<tr class="separator:ae1b78757307bb9dfea21fcde470dd71f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39766ee84173bcb5ad13b5a9d058c974"><td class="memItemLeft" align="right" valign="top"><a id="a39766ee84173bcb5ad13b5a9d058c974"></a>
<a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a39766ee84173bcb5ad13b5a9d058c974">spellings_end</a> () const</td></tr>
<tr class="memdesc:a39766ee84173bcb5ad13b5a9d058c974"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to <a class="el" href="classXapian_1_1Database.html#ae1b78757307bb9dfea21fcde470dd71f" title="An iterator which returns all the spelling correction targets. ">spellings_begin()</a>. <br /></td></tr>
<tr class="separator:a39766ee84173bcb5ad13b5a9d058c974"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5726d4c4709159738cb41ce82c17e386"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a5726d4c4709159738cb41ce82c17e386">synonyms_begin</a> (const std::string &term) const</td></tr>
<tr class="memdesc:a5726d4c4709159738cb41ce82c17e386"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all the synonyms for a given term. <a href="#a5726d4c4709159738cb41ce82c17e386">More...</a><br /></td></tr>
<tr class="separator:a5726d4c4709159738cb41ce82c17e386"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11f9a24f53a9cb72912d1922513584f8"><td class="memItemLeft" align="right" valign="top"><a id="a11f9a24f53a9cb72912d1922513584f8"></a>
<a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a11f9a24f53a9cb72912d1922513584f8">synonyms_end</a> (const std::string &) const</td></tr>
<tr class="memdesc:a11f9a24f53a9cb72912d1922513584f8"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to synonyms_begin(term). <br /></td></tr>
<tr class="separator:a11f9a24f53a9cb72912d1922513584f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2c8a0b43ef247f4a13cf9775fe0b921"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#aa2c8a0b43ef247f4a13cf9775fe0b921">synonym_keys_begin</a> (const std::string &prefix=std::string()) const</td></tr>
<tr class="memdesc:aa2c8a0b43ef247f4a13cf9775fe0b921"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all terms which have synonyms. <a href="#aa2c8a0b43ef247f4a13cf9775fe0b921">More...</a><br /></td></tr>
<tr class="separator:aa2c8a0b43ef247f4a13cf9775fe0b921"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b7fd27b2daf02d065551455ec6dd1b8"><td class="memItemLeft" align="right" valign="top"><a id="a9b7fd27b2daf02d065551455ec6dd1b8"></a>
<a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a9b7fd27b2daf02d065551455ec6dd1b8">synonym_keys_end</a> (const std::string &=std::string()) const</td></tr>
<tr class="memdesc:a9b7fd27b2daf02d065551455ec6dd1b8"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to synonym_keys_begin(prefix). <br /></td></tr>
<tr class="separator:a9b7fd27b2daf02d065551455ec6dd1b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf085567f558ce1af23ba5edbb5caa60"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#aaf085567f558ce1af23ba5edbb5caa60">get_metadata</a> (const std::string &key) const</td></tr>
<tr class="memdesc:aaf085567f558ce1af23ba5edbb5caa60"><td class="mdescLeft"> </td><td class="mdescRight">Get the user-specified metadata associated with a given key. <a href="#aaf085567f558ce1af23ba5edbb5caa60">More...</a><br /></td></tr>
<tr class="separator:aaf085567f558ce1af23ba5edbb5caa60"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7fe9d6cd94b568e2b5cd218b12ac851c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a7fe9d6cd94b568e2b5cd218b12ac851c">metadata_keys_begin</a> (const std::string &prefix=std::string()) const</td></tr>
<tr class="memdesc:a7fe9d6cd94b568e2b5cd218b12ac851c"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all user-specified metadata keys. <a href="#a7fe9d6cd94b568e2b5cd218b12ac851c">More...</a><br /></td></tr>
<tr class="separator:a7fe9d6cd94b568e2b5cd218b12ac851c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5879feb560d5e84014bd30b9b435dbaf"><td class="memItemLeft" align="right" valign="top"><a id="a5879feb560d5e84014bd30b9b435dbaf"></a>
<a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a5879feb560d5e84014bd30b9b435dbaf">metadata_keys_end</a> (const std::string &=std::string()) const</td></tr>
<tr class="memdesc:a5879feb560d5e84014bd30b9b435dbaf"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to <a class="el" href="classXapian_1_1Database.html#a7fe9d6cd94b568e2b5cd218b12ac851c" title="An iterator which returns all user-specified metadata keys. ">metadata_keys_begin()</a>. <br /></td></tr>
<tr class="separator:a5879feb560d5e84014bd30b9b435dbaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2478b32ee19736222fe97c75c616a52"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ac2478b32ee19736222fe97c75c616a52">get_uuid</a> () const</td></tr>
<tr class="memdesc:ac2478b32ee19736222fe97c75c616a52"><td class="mdescLeft"> </td><td class="mdescRight">Get a UUID for the database. <a href="#ac2478b32ee19736222fe97c75c616a52">More...</a><br /></td></tr>
<tr class="separator:ac2478b32ee19736222fe97c75c616a52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ca06bf1db93879c801e51f6be538eb7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a6ca06bf1db93879c801e51f6be538eb7">locked</a> () const</td></tr>
<tr class="memdesc:a6ca06bf1db93879c801e51f6be538eb7"><td class="mdescLeft"> </td><td class="mdescRight">Test if this database is currently locked for writing. <a href="#a6ca06bf1db93879c801e51f6be538eb7">More...</a><br /></td></tr>
<tr class="separator:a6ca06bf1db93879c801e51f6be538eb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a183a715a301f904ff7b023c1b596752e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#a5965adf733b07c119183c71ef904419c">Xapian::rev</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a183a715a301f904ff7b023c1b596752e">get_revision</a> () const</td></tr>
<tr class="memdesc:a183a715a301f904ff7b023c1b596752e"><td class="mdescLeft"> </td><td class="mdescRight">Get the revision of the database. <a href="#a183a715a301f904ff7b023c1b596752e">More...</a><br /></td></tr>
<tr class="separator:a183a715a301f904ff7b023c1b596752e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02be817100f1269681a55e6f45b74d4e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a02be817100f1269681a55e6f45b74d4e">compact</a> (const std::string &output, unsigned flags=0, int block_size=0)</td></tr>
<tr class="memdesc:a02be817100f1269681a55e6f45b74d4e"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="#a02be817100f1269681a55e6f45b74d4e">More...</a><br /></td></tr>
<tr class="separator:a02be817100f1269681a55e6f45b74d4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdac190fd002c846642beb733aeb850d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#abdac190fd002c846642beb733aeb850d">compact</a> (int fd, unsigned flags=0, int block_size=0)</td></tr>
<tr class="memdesc:abdac190fd002c846642beb733aeb850d"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="#abdac190fd002c846642beb733aeb850d">More...</a><br /></td></tr>
<tr class="separator:abdac190fd002c846642beb733aeb850d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b7a3c20473a72bf88c5419ae2ae406c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a6b7a3c20473a72bf88c5419ae2ae406c">compact</a> (const std::string &output, unsigned flags, int block_size, <a class="el" href="classXapian_1_1Compactor.html">Xapian::Compactor</a> &compactor)</td></tr>
<tr class="memdesc:a6b7a3c20473a72bf88c5419ae2ae406c"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="#a6b7a3c20473a72bf88c5419ae2ae406c">More...</a><br /></td></tr>
<tr class="separator:a6b7a3c20473a72bf88c5419ae2ae406c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eed99afad6e0667adb89d7eb76f8a01"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a6eed99afad6e0667adb89d7eb76f8a01">compact</a> (int fd, unsigned flags, int block_size, <a class="el" href="classXapian_1_1Compactor.html">Xapian::Compactor</a> &compactor)</td></tr>
<tr class="memdesc:a6eed99afad6e0667adb89d7eb76f8a01"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="#a6eed99afad6e0667adb89d7eb76f8a01">More...</a><br /></td></tr>
<tr class="separator:a6eed99afad6e0667adb89d7eb76f8a01"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad730857c480fbff99c2ee5a462c20643"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#ad730857c480fbff99c2ee5a462c20643">check</a> (const std::string &path, int opts=0, std::ostream *out=NULL)</td></tr>
<tr class="memdesc:ad730857c480fbff99c2ee5a462c20643"><td class="mdescLeft"> </td><td class="mdescRight">Check the integrity of a database or database table. <a href="#ad730857c480fbff99c2ee5a462c20643">More...</a><br /></td></tr>
<tr class="separator:ad730857c480fbff99c2ee5a462c20643"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a074aeccd1b455f158b0f020898ec9811"><td class="memItemLeft" align="right" valign="top">static size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1Database.html#a074aeccd1b455f158b0f020898ec9811">check</a> (int fd, int opts=0, std::ostream *out=NULL)</td></tr>
<tr class="memdesc:a074aeccd1b455f158b0f020898ec9811"><td class="mdescLeft"> </td><td class="mdescRight">Check the integrity of a single file database. <a href="#a074aeccd1b455f158b0f020898ec9811">More...</a><br /></td></tr>
<tr class="separator:a074aeccd1b455f158b0f020898ec9811"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class is used to access a database, or a group of databases. </p>
<p>For searching, this class is used in conjunction with an <a class="el" href="classXapian_1_1Enquire.html" title="This class provides an interface to the information retrieval system for the purpose of searching...">Enquire</a> object.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API. ">InvalidArgumentError</a></td><td>will be thrown if an invalid argument is supplied, for example, an unknown database type.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseOpeningError.html" title="DatabaseOpeningError indicates failure to open a database. ">DatabaseOpeningError</a></td><td>may be thrown if the database cannot be opened (for example, a required file cannot be found).</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseVersionError.html" title="DatabaseVersionError indicates that a database is in an unsupported format. ">DatabaseVersionError</a></td><td>may be thrown if the database is in an unsupported format (for example, created by a newer version of <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> which uses an incompatible format). </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a1a1a60feaa21613473dd404585fb25dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a1a60feaa21613473dd404585fb25dd">◆ </a></span>Database() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::Database::Database </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a>, automatically determining the database backend to use. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>directory that the database is stored in. </td></tr>
<tr><td class="paramname">flags</td><td>Bitwise-or of Xapian::DB_* constants. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa882e42d12defaf578e68ac9a4fe36f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa882e42d12defaf578e68ac9a4fe36f0">◆ </a></span>Database() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Xapian::Database::Database </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a single-file <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a>. </p>
<p>This method opens a single-file <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a> given a file descriptor open on it. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> looks starting at the current file offset, allowing a single file database to be easily embedded within another file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>file descriptor for the file. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> takes ownership of this and will close it when the database is closed. </td></tr>
<tr><td class="paramname">flags</td><td>Bitwise-or of Xapian::DB_* constants. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0352b3a47dca16d57c071252e84f1043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0352b3a47dca16d57c071252e84f1043">◆ </a></span>~Database()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::Database::~Database </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy this handle on the database. </p>
<p>If there are no copies of this object remaining, the database(s) will be closed. </p>
</div>
</div>
<a id="aaae498b70286ba1c588b7cbeb0972d38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaae498b70286ba1c588b7cbeb0972d38">◆ </a></span>Database() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::Database::Database </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copying is allowed. </p>
<p>The internals are reference counted, so copying is cheap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The object to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2fc5aa368a7097ca787a831211a2e3bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2fc5aa368a7097ca787a831211a2e3bc">◆ </a></span>add_database()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::add_database </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"><em>database</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an existing database (or group of databases) to those accessed by this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">database</td><td>the database(s) to add. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abf8de9d7fe351a347e7fa9af605a71bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf8de9d7fe351a347e7fa9af605a71bb">◆ </a></span>allterms_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> Xapian::Database::allterms_begin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator which runs across all terms with a given prefix. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prefix</td><td>The prefix to restrict the returned terms to (default: iterate all terms) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad730857c480fbff99c2ee5a462c20643"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad730857c480fbff99c2ee5a462c20643">◆ </a></span>check() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static size_t Xapian::Database::check </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>opts</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream * </td>
<td class="paramname"><em>out</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the integrity of a database or database table. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Path to database or table </td></tr>
<tr><td class="paramname">opts</td><td>Options to use for check </td></tr>
<tr><td class="paramname">out</td><td>std::ostream to write output to (NULL for no output) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a074aeccd1b455f158b0f020898ec9811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a074aeccd1b455f158b0f020898ec9811">◆ </a></span>check() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static size_t Xapian::Database::check </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>opts</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream * </td>
<td class="paramname"><em>out</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the integrity of a single file database. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>file descriptor for the database. The current file offset is used, allowing checking a single file database which is embedded within another file. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> takes ownership of the file descriptor and will close it before returning. </td></tr>
<tr><td class="paramname">opts</td><td>Options to use for check </td></tr>
<tr><td class="paramname">out</td><td>std::ostream to write output to (NULL for no output) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a59f5f8b137723dcaaabdbdccbc0cf1eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59f5f8b137723dcaaabdbdccbc0cf1eb">◆ </a></span>close()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void Xapian::Database::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the database. </p>
<p>This closes the database and closes all its file handles.</p>
<p>For a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a>, if a transaction is active it will be aborted, while if no transaction is active commit() will be implicitly called. Also the write lock is released.</p>
<p>Closing a database cannot be undone - in particular, calling <a class="el" href="classXapian_1_1Database.html#af316aa13ee123e2af75f4b44e1f23db9" title="Re-open the database. ">reopen()</a> after <a class="el" href="classXapian_1_1Database.html#a59f5f8b137723dcaaabdbdccbc0cf1eb" title="Close the database. ">close()</a> will not reopen it, but will instead throw a <a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a> exception.</p>
<p>Calling <a class="el" href="classXapian_1_1Database.html#a59f5f8b137723dcaaabdbdccbc0cf1eb" title="Close the database. ">close()</a> again on a database which has already been closed has no effect (and doesn't raise an exception).</p>
<p>After <a class="el" href="classXapian_1_1Database.html#a59f5f8b137723dcaaabdbdccbc0cf1eb" title="Close the database. ">close()</a> has been called, calls to other methods of the database, and to methods of other objects associated with the database, will either:</p>
<ul>
<li>behave exactly as they would have done if the database had not been closed (this can only happen if all the required data is cached)</li>
<li>raise a <a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a> exception indicating that the database is closed.</li>
</ul>
<p>The reason for this behaviour is that otherwise we'd have to check that the database is still open on every method call on every object associated with a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Database</a>, when in many cases they are working on data which has already been loaded and so they are able to just behave correctly.</p>
<p>This method was added in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> 1.1.0. </p>
</div>
</div>
<a id="a02be817100f1269681a55e6f45b74d4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02be817100f1269681a55e6f45b74d4e">◆ </a></span>compact() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::compact </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>block_size</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produce a compact version of this database. </p>
<p>New 1.3.4. Various methods of the <a class="el" href="classXapian_1_1Compactor.html" title="Compact a database, or merge and compact several. ">Compactor</a> class were deprecated in 1.3.4.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>Path to write the compact version to. This can be the same as an input if that input is a stub database (in which case the database(s) listed in the stub will be compacted to a new database and then the stub will be atomically updated to point to this new database).</td></tr>
<tr><td class="paramname">flags</td><td>Any of the following combined using bitwise-or (| in C++):<ul>
<li><a class="el" href="namespaceXapian.html#ad5ae872cce50aa9e0887e46474d0f3a2" title="Use the same document ids in the output as in the input(s). ">Xapian::DBCOMPACT_NO_RENUMBER</a> By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.</li>
<li><a class="el" href="namespaceXapian.html#a8ca921e21346f925fc50167b1336d9ab" title="If merging more than 3 databases, merge the postlists in multiple passes. ">Xapian::DBCOMPACT_MULTIPASS</a> If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.</li>
<li><a class="el" href="namespaceXapian.html#af230d8321f07e93dc62d57a6fcfe89fa" title="Produce a single-file database. ">Xapian::DBCOMPACT_SINGLE_FILE</a> Produce a single-file database (only supported for glass currently).</li>
<li>At most one of:<ul>
<li><a class="el" href="classXapian_1_1Compactor.html#a4b90abf7e889f29c0ab31904598d7276af46264e20be7a1d98fd1dfab2cba8a14" title="Don't split items unnecessarily. ">Xapian::Compactor::STANDARD</a> - Don't split items unnecessarily.</li>
<li><a class="el" href="classXapian_1_1Compactor.html#a4b90abf7e889f29c0ab31904598d7276a15494f71d5fdcd952b64e70d5097129a" title="Split items whenever it saves space (the default). ">Xapian::Compactor::FULL</a> - Split items whenever it saves space (the default).</li>
<li><a class="el" href="classXapian_1_1Compactor.html#a4b90abf7e889f29c0ab31904598d7276a8e232f214096b41c10bd6eddfe01bb34" title="Allow oversize items to save more space (not recommended if you ever plan to update the compacted dat...">Xapian::Compactor::FULLER</a> - Allow oversize items to save more space (not recommended if you ever plan to update the compacted database).</li>
</ul>
</li>
</ul>
</td></tr>
<tr><td class="paramname">block_size</td><td>This specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abdac190fd002c846642beb733aeb850d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdac190fd002c846642beb733aeb850d">◆ </a></span>compact() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::compact </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>block_size</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produce a compact version of this database. </p>
<p>New 1.3.4. Various methods of the <a class="el" href="classXapian_1_1Compactor.html" title="Compact a database, or merge and compact several. ">Compactor</a> class were deprecated in 1.3.4.</p>
<p>This variant writes a single-file database to the specified file descriptor. Only the glass backend supports such databases, so this form is only supported for this backend.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>File descriptor to write the compact version to. The descriptor needs to be readable and writable (open with O_RDWR) and seekable. The current file offset is used, allowing compacting to a single file database embedded within another file. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> takes ownership of the file descriptor and will close it before returning.</td></tr>
<tr><td class="paramname">flags</td><td>Any of the following combined using bitwise-or (| in C++):<ul>
<li><a class="el" href="namespaceXapian.html#ad5ae872cce50aa9e0887e46474d0f3a2" title="Use the same document ids in the output as in the input(s). ">Xapian::DBCOMPACT_NO_RENUMBER</a> By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.</li>
<li><a class="el" href="namespaceXapian.html#a8ca921e21346f925fc50167b1336d9ab" title="If merging more than 3 databases, merge the postlists in multiple passes. ">Xapian::DBCOMPACT_MULTIPASS</a> If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.</li>
<li><a class="el" href="namespaceXapian.html#af230d8321f07e93dc62d57a6fcfe89fa" title="Produce a single-file database. ">Xapian::DBCOMPACT_SINGLE_FILE</a> Produce a single-file database (only supported for glass currently) - this flag is implied in this form and need not be specified explicitly.</li>
</ul>
</td></tr>
<tr><td class="paramname">block_size</td><td>This specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6b7a3c20473a72bf88c5419ae2ae406c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b7a3c20473a72bf88c5419ae2ae406c">◆ </a></span>compact() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::compact </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>output</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXapian_1_1Compactor.html">Xapian::Compactor</a> & </td>
<td class="paramname"><em>compactor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produce a compact version of this database. </p>
<p>New 1.3.4. Various methods of the <a class="el" href="classXapian_1_1Compactor.html" title="Compact a database, or merge and compact several. ">Compactor</a> class were deprecated in 1.3.4.</p>
<p>The <em>compactor</em> functor allows handling progress output and specifying how user metadata is merged.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">output</td><td>Path to write the compact version to. This can be the same as an input if that input is a stub database (in which case the database(s) listed in the stub will be compacted to a new database and then the stub will be atomically updated to point to this new database).</td></tr>
<tr><td class="paramname">flags</td><td>Any of the following combined using bitwise-or (| in C++):<ul>
<li><a class="el" href="namespaceXapian.html#ad5ae872cce50aa9e0887e46474d0f3a2" title="Use the same document ids in the output as in the input(s). ">Xapian::DBCOMPACT_NO_RENUMBER</a> By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.</li>
<li><a class="el" href="namespaceXapian.html#a8ca921e21346f925fc50167b1336d9ab" title="If merging more than 3 databases, merge the postlists in multiple passes. ">Xapian::DBCOMPACT_MULTIPASS</a> If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.</li>
<li><a class="el" href="namespaceXapian.html#af230d8321f07e93dc62d57a6fcfe89fa" title="Produce a single-file database. ">Xapian::DBCOMPACT_SINGLE_FILE</a> Produce a single-file database (only supported for glass currently).</li>
</ul>
</td></tr>
<tr><td class="paramname">block_size</td><td>This specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes.</td></tr>
<tr><td class="paramname">compactor</td><td>Functor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6eed99afad6e0667adb89d7eb76f8a01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eed99afad6e0667adb89d7eb76f8a01">◆ </a></span>compact() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::compact </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>block_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXapian_1_1Compactor.html">Xapian::Compactor</a> & </td>
<td class="paramname"><em>compactor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Produce a compact version of this database. </p>
<p>New 1.3.4. Various methods of the <a class="el" href="classXapian_1_1Compactor.html" title="Compact a database, or merge and compact several. ">Compactor</a> class were deprecated in 1.3.4.</p>
<p>The <em>compactor</em> functor allows handling progress output and specifying how user metadata is merged.</p>
<p>This variant writes a single-file database to the specified file descriptor. Only the glass backend supports such databases, so this form is only supported for this backend.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>File descriptor to write the compact version to. The descriptor needs to be readable and writable (open with O_RDWR) and seekable. The current file offset is used, allowing compacting to a single file database embedded within another file. <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> takes ownership of the file descriptor and will close it before returning.</td></tr>
<tr><td class="paramname">flags</td><td>Any of the following combined using bitwise-or (| in C++):<ul>
<li><a class="el" href="namespaceXapian.html#ad5ae872cce50aa9e0887e46474d0f3a2" title="Use the same document ids in the output as in the input(s). ">Xapian::DBCOMPACT_NO_RENUMBER</a> By default the document ids will be renumbered the output - currently by applying the same offset to all the document ids in a particular source database. If this flag is specified, then this renumbering doesn't happen, but all the document ids must be unique over all source databases. Currently the ranges of document ids in each source must not overlap either, though this restriction may be removed in the future.</li>
<li><a class="el" href="namespaceXapian.html#a8ca921e21346f925fc50167b1336d9ab" title="If merging more than 3 databases, merge the postlists in multiple passes. ">Xapian::DBCOMPACT_MULTIPASS</a> If merging more than 3 databases, merge the postlists in multiple passes, which is generally faster but requires more disk space for temporary files.</li>
<li><a class="el" href="namespaceXapian.html#af230d8321f07e93dc62d57a6fcfe89fa" title="Produce a single-file database. ">Xapian::DBCOMPACT_SINGLE_FILE</a> Produce a single-file database (only supported for glass currently) - this flag is implied in this form and need not be specified explicitly.</li>
</ul>
</td></tr>
<tr><td class="paramname">block_size</td><td>This specifies the block size (in bytes) for to use for the output. For glass, the block size must be a power of 2 between 2048 and 65536 (inclusive), and the default (also used if an invalid value is passed) is 8192 bytes.</td></tr>
<tr><td class="paramname">compactor</td><td>Functor </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a78e85ae6f00d4bdd656906eacffbe2f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a78e85ae6f00d4bdd656906eacffbe2f4">◆ </a></span>get_collection_freq()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> Xapian::Database::get_collection_freq </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>tname</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the total number of occurrences of the given term. </p>
<p>This is the sum of the number of occurrences of the term in each document it indexes: i.e., the sum of the within document frequencies of the term.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tname</td><td>The term whose collection frequency is being requested. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a62b82e621157bca6263d9f85adbaf9a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b82e621157bca6263d9f85adbaf9a9">◆ </a></span>get_doclength_lower_bound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> Xapian::Database::get_doclength_lower_bound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a lower bound on the length of a document in this DB. </p>
<p>This bound does not include any zero-length documents. </p>
</div>
</div>
<a id="ab1538016d90d8afc5fea870cd1d3a8bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1538016d90d8afc5fea870cd1d3a8bc">◆ </a></span>get_document() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> Xapian::Database::get_document </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td>
<td class="paramname"><em>did</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a document from the database, given its document id. </p>
<p>This method returns a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Xapian::Document</a> object which provides the information about a document.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">did</td><td>The document id of the document to retrieve.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Xapian::Document</a> object containing the document data</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DocNotFoundError.html" title="Indicates an attempt to access a document not present in the database. ">Xapian::DocNotFoundError</a></td><td>The document specified could not be found in the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API. ">Xapian::InvalidArgumentError</a></td><td>did was 0, which is not a valid document id. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a478d9e6ccef471bcb661eaf03ddfa2f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a478d9e6ccef471bcb661eaf03ddfa2f7">◆ </a></span>get_document() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> Xapian::Database::get_document </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td>
<td class="paramname"><em>did</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a document from the database, given its document id. </p>
<p>This method returns a <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Xapian::Document</a> object which provides the information about a document.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">did</td><td>The document id of the document to retrieve. </td></tr>
<tr><td class="paramname">flags</td><td>Zero or more flags bitwise-or-ed together (currently only <a class="el" href="namespaceXapian.html#a53b5f6221e72c434fd4f364529513bbe" title="Assume document id is valid. ">Xapian::DOC_ASSUME_VALID</a> is supported).</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classXapian_1_1Document.html" title="A handle representing a document in a Xapian database. ">Xapian::Document</a> object containing the document data</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DocNotFoundError.html" title="Indicates an attempt to access a document not present in the database. ">Xapian::DocNotFoundError</a></td><td>The document specified could not be found in the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API. ">Xapian::InvalidArgumentError</a></td><td>did was 0, which is not a valid document id. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aaf085567f558ce1af23ba5edbb5caa60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf085567f558ce1af23ba5edbb5caa60">◆ </a></span>get_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Database::get_metadata </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the user-specified metadata associated with a given key. </p>
<p>User-specified metadata allows you to store arbitrary information in the form of (key,tag) pairs. See <em><a class="el" href="classXapian_1_1WritableDatabase.html#abd9a9fde5be5614e93559810df865a98" title="Set the user-specified metadata associated with a given key. ">WritableDatabase::set_metadata()</a></em> for more information.</p>
<p>When invoked on a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Xapian::Database</a> object representing multiple databases, currently only the metadata for the first is considered but this behaviour may change in the future.</p>
<p>If there is no piece of metadata associated with the specified key, an empty string is returned (this applies even for backends which don't support metadata).</p>
<p>Empty keys are not valid, and specifying one will cause an exception.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>The key of the metadata item to access.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The retrieved metadata item's value.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidArgumentError.html" title="InvalidArgumentError indicates an invalid parameter value was passed to the API. ">Xapian::InvalidArgumentError</a></td><td>will be thrown if the key supplied is empty. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a183a715a301f904ff7b023c1b596752e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a183a715a301f904ff7b023c1b596752e">◆ </a></span>get_revision()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a5965adf733b07c119183c71ef904419c">Xapian::rev</a> Xapian::Database::get_revision </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the revision of the database. </p>
<p>The revision is an unsigned integer which increases with each commit.</p>
<p>The database must have exactly one sub-database, which must be of type chert or glass. Otherwise an exception will be thrown.</p>
<p>Experimental - see <a href="https://xapian.org/docs/deprecation#experimental-features">https://xapian.org/docs/deprecation#experimental-features</a> </p>
</div>
</div>
<a id="a3575c96a597a5555e474360d91b7622b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3575c96a597a5555e474360d91b7622b">◆ </a></span>get_spelling_suggestion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Database::get_spelling_suggestion </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>word</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>max_edit_distance</em> = <code>2</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Suggest a spelling correction. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>The potentially misspelled word. </td></tr>
<tr><td class="paramname">max_edit_distance</td><td>Only consider words which are at most <em>max_edit_distance</em> edits from <em>word</em>. An edit is a character insertion, deletion, or the transposition of two adjacent characters (default is 2). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac2478b32ee19736222fe97c75c616a52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2478b32ee19736222fe97c75c616a52">◆ </a></span>get_uuid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Database::get_uuid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a UUID for the database. </p>
<p>The UUID will persist for the lifetime of the database.</p>
<p>Replicas (eg, made with the replication protocol, or by copying all the database files) will have the same UUID. However, copies (made with copydatabase, or xapian-compact) will have different UUIDs.</p>
<p>If the backend does not support UUIDs or this database has no subdatabases, the UUID will be empty.</p>
<p>If this database has multiple sub-databases, the UUID string will contain the UUIDs of all the sub-databases. </p>
</div>
</div>
<a id="ae042528f17c284298444706845a70cc0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae042528f17c284298444706845a70cc0">◆ </a></span>get_value_freq()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#a9bbd62a8e56ea4619e4e59afb32aced6">Xapian::doccount</a> Xapian::Database::get_value_freq </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the frequency of a given value slot. </p>
<p>This is the number of documents which have a (non-empty) value stored in the slot.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>The value slot to examine.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature. ">UnimplementedError</a></td><td>The frequency of the value isn't available for this database type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a2ecd343f41ed751d60b924b2099603b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ecd343f41ed751d60b924b2099603b6">◆ </a></span>get_value_lower_bound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Database::get_value_lower_bound </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a lower bound on the values stored in the given value slot. </p>
<p>If there are no values stored in the given value slot, this will return an empty string.</p>
<p>If the lower bound isn't available for the given database type, this will return the lowest possible bound - the empty string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>The value slot to examine. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7ded2510f626182edd6da82cfc2f3b3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ded2510f626182edd6da82cfc2f3b3f">◆ </a></span>get_value_upper_bound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Xapian::Database::get_value_upper_bound </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#a94a899651fa920c72ffa9635bde630ea">Xapian::valueno</a> </td>
<td class="paramname"><em>slot</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an upper bound on the values stored in the given value slot. </p>
<p>If there are no values stored in the given value slot, this will return an empty string.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">slot</td><td>The value slot to examine.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature. ">UnimplementedError</a></td><td>The upper bound of the values isn't available for this database type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a759d1fde0d3d8a2ed74b83c0ebd10974"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a759d1fde0d3d8a2ed74b83c0ebd10974">◆ </a></span>keep_alive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::keep_alive </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send a "keep-alive" to remote databases to stop them timing out. </p>
<p>Has no effect on non-remote databases. </p>
</div>
</div>
<a id="a6ca06bf1db93879c801e51f6be538eb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ca06bf1db93879c801e51f6be538eb7">◆ </a></span>locked()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::Database::locked </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if this database is currently locked for writing. </p>
<p>If the underlying object is actually a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a>, always returns true.</p>
<p>Otherwise tests if there's a writer holding the lock (or if we can't test for a lock without taking it on the current platform, throw <a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature. ">Xapian::UnimplementedError</a>). If there's an error while trying to test the lock, throws <a class="el" href="classXapian_1_1DatabaseLockError.html" title="DatabaseLockError indicates failure to lock a database. ">Xapian::DatabaseLockError</a>.</p>
<p>For multi-databases, this tests each sub-database and returns true if any of them are locked. </p>
</div>
</div>
<a id="a7fe9d6cd94b568e2b5cd218b12ac851c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7fe9d6cd94b568e2b5cd218b12ac851c">◆ </a></span>metadata_keys_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> Xapian::Database::metadata_keys_begin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator which returns all user-specified metadata keys. </p>
<p>When invoked on a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. ">Xapian::Database</a> object representing multiple databases, currently only the metadata for the first is considered but this behaviour may change in the future.</p>
<p>If the backend doesn't support metadata, then this method returns an iterator which compares equal to that returned by <a class="el" href="classXapian_1_1Database.html#a5879feb560d5e84014bd30b9b435dbaf" title="Corresponding end iterator to metadata_keys_begin(). ">metadata_keys_end()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prefix</td><td>If non-empty, only keys with this prefix are returned.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1UnimplementedError.html" title="UnimplementedError indicates an attempt to use an unimplemented feature. ">Xapian::UnimplementedError</a></td><td>will be thrown if the backend implements user-specified metadata, but doesn't implement iterating its keys (currently this happens for the <a class="el" href="namespaceXapian_1_1InMemory.html" title="Database factory functions for the inmemory backend. ">InMemory</a> backend). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4e8badea7a9d7292c13f99429c6a2b79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e8badea7a9d7292c13f99429c6a2b79">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::Database::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Database.html">Database</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment is allowed. </p>
<p>The internals are reference counted, so assignment is cheap.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>The object to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a117ac642b800b21e3b9411931374d9df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a117ac642b800b21e3b9411931374d9df">◆ </a></span>postlist_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1PostingIterator.html">PostingIterator</a> Xapian::Database::postlist_begin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>tname</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator pointing to the start of the postlist for a given term. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tname</td><td>The termname to iterate postings for. If the term name is the empty string, the iterator returned will list all the documents in the database. Such an iterator will always return a WDF value of 1, since there is no obvious meaning for this quantity in this case. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af316aa13ee123e2af75f4b44e1f23db9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af316aa13ee123e2af75f4b44e1f23db9">◆ </a></span>reopen()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::Database::reopen </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Re-open the database. </p>
<p>This re-opens the database(s) to the latest available version(s). It can be used either to make sure the latest results are returned, or to recover from a <a class="el" href="classXapian_1_1DatabaseModifiedError.html" title="DatabaseModifiedError indicates a database was modified. ">Xapian::DatabaseModifiedError</a>.</p>
<p>Calling <a class="el" href="classXapian_1_1Database.html#af316aa13ee123e2af75f4b44e1f23db9" title="Re-open the database. ">reopen()</a> on a database which has been closed (with <em><a class="el" href="classXapian_1_1Database.html#a59f5f8b137723dcaaabdbdccbc0cf1eb" title="Close the database. ">close()</a></em>) will always raise a <a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the database might have been reopened (if false is returned, the database definitely hasn't been reopened, which applications may find useful when caching results, etc). In <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> < 1.3.0, this method did not return a value. </dd></dl>
</div>
</div>
<a id="ae1b78757307bb9dfea21fcde470dd71f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1b78757307bb9dfea21fcde470dd71f">◆ </a></span>spellings_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> Xapian::Database::spellings_begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator which returns all the spelling correction targets. </p>
<p>This returns all the words which are considered as targets for the spelling correction algorithm. The frequency of each word is available as the term frequency of each entry in the returned iterator. </p>
</div>
</div>
<a id="aa2c8a0b43ef247f4a13cf9775fe0b921"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2c8a0b43ef247f4a13cf9775fe0b921">◆ </a></span>synonym_keys_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> Xapian::Database::synonym_keys_begin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> = <code>std::string()</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator which returns all terms which have synonyms. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prefix</td><td>If non-empty, only terms with this prefix are returned. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5726d4c4709159738cb41ce82c17e386"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5726d4c4709159738cb41ce82c17e386">◆ </a></span>synonyms_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">Xapian::TermIterator</a> Xapian::Database::synonyms_begin </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>term</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator which returns all the synonyms for a given term. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to return synonyms for. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad53ea363158a152ade8231c89b625d9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad53ea363158a152ade8231c89b625d9f">◆ </a></span>term_exists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Xapian::Database::term_exists </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>tname</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a given term exists in the database. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tname</td><td>The term to test the existence of.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if and only if the term exists in the database. This is the same as (get_termfreq(tname) != 0), but will often be more efficient. </dd></dl>
</div>
</div>
<a id="a6cf15b9cb9f818b0cadce792562f9b27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6cf15b9cb9f818b0cadce792562f9b27">◆ </a></span>termlist_begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1TermIterator.html">TermIterator</a> Xapian::Database::termlist_begin </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td>
<td class="paramname"><em>did</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>An iterator pointing to the start of the termlist for a given document. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">did</td><td>The document id of the document to iterate terms for. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>xapian/<a class="el" href="database_8h.html">database.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<address><small>
Documentation for Xapian (version 1.4.3).<br>
Generated on Wed Jan 25 2017 by
<a href="http://www.doxygen.org/">Doxygen 1.8.13</a>.
</small></address>
</body>
</html>
|
