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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: Xapian::WritableDatabase 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_1WritableDatabase.html">WritableDatabase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classXapian_1_1WritableDatabase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Xapian::WritableDatabase Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class provides read/write access to a database.
<a href="classXapian_1_1WritableDatabase.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::WritableDatabase:</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_1WritableDatabase__inherit__graph.png" border="0" usemap="#Xapian_1_1WritableDatabase_inherit__map" alt="Inheritance graph"/></div>
<map name="Xapian_1_1WritableDatabase_inherit__map" id="Xapian_1_1WritableDatabase_inherit__map">
<area shape="rect" id="node2" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases. " alt="" coords="29,5,156,32"/>
</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:a98ae55d72630237f346986b60e765e36"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a98ae55d72630237f346986b60e765e36">~WritableDatabase</a> ()</td></tr>
<tr class="memdesc:a98ae55d72630237f346986b60e765e36"><td class="mdescLeft"> </td><td class="mdescRight">Destroy this handle on the database. <a href="#a98ae55d72630237f346986b60e765e36">More...</a><br /></td></tr>
<tr class="separator:a98ae55d72630237f346986b60e765e36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac80ed31814feebd10c6222386e31472e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#ac80ed31814feebd10c6222386e31472e">WritableDatabase</a> ()</td></tr>
<tr class="memdesc:ac80ed31814feebd10c6222386e31472e"><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a> with no subdatabases. <a href="#ac80ed31814feebd10c6222386e31472e">More...</a><br /></td></tr>
<tr class="separator:ac80ed31814feebd10c6222386e31472e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acac2d0fa337933e0ed66c7dce2ce75d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#acac2d0fa337933e0ed66c7dce2ce75d0">WritableDatabase</a> (const std::string &path, int flags=0, int block_size=0)</td></tr>
<tr class="memdesc:acac2d0fa337933e0ed66c7dce2ce75d0"><td class="mdescLeft"> </td><td class="mdescRight">Open a database for update, automatically determining the database backend to use. <a href="#acac2d0fa337933e0ed66c7dce2ce75d0">More...</a><br /></td></tr>
<tr class="separator:acac2d0fa337933e0ed66c7dce2ce75d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1529742b3f7eb92f07e75f2308bc2f3a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a1529742b3f7eb92f07e75f2308bc2f3a">WritableDatabase</a> (const <a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> &other)</td></tr>
<tr class="memdesc:a1529742b3f7eb92f07e75f2308bc2f3a"><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="#a1529742b3f7eb92f07e75f2308bc2f3a">More...</a><br /></td></tr>
<tr class="separator:a1529742b3f7eb92f07e75f2308bc2f3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac97254827cb74c93606ae046dcdd3754"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#ac97254827cb74c93606ae046dcdd3754">operator=</a> (const <a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> &other)</td></tr>
<tr class="memdesc:ac97254827cb74c93606ae046dcdd3754"><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed. <a href="#ac97254827cb74c93606ae046dcdd3754">More...</a><br /></td></tr>
<tr class="separator:ac97254827cb74c93606ae046dcdd3754"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbea2163142de795024880a7123bc693"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693">commit</a> ()</td></tr>
<tr class="memdesc:acbea2163142de795024880a7123bc693"><td class="mdescLeft"> </td><td class="mdescRight">Commit any pending modifications made to the database. <a href="#acbea2163142de795024880a7123bc693">More...</a><br /></td></tr>
<tr class="separator:acbea2163142de795024880a7123bc693"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae767fd6fec96a126763f818fdc0abca7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#ae767fd6fec96a126763f818fdc0abca7">flush</a> ()</td></tr>
<tr class="memdesc:ae767fd6fec96a126763f818fdc0abca7"><td class="mdescLeft"> </td><td class="mdescRight">Pre-1.1.0 name for <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a>. <a href="#ae767fd6fec96a126763f818fdc0abca7">More...</a><br /></td></tr>
<tr class="separator:ae767fd6fec96a126763f818fdc0abca7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1436584192e592cead34ea6a4d5af56f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a1436584192e592cead34ea6a4d5af56f">begin_transaction</a> (bool flushed=true)</td></tr>
<tr class="memdesc:a1436584192e592cead34ea6a4d5af56f"><td class="mdescLeft"> </td><td class="mdescRight">Begin a transaction. <a href="#a1436584192e592cead34ea6a4d5af56f">More...</a><br /></td></tr>
<tr class="separator:a1436584192e592cead34ea6a4d5af56f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3d330f3a27cc17d78635781c7b77280f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a3d330f3a27cc17d78635781c7b77280f">commit_transaction</a> ()</td></tr>
<tr class="memdesc:a3d330f3a27cc17d78635781c7b77280f"><td class="mdescLeft"> </td><td class="mdescRight">Complete the transaction currently in progress. <a href="#a3d330f3a27cc17d78635781c7b77280f">More...</a><br /></td></tr>
<tr class="separator:a3d330f3a27cc17d78635781c7b77280f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a537b50dd4aad61020ea8536e93559a72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a537b50dd4aad61020ea8536e93559a72">cancel_transaction</a> ()</td></tr>
<tr class="memdesc:a537b50dd4aad61020ea8536e93559a72"><td class="mdescLeft"> </td><td class="mdescRight">Abort the transaction currently in progress, discarding the pending modifications made to the database. <a href="#a537b50dd4aad61020ea8536e93559a72">More...</a><br /></td></tr>
<tr class="separator:a537b50dd4aad61020ea8536e93559a72"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecdd2e1d3a0364c4933ef4fe655f080b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#aecdd2e1d3a0364c4933ef4fe655f080b">add_document</a> (const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &document)</td></tr>
<tr class="memdesc:aecdd2e1d3a0364c4933ef4fe655f080b"><td class="mdescLeft"> </td><td class="mdescRight">Add a new document to the database. <a href="#aecdd2e1d3a0364c4933ef4fe655f080b">More...</a><br /></td></tr>
<tr class="separator:aecdd2e1d3a0364c4933ef4fe655f080b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cfd78ba9108b9ef2cf9b4a9f545c70d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a0cfd78ba9108b9ef2cf9b4a9f545c70d">delete_document</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did)</td></tr>
<tr class="memdesc:a0cfd78ba9108b9ef2cf9b4a9f545c70d"><td class="mdescLeft"> </td><td class="mdescRight">Delete a document from the database. <a href="#a0cfd78ba9108b9ef2cf9b4a9f545c70d">More...</a><br /></td></tr>
<tr class="separator:a0cfd78ba9108b9ef2cf9b4a9f545c70d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8426619892e77112e832fc4b11b8efc3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a8426619892e77112e832fc4b11b8efc3">delete_document</a> (const std::string &unique_term)</td></tr>
<tr class="memdesc:a8426619892e77112e832fc4b11b8efc3"><td class="mdescLeft"> </td><td class="mdescRight">Delete any documents indexed by a term from the database. <a href="#a8426619892e77112e832fc4b11b8efc3">More...</a><br /></td></tr>
<tr class="separator:a8426619892e77112e832fc4b11b8efc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23344c9000ea98b15d491fa875bd5d1e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a23344c9000ea98b15d491fa875bd5d1e">replace_document</a> (<a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> did, const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &document)</td></tr>
<tr class="memdesc:a23344c9000ea98b15d491fa875bd5d1e"><td class="mdescLeft"> </td><td class="mdescRight">Replace a given document in the database. <a href="#a23344c9000ea98b15d491fa875bd5d1e">More...</a><br /></td></tr>
<tr class="separator:a23344c9000ea98b15d491fa875bd5d1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43c4630ec482508667e9ca539f19cbf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a43c4630ec482508667e9ca539f19cbf0">replace_document</a> (const std::string &unique_term, const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> &document)</td></tr>
<tr class="memdesc:a43c4630ec482508667e9ca539f19cbf0"><td class="mdescLeft"> </td><td class="mdescRight">Replace any documents matching a term. <a href="#a43c4630ec482508667e9ca539f19cbf0">More...</a><br /></td></tr>
<tr class="separator:a43c4630ec482508667e9ca539f19cbf0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9d3ed0413b6b62ad2e70785c15bb37f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#ad9d3ed0413b6b62ad2e70785c15bb37f">add_spelling</a> (const std::string &word, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> freqinc=1) const</td></tr>
<tr class="memdesc:ad9d3ed0413b6b62ad2e70785c15bb37f"><td class="mdescLeft"> </td><td class="mdescRight">Add a word to the spelling dictionary. <a href="#ad9d3ed0413b6b62ad2e70785c15bb37f">More...</a><br /></td></tr>
<tr class="separator:ad9d3ed0413b6b62ad2e70785c15bb37f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a1999a20b879badb29d02acd4972600"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a4a1999a20b879badb29d02acd4972600">remove_spelling</a> (const std::string &word, <a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> freqdec=1) const</td></tr>
<tr class="memdesc:a4a1999a20b879badb29d02acd4972600"><td class="mdescLeft"> </td><td class="mdescRight">Remove a word from the spelling dictionary. <a href="#a4a1999a20b879badb29d02acd4972600">More...</a><br /></td></tr>
<tr class="separator:a4a1999a20b879badb29d02acd4972600"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7dc1c07b3a68b8dd6a63cc52732fd3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#af7dc1c07b3a68b8dd6a63cc52732fd3c">add_synonym</a> (const std::string &term, const std::string &synonym) const</td></tr>
<tr class="memdesc:af7dc1c07b3a68b8dd6a63cc52732fd3c"><td class="mdescLeft"> </td><td class="mdescRight">Add a synonym for a term. <a href="#af7dc1c07b3a68b8dd6a63cc52732fd3c">More...</a><br /></td></tr>
<tr class="separator:af7dc1c07b3a68b8dd6a63cc52732fd3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18b9115c6b759f62b6b6f2e8c1e10efa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a18b9115c6b759f62b6b6f2e8c1e10efa">remove_synonym</a> (const std::string &term, const std::string &synonym) const</td></tr>
<tr class="memdesc:a18b9115c6b759f62b6b6f2e8c1e10efa"><td class="mdescLeft"> </td><td class="mdescRight">Remove a synonym for a term. <a href="#a18b9115c6b759f62b6b6f2e8c1e10efa">More...</a><br /></td></tr>
<tr class="separator:a18b9115c6b759f62b6b6f2e8c1e10efa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18d335a3efe7467a8668acc862b58d08"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a18d335a3efe7467a8668acc862b58d08">clear_synonyms</a> (const std::string &term) const</td></tr>
<tr class="memdesc:a18d335a3efe7467a8668acc862b58d08"><td class="mdescLeft"> </td><td class="mdescRight">Remove all synonyms for a term. <a href="#a18d335a3efe7467a8668acc862b58d08">More...</a><br /></td></tr>
<tr class="separator:a18d335a3efe7467a8668acc862b58d08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd9a9fde5be5614e93559810df865a98"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#abd9a9fde5be5614e93559810df865a98">set_metadata</a> (const std::string &key, const std::string &value)</td></tr>
<tr class="memdesc:abd9a9fde5be5614e93559810df865a98"><td class="mdescLeft"> </td><td class="mdescRight">Set the user-specified metadata associated with a given key. <a href="#abd9a9fde5be5614e93559810df865a98">More...</a><br /></td></tr>
<tr class="separator:abd9a9fde5be5614e93559810df865a98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d8c0a9390d6616735f5e015c596cd6a"><td class="memItemLeft" align="right" valign="top"><a id="a7d8c0a9390d6616735f5e015c596cd6a"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classXapian_1_1WritableDatabase.html#a7d8c0a9390d6616735f5e015c596cd6a">get_description</a> () const</td></tr>
<tr class="memdesc:a7d8c0a9390d6616735f5e015c596cd6a"><td class="mdescLeft"> </td><td class="mdescRight">Return a string describing this object. <br /></td></tr>
<tr class="separator:a7d8c0a9390d6616735f5e015c596cd6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classXapian_1_1Database"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classXapian_1_1Database')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classXapian_1_1Database.html">Xapian::Database</a></td></tr>
<tr class="memitem:a2fc5aa368a7097ca787a831211a2e3bc inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Add an existing database (or group of databases) to those accessed by this object. <a href="classXapian_1_1Database.html#a2fc5aa368a7097ca787a831211a2e3bc">More...</a><br /></td></tr>
<tr class="separator:a2fc5aa368a7097ca787a831211a2e3bc inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24f8197f3ac8bfd8c2526e0b8dff4ff7 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a1a60feaa21613473dd404585fb25dd inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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="classXapian_1_1Database.html#a1a1a60feaa21613473dd404585fb25dd">More...</a><br /></td></tr>
<tr class="separator:a1a1a60feaa21613473dd404585fb25dd inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa882e42d12defaf578e68ac9a4fe36f0 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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="classXapian_1_1Database.html#aa882e42d12defaf578e68ac9a4fe36f0">More...</a><br /></td></tr>
<tr class="separator:aa882e42d12defaf578e68ac9a4fe36f0 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0352b3a47dca16d57c071252e84f1043 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Destroy this handle on the database. <a href="classXapian_1_1Database.html#a0352b3a47dca16d57c071252e84f1043">More...</a><br /></td></tr>
<tr class="separator:a0352b3a47dca16d57c071252e84f1043 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaae498b70286ba1c588b7cbeb0972d38 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Copying is allowed. <a href="classXapian_1_1Database.html#aaae498b70286ba1c588b7cbeb0972d38">More...</a><br /></td></tr>
<tr class="separator:aaae498b70286ba1c588b7cbeb0972d38 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e8badea7a9d7292c13f99429c6a2b79 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Assignment is allowed. <a href="classXapian_1_1Database.html#a4e8badea7a9d7292c13f99429c6a2b79">More...</a><br /></td></tr>
<tr class="separator:a4e8badea7a9d7292c13f99429c6a2b79 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af316aa13ee123e2af75f4b44e1f23db9 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Re-open the database. <a href="classXapian_1_1Database.html#af316aa13ee123e2af75f4b44e1f23db9">More...</a><br /></td></tr>
<tr class="separator:af316aa13ee123e2af75f4b44e1f23db9 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59f5f8b137723dcaaabdbdccbc0cf1eb inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Close the database. <a href="classXapian_1_1Database.html#a59f5f8b137723dcaaabdbdccbc0cf1eb">More...</a><br /></td></tr>
<tr class="separator:a59f5f8b137723dcaaabdbdccbc0cf1eb inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a117ac642b800b21e3b9411931374d9df inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to the start of the postlist for a given term. <a href="classXapian_1_1Database.html#a117ac642b800b21e3b9411931374d9df">More...</a><br /></td></tr>
<tr class="separator:a117ac642b800b21e3b9411931374d9df inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e752d10963ba93bbf16149f77e6c0d7 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6cf15b9cb9f818b0cadce792562f9b27 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator pointing to the start of the termlist for a given document. <a href="classXapian_1_1Database.html#a6cf15b9cb9f818b0cadce792562f9b27">More...</a><br /></td></tr>
<tr class="separator:a6cf15b9cb9f818b0cadce792562f9b27 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae08dcc72562c276399ed1f44fe55a56b inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada86a7c8cc944c49ba2358615465219f inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Does this database have any positional information? <br /></td></tr>
<tr class="separator:ada86a7c8cc944c49ba2358615465219f inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afeafd91c34a7465a7fe18a7078e24e1d inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd64f4505639e163a6e6d17e235770a0 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf8de9d7fe351a347e7fa9af605a71bb inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which runs across all terms with a given prefix. <a href="classXapian_1_1Database.html#abf8de9d7fe351a347e7fa9af605a71bb">More...</a><br /></td></tr>
<tr class="separator:abf8de9d7fe351a347e7fa9af605a71bb inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7c34007e5cbd3bbcdae6ccb973c28a3 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to allterms_begin(prefix). <br /></td></tr>
<tr class="separator:ad7c34007e5cbd3bbcdae6ccb973c28a3 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcb111f71b7d4b8eee4c50930175072b inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of documents in the database. <br /></td></tr>
<tr class="separator:adcb111f71b7d4b8eee4c50930175072b inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf49691f63b285d575e1f1e44e79ac55 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a389dcaf7377d4562112bc1f8bd7d2dde inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get the average length of the documents in the database. <br /></td></tr>
<tr class="separator:a389dcaf7377d4562112bc1f8bd7d2dde inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d0eca00055e52358d68c98c15395c8c inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad53ea363158a152ade8231c89b625d9f inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Check if a given term exists in the database. <a href="classXapian_1_1Database.html#ad53ea363158a152ade8231c89b625d9f">More...</a><br /></td></tr>
<tr class="separator:ad53ea363158a152ade8231c89b625d9f inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78e85ae6f00d4bdd656906eacffbe2f4 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of occurrences of the given term. <a href="classXapian_1_1Database.html#a78e85ae6f00d4bdd656906eacffbe2f4">More...</a><br /></td></tr>
<tr class="separator:a78e85ae6f00d4bdd656906eacffbe2f4 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae042528f17c284298444706845a70cc0 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Return the frequency of a given value slot. <a href="classXapian_1_1Database.html#ae042528f17c284298444706845a70cc0">More...</a><br /></td></tr>
<tr class="separator:ae042528f17c284298444706845a70cc0 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ecd343f41ed751d60b924b2099603b6 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get a lower bound on the values stored in the given value slot. <a href="classXapian_1_1Database.html#a2ecd343f41ed751d60b924b2099603b6">More...</a><br /></td></tr>
<tr class="separator:a2ecd343f41ed751d60b924b2099603b6 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ded2510f626182edd6da82cfc2f3b3f inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get an upper bound on the values stored in the given value slot. <a href="classXapian_1_1Database.html#a7ded2510f626182edd6da82cfc2f3b3f">More...</a><br /></td></tr>
<tr class="separator:a7ded2510f626182edd6da82cfc2f3b3f inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62b82e621157bca6263d9f85adbaf9a9 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get a lower bound on the length of a document in this DB. <a href="classXapian_1_1Database.html#a62b82e621157bca6263d9f85adbaf9a9">More...</a><br /></td></tr>
<tr class="separator:a62b82e621157bca6263d9f85adbaf9a9 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af650145b2623f6af193af865a85f7114 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a24dbd0b34571455a298426e9c5141b inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1854c98fd180753ddc349b03c98fd638 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a48da9cfbaf125e02335c56822fba94 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6581a9f018585b502b57dbb511d0c87 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get the length of a document. <br /></td></tr>
<tr class="separator:aa6581a9f018585b502b57dbb511d0c87 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afff524ea098c959644cf209b62c698e3 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of unique terms in document. <br /></td></tr>
<tr class="separator:afff524ea098c959644cf209b62c698e3 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a759d1fde0d3d8a2ed74b83c0ebd10974 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Send a "keep-alive" to remote databases to stop them timing out. <a href="classXapian_1_1Database.html#a759d1fde0d3d8a2ed74b83c0ebd10974">More...</a><br /></td></tr>
<tr class="separator:a759d1fde0d3d8a2ed74b83c0ebd10974 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1538016d90d8afc5fea870cd1d3a8bc inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get a document from the database, given its document id. <a href="classXapian_1_1Database.html#ab1538016d90d8afc5fea870cd1d3a8bc">More...</a><br /></td></tr>
<tr class="separator:ab1538016d90d8afc5fea870cd1d3a8bc inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a478d9e6ccef471bcb661eaf03ddfa2f7 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get a document from the database, given its document id. <a href="classXapian_1_1Database.html#a478d9e6ccef471bcb661eaf03ddfa2f7">More...</a><br /></td></tr>
<tr class="separator:a478d9e6ccef471bcb661eaf03ddfa2f7 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3575c96a597a5555e474360d91b7622b inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Suggest a spelling correction. <a href="classXapian_1_1Database.html#a3575c96a597a5555e474360d91b7622b">More...</a><br /></td></tr>
<tr class="separator:a3575c96a597a5555e474360d91b7622b inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1b78757307bb9dfea21fcde470dd71f inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all the spelling correction targets. <a href="classXapian_1_1Database.html#ae1b78757307bb9dfea21fcde470dd71f">More...</a><br /></td></tr>
<tr class="separator:ae1b78757307bb9dfea21fcde470dd71f inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39766ee84173bcb5ad13b5a9d058c974 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5726d4c4709159738cb41ce82c17e386 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all the synonyms for a given term. <a href="classXapian_1_1Database.html#a5726d4c4709159738cb41ce82c17e386">More...</a><br /></td></tr>
<tr class="separator:a5726d4c4709159738cb41ce82c17e386 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11f9a24f53a9cb72912d1922513584f8 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to synonyms_begin(term). <br /></td></tr>
<tr class="separator:a11f9a24f53a9cb72912d1922513584f8 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2c8a0b43ef247f4a13cf9775fe0b921 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all terms which have synonyms. <a href="classXapian_1_1Database.html#aa2c8a0b43ef247f4a13cf9775fe0b921">More...</a><br /></td></tr>
<tr class="separator:aa2c8a0b43ef247f4a13cf9775fe0b921 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9b7fd27b2daf02d065551455ec6dd1b8 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Corresponding end iterator to synonym_keys_begin(prefix). <br /></td></tr>
<tr class="separator:a9b7fd27b2daf02d065551455ec6dd1b8 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf085567f558ce1af23ba5edbb5caa60 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get the user-specified metadata associated with a given key. <a href="classXapian_1_1Database.html#aaf085567f558ce1af23ba5edbb5caa60">More...</a><br /></td></tr>
<tr class="separator:aaf085567f558ce1af23ba5edbb5caa60 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7fe9d6cd94b568e2b5cd218b12ac851c inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">An iterator which returns all user-specified metadata keys. <a href="classXapian_1_1Database.html#a7fe9d6cd94b568e2b5cd218b12ac851c">More...</a><br /></td></tr>
<tr class="separator:a7fe9d6cd94b568e2b5cd218b12ac851c inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5879feb560d5e84014bd30b9b435dbaf inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2478b32ee19736222fe97c75c616a52 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get a UUID for the database. <a href="classXapian_1_1Database.html#ac2478b32ee19736222fe97c75c616a52">More...</a><br /></td></tr>
<tr class="separator:ac2478b32ee19736222fe97c75c616a52 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6ca06bf1db93879c801e51f6be538eb7 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Test if this database is currently locked for writing. <a href="classXapian_1_1Database.html#a6ca06bf1db93879c801e51f6be538eb7">More...</a><br /></td></tr>
<tr class="separator:a6ca06bf1db93879c801e51f6be538eb7 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a183a715a301f904ff7b023c1b596752e inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Get the revision of the database. <a href="classXapian_1_1Database.html#a183a715a301f904ff7b023c1b596752e">More...</a><br /></td></tr>
<tr class="separator:a183a715a301f904ff7b023c1b596752e inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02be817100f1269681a55e6f45b74d4e inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="classXapian_1_1Database.html#a02be817100f1269681a55e6f45b74d4e">More...</a><br /></td></tr>
<tr class="separator:a02be817100f1269681a55e6f45b74d4e inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdac190fd002c846642beb733aeb850d inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="classXapian_1_1Database.html#abdac190fd002c846642beb733aeb850d">More...</a><br /></td></tr>
<tr class="separator:abdac190fd002c846642beb733aeb850d inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b7a3c20473a72bf88c5419ae2ae406c inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="classXapian_1_1Database.html#a6b7a3c20473a72bf88c5419ae2ae406c">More...</a><br /></td></tr>
<tr class="separator:a6b7a3c20473a72bf88c5419ae2ae406c inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eed99afad6e0667adb89d7eb76f8a01 inherit pub_methods_classXapian_1_1Database"><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 inherit pub_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Produce a compact version of this database. <a href="classXapian_1_1Database.html#a6eed99afad6e0667adb89d7eb76f8a01">More...</a><br /></td></tr>
<tr class="separator:a6eed99afad6e0667adb89d7eb76f8a01 inherit pub_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classXapian_1_1Database"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classXapian_1_1Database')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classXapian_1_1Database.html">Xapian::Database</a></td></tr>
<tr class="memitem:ad730857c480fbff99c2ee5a462c20643 inherit pub_static_methods_classXapian_1_1Database"><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 inherit pub_static_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Check the integrity of a database or database table. <a href="classXapian_1_1Database.html#ad730857c480fbff99c2ee5a462c20643">More...</a><br /></td></tr>
<tr class="separator:ad730857c480fbff99c2ee5a462c20643 inherit pub_static_methods_classXapian_1_1Database"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a074aeccd1b455f158b0f020898ec9811 inherit pub_static_methods_classXapian_1_1Database"><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 inherit pub_static_methods_classXapian_1_1Database"><td class="mdescLeft"> </td><td class="mdescRight">Check the integrity of a single file database. <a href="classXapian_1_1Database.html#a074aeccd1b455f158b0f020898ec9811">More...</a><br /></td></tr>
<tr class="separator:a074aeccd1b455f158b0f020898ec9811 inherit pub_static_methods_classXapian_1_1Database"><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 provides read/write access to a database. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a98ae55d72630237f346986b60e765e36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98ae55d72630237f346986b60e765e36">◆ </a></span>~WritableDatabase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Xapian::WritableDatabase::~WritableDatabase </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 no other handles to this database remain, the database will be closed.</p>
<p>If a transaction is active <a class="el" href="classXapian_1_1WritableDatabase.html#a537b50dd4aad61020ea8536e93559a72" title="Abort the transaction currently in progress, discarding the pending modifications made to the databas...">cancel_transaction()</a> will be implicitly called; if no transaction is active <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> will be implicitly called, but any exception will be swallowed (because throwing exceptions in C++ destructors is problematic). If you aren't using transactions and want to know about any failure to commit changes, call <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> explicitly before the destructor gets called. </p>
</div>
</div>
<a id="ac80ed31814feebd10c6222386e31472e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac80ed31814feebd10c6222386e31472e">◆ </a></span>WritableDatabase() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::WritableDatabase::WritableDatabase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a> with no subdatabases. </p>
<p>The created object isn't very useful in this state - it's intended as a placeholder value. </p>
</div>
</div>
<a id="acac2d0fa337933e0ed66c7dce2ce75d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acac2d0fa337933e0ed66c7dce2ce75d0">◆ </a></span>WritableDatabase() <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::WritableDatabase::WritableDatabase </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 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">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a database for update, automatically determining the database backend to use. </p>
<p>If the database is to be created, <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> will try to create the directory indicated by path if it doesn't already exist (but only the leaf directory, not recursively).</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>one of:<ul>
<li><a class="el" href="namespaceXapian.html#a3d32111900603ce02b8c8467b9c5bacb" title="Create database if it doesn't already exist. ">Xapian::DB_CREATE_OR_OPEN</a> open for read/write; create if no db exists (the default if flags isn't specified)</li>
<li><a class="el" href="namespaceXapian.html#a1236aaa6a3d7a37a4c6b95439e449f7a" title="Create a new database. ">Xapian::DB_CREATE</a> create new database; fail if db exists</li>
<li><a class="el" href="namespaceXapian.html#afbc13e6712a12dcfd0c048242fc313ed" title="Create database if it doesn't already exist, or overwrite if it does. ">Xapian::DB_CREATE_OR_OVERWRITE</a> overwrite existing db; create if none exists</li>
<li><a class="el" href="namespaceXapian.html#a54521467b649894bdc411f4c35e56ac3" title="Open an existing database. ">Xapian::DB_OPEN</a> open for read/write; fail if no db exists</li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p>Additionally, the following flags can be combined with action using bitwise-or (| in C++):</p>
<ul>
<li><a class="el" href="namespaceXapian.html#a8ca4c16174bc054986662c5b56f28374" title="Don't attempt to ensure changes have hit disk. ">Xapian::DB_NO_SYNC</a> don't call fsync() or similar</li>
<li><a class="el" href="namespaceXapian.html#afff6e2208f3d724637eff3ca442190b6" title="Update the database in-place. ">Xapian::DB_DANGEROUS</a> don't be crash-safe, no concurrent readers</li>
<li><a class="el" href="namespaceXapian.html#a296fe000d6d9525bb8e80f72838026a6" title="If the database is already locked, retry the lock. ">Xapian::DB_RETRY_LOCK</a> to wait to get a write lock</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">block_size</td><td>If a new database is created, this specifies the block size (in bytes) for backends which have such a concept. For chert and 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>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseLockError.html" title="DatabaseLockError indicates failure to lock a database. ">Xapian::DatabaseLockError</a></td><td>will be thrown if a lock couldn't be acquired on the database. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1529742b3f7eb92f07e75f2308bc2f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1529742b3f7eb92f07e75f2308bc2f3a">◆ </a></span>WritableDatabase() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Xapian::WritableDatabase::WritableDatabase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</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="aecdd2e1d3a0364c4933ef4fe655f080b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecdd2e1d3a0364c4933ef4fe655f080b">◆ </a></span>add_document()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> Xapian::WritableDatabase::add_document </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td>
<td class="paramname"><em>document</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new document to the database. </p>
<p>This method adds the specified document to the database, returning a newly allocated document ID. Automatically allocated document IDs come from a per-database monotonically increasing counter, so IDs from deleted documents won't be reused.</p>
<p>If you want to specify the document ID to be used, you should call <a class="el" href="classXapian_1_1WritableDatabase.html#a23344c9000ea98b15d491fa875bd5d1e" title="Replace a given document in the database. ">replace_document()</a> instead.</p>
<p>Note that changes to the database won't be immediately committed to disk; see <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> for more details.</p>
<p>As with all database modification operations, the effect is atomic: the document will either be fully added, or the document fails to be added and an exception is thrown (possibly at a later time when <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> is called or the database is closed).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">document</td><td>The new document to be added.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The document ID of the newly added document.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while writing to the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad9d3ed0413b6b62ad2e70785c15bb37f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9d3ed0413b6b62ad2e70785c15bb37f">◆ </a></span>add_spelling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::add_spelling </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"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>freqinc</em> = <code>1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a word to the spelling dictionary. </p>
<p>If the word is already present, its frequency is increased.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>The word to add. </td></tr>
<tr><td class="paramname">freqinc</td><td>How much to increase its frequency by (default 1). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="af7dc1c07b3a68b8dd6a63cc52732fd3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7dc1c07b3a68b8dd6a63cc52732fd3c">◆ </a></span>add_synonym()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::add_synonym </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>synonym</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a synonym for a term. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to add a synonym for. </td></tr>
<tr><td class="paramname">synonym</td><td>The synonym to add. If this is already a synonym for <em>term</em>, then no action is taken. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1436584192e592cead34ea6a4d5af56f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1436584192e592cead34ea6a4d5af56f">◆ </a></span>begin_transaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::begin_transaction </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>flushed</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Begin a transaction. </p>
<p>In <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> a transaction is a group of modifications to the database which are linked such that either all will be applied simultaneously or none will be applied at all. Even in the case of a power failure, this characteristic should be preserved (as long as the filesystem isn't corrupted, etc).</p>
<p>A transaction is started with <a class="el" href="classXapian_1_1WritableDatabase.html#a1436584192e592cead34ea6a4d5af56f" title="Begin a transaction. ">begin_transaction()</a> and can either be committed by calling <a class="el" href="classXapian_1_1WritableDatabase.html#a3d330f3a27cc17d78635781c7b77280f" title="Complete the transaction currently in progress. ">commit_transaction()</a> or aborted by calling <a class="el" href="classXapian_1_1WritableDatabase.html#a537b50dd4aad61020ea8536e93559a72" title="Abort the transaction currently in progress, discarding the pending modifications made to the databas...">cancel_transaction()</a>.</p>
<p>By default, a transaction implicitly calls <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> before and after so that the modifications stand and fall without affecting modifications before or after.</p>
<p>The downside of these implicit calls to <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> is that small transactions can harm indexing performance in the same way that explicitly calling <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> frequently can.</p>
<p>If you're applying atomic groups of changes and only wish to ensure that each group is either applied or not applied, then you can prevent the automatic <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> before and after the transaction by starting the transaction with begin_transaction(false). However, if cancel_transaction is called (or if commit_transaction isn't called before the <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a> object is destroyed) then any changes which were pending before the transaction began will also be discarded.</p>
<p>Transactions aren't currently supported by the <a class="el" href="namespaceXapian_1_1InMemory.html" title="Database factory functions for the inmemory backend. ">InMemory</a> backend.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flushed</td><td>Is this a flushed transaction? By default transactions are "flushed", which means that committing a transaction will ensure those changes are permanently written to the database. By contrast, unflushed transactions only ensure that changes within the transaction are either all applied or all aren't.</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 transactions are not available for this database type.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way. ">Xapian::InvalidOperationError</a></td><td>will be thrown if this is called at an invalid time, such as when a transaction is already in progress. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a537b50dd4aad61020ea8536e93559a72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a537b50dd4aad61020ea8536e93559a72">◆ </a></span>cancel_transaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::cancel_transaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Abort the transaction currently in progress, discarding the pending modifications made to the database. </p>
<p>If an error occurs in this method, an exception will be thrown, but the transaction will be cancelled anyway.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while modifying the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way. ">Xapian::InvalidOperationError</a></td><td>will be thrown if a transaction is not currently in progress.</td></tr>
<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 transactions are not available for this database type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a18d335a3efe7467a8668acc862b58d08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18d335a3efe7467a8668acc862b58d08">◆ </a></span>clear_synonyms()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::clear_synonyms </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>Remove all synonyms for a term. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to remove all synonyms for. If the term has no synonyms, no action is taken. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acbea2163142de795024880a7123bc693"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbea2163142de795024880a7123bc693">◆ </a></span>commit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::commit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commit any pending modifications made to the database. </p>
<p>For efficiency reasons, when performing multiple updates to a database it is best (indeed, almost essential) to make as many modifications as memory will permit in a single pass through the database. To ensure this, <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> batches up modifications.</p>
<p>This method may be called at any time to commit any pending modifications to the database.</p>
<p>If any of the modifications fail, an exception will be thrown and the database will be left in a state in which each separate addition, replacement or deletion operation has either been fully performed or not performed at all: it is then up to the application to work out which operations need to be repeated.</p>
<p>It's not valid to call <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> within a transaction.</p>
<p>Beware of calling <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> too frequently: this will make indexing take much longer.</p>
<p>Note that <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> need not be called explicitly: it will be called automatically when the database is closed, or when a sufficient number of modifications have been made. By default, this is every 10000 documents added, deleted, or modified. This value is rather conservative, and if you have a machine with plenty of memory, you can improve indexing throughput dramatically by setting XAPIAN_FLUSH_THRESHOLD in the environment to a larger value.</p>
<p>This method was new in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> 1.1.0 - in earlier versions it was called <a class="el" href="classXapian_1_1WritableDatabase.html#ae767fd6fec96a126763f818fdc0abca7" title="Pre-1.1.0 name for commit(). ">flush()</a>.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while modifying the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3d330f3a27cc17d78635781c7b77280f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d330f3a27cc17d78635781c7b77280f">◆ </a></span>commit_transaction()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::commit_transaction </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Complete the transaction currently in progress. </p>
<p>If this method completes successfully and this is a flushed transaction, all the database modifications made during the transaction will have been committed to the database.</p>
<p>If an error occurs, an exception will be thrown, and none of the modifications made to the database during the transaction will have been applied to the database.</p>
<p>In all cases the transaction will no longer be in progress.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while modifying the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1InvalidOperationError.html" title="InvalidOperationError indicates the API was used in an invalid way. ">Xapian::InvalidOperationError</a></td><td>will be thrown if a transaction is not currently in progress.</td></tr>
<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 transactions are not available for this database type. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0cfd78ba9108b9ef2cf9b4a9f545c70d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cfd78ba9108b9ef2cf9b4a9f545c70d">◆ </a></span>delete_document() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::delete_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></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete a document from the database. </p>
<p>This method removes the document with the specified document ID from the database.</p>
<p>Note that changes to the database won't be immediately committed to disk; see <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> for more details.</p>
<p>As with all database modification operations, the effect is atomic: the document will either be fully removed, or the document fails to be removed and an exception is thrown (possibly at a later time when <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> is called or the database is closed).</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 be removed.</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_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while writing to the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8426619892e77112e832fc4b11b8efc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8426619892e77112e832fc4b11b8efc3">◆ </a></span>delete_document() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::delete_document </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>unique_term</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete any documents indexed by a term from the database. </p>
<p>This method removes any documents indexed by the specified term from the database.</p>
<p>A major use is for convenience when UIDs from another system are mapped to terms in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a>, although this method has other uses (for example, you could add a "deletion date" term to documents at index time and use this method to delete all documents due for deletion on a particular date).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">unique_term</td><td>The term to remove references to.</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_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while writing to the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae767fd6fec96a126763f818fdc0abca7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae767fd6fec96a126763f818fdc0abca7">◆ </a></span>flush()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::flush </td>
<td>(</td>
<td class="paramname"></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>Pre-1.1.0 name for <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a>. </p>
<p>Use <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> instead. </p>
</div>
</div>
<a id="ac97254827cb74c93606ae046dcdd3754"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac97254827cb74c93606ae046dcdd3754">◆ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</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>
<p>Note that only an <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a> may be assigned to an <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database. ">WritableDatabase</a>: an attempt to assign 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> is caught at compile-time.</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="a4a1999a20b879badb29d02acd4972600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a1999a20b879badb29d02acd4972600">◆ </a></span>remove_spelling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::remove_spelling </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"><a class="el" href="namespaceXapian.html#a4464380f6fa0055b5f26b8d03ae170e2">Xapian::termcount</a> </td>
<td class="paramname"><em>freqdec</em> = <code>1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a word from the spelling dictionary. </p>
<p>The word's frequency is decreased, and if would become zero or less then the word is removed completely.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">word</td><td>The word to remove. </td></tr>
<tr><td class="paramname">freqdec</td><td>How much to decrease its frequency by (default 1). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a18b9115c6b759f62b6b6f2e8c1e10efa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18b9115c6b759f62b6b6f2e8c1e10efa">◆ </a></span>remove_synonym()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::remove_synonym </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>synonym</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a synonym for a term. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to remove a synonym for. </td></tr>
<tr><td class="paramname">synonym</td><td>The synonym to remove. If this isn't currently a synonym for <em>term</em>, then no action is taken. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a23344c9000ea98b15d491fa875bd5d1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23344c9000ea98b15d491fa875bd5d1e">◆ </a></span>replace_document() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::replace_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">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td>
<td class="paramname"><em>document</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Replace a given document in the database. </p>
<p>This method replaces the document with the specified document ID. If document ID <em>did</em> isn't currently used, the document will be added with document ID <em>did</em>.</p>
<p>The monotonic counter used for automatically allocating document IDs is increased so that the next automatically allocated document ID will be did + 1. Be aware that if you use this method to specify a high document ID for a new document, and also use <a class="el" href="classXapian_1_1WritableDatabase.html#aecdd2e1d3a0364c4933ef4fe655f080b" title="Add a new document to the database. ">WritableDatabase::add_document()</a>, <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a> may get to a state where this counter wraps around and will be unable to automatically allocate document IDs!</p>
<p>Note that changes to the database won't be immediately committed to disk; see <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> for more details.</p>
<p>As with all database modification operations, the effect is atomic: the document will either be fully replaced, or the document fails to be replaced and an exception is thrown (possibly at a later time when <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> is called or the database is closed).</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 be replaced. </td></tr>
<tr><td class="paramname">document</td><td>The new document.</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_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while writing to the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a43c4630ec482508667e9ca539f19cbf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43c4630ec482508667e9ca539f19cbf0">◆ </a></span>replace_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="namespaceXapian.html#ad8f7a78bc920532b7d2baa3281b33e2f">Xapian::docid</a> Xapian::WritableDatabase::replace_document </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>unique_term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXapian_1_1Document.html">Xapian::Document</a> & </td>
<td class="paramname"><em>document</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Replace any documents matching a term. </p>
<p>This method replaces any documents indexed by the specified term with the specified document. If any documents are indexed by the term, the lowest document ID will be used for the document, otherwise a new document ID will be generated as for add_document.</p>
<p>One common use is to allow UIDs from another system to easily be mapped to terms in <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library. ">Xapian</a>. Note that this method doesn't automatically add unique_term as a term, so you'll need to call document.add_term(unique_term) first when using <a class="el" href="classXapian_1_1WritableDatabase.html#a23344c9000ea98b15d491fa875bd5d1e" title="Replace a given document in the database. ">replace_document()</a> in this way.</p>
<p>Note that changes to the database won't be immediately committed to disk; see <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> for more details.</p>
<p>As with all database modification operations, the effect is atomic: the document(s) will either be fully replaced, or the document(s) fail to be replaced and an exception is thrown (possibly at a later time when <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> is called or the database is closed).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">unique_term</td><td>The "unique" term. </td></tr>
<tr><td class="paramname">document</td><td>The new document.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The document ID that document was given.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while writing to the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="abd9a9fde5be5614e93559810df865a98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd9a9fde5be5614e93559810df865a98">◆ </a></span>set_metadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Xapian::WritableDatabase::set_metadata </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the user-specified metadata associated with a given key. </p>
<p>This method sets the metadata value associated with a given key. If there is already a metadata value stored in the database with the same key, the old value is replaced. If you want to delete an existing item of metadata, just set its value to the empty string.</p>
<p>User-specified metadata allows you to store arbitrary information in the form of (key,tag) pairs.</p>
<p>There's no hard limit on the number of metadata items, or the size of the metadata values. Metadata keys have a limited length, which depends on the backend. We recommend limiting them to 200 bytes. Empty keys are not valid, and specifying one will cause an exception.</p>
<p>Metadata modifications are committed to disk in the same way as modifications to the documents in the database are: i.e., modifications are atomic, and won't be committed to disk immediately (see <a class="el" href="classXapian_1_1WritableDatabase.html#acbea2163142de795024880a7123bc693" title="Commit any pending modifications made to the database. ">commit()</a> for more details). This allows metadata to be used to link databases with versioned external resources by storing the appropriate version number in a metadata item.</p>
<p>You can also use the metadata to store arbitrary extra information associated with terms, documents, or postings by encoding the termname and/or document id into the metadata key.</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 set.</td></tr>
<tr><td class="paramname">value</td><td>The value of the metadata item to set.</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_1DatabaseError.html" title="DatabaseError indicates some sort of database related error. ">Xapian::DatabaseError</a></td><td>will be thrown if a problem occurs while writing to the database.</td></tr>
<tr><td class="paramname"><a class="el" href="classXapian_1_1DatabaseCorruptError.html" title="DatabaseCorruptError indicates database corruption was detected. ">Xapian::DatabaseCorruptError</a></td><td>will be thrown if the database is in a corrupt state.</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>will be thrown if the key supplied is empty.</td></tr>
<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 database backend in use doesn't support user-specified metadata. </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>
|
