-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathclasscom_1_1wiredtiger_1_1db_1_1_session.html
1505 lines (1458 loc) · 127 KB
/
classcom_1_1wiredtiger_1_1db_1_1_session.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>WiredTiger: com.wiredtiger.db.Session Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="wiredtiger.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a href="http://wiredtiger.com/"><img alt="Logo" src="LogoFinal-header.png" alt="WiredTiger" /></a></td>
<td style="padding-left: 0.5em;">
<div id="projectname">
 <span id="projectnumber">Version 2.8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="banner">
<a href="https://github.com/wiredtiger/wiredtiger">Fork me on GitHub</a>
<a class="last" href="http://groups.google.com/group/wiredtiger-users">Join my user group</a>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li><a href="community.html"><span>Community</span></a></li>
<li><a href="license.html"><span>License</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classcom_1_1wiredtiger_1_1db_1_1_session.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="classcom_1_1wiredtiger_1_1db_1_1_session-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">com.wiredtiger.db.Session Class Reference<div class="ingroups"><a class="el" href="group__wt__java.html">WiredTiger Java API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>All data operations are performed in the context of a <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html" title="All data operations are performed in the context of a WT_SESSION. ">WT_SESSION</a>.
<a href="classcom_1_1wiredtiger_1_1db_1_1_session.html#details">More...</a></p>
<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:abd928363a1ed03e95e27c287efaa6363"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd928363a1ed03e95e27c287efaa6363"></a>
synchronized void </td><td class="memItemRight" valign="bottom"><b>delete</b> ()</td></tr>
<tr class="separator:abd928363a1ed03e95e27c287efaa6363"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f267cf49f92a76b4bad57015a05ba88"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f267cf49f92a76b4bad57015a05ba88"></a>
<a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_connection.html">Connection</a> </td><td class="memItemRight" valign="bottom"><b>getConnection</b> ()</td></tr>
<tr class="separator:a2f267cf49f92a76b4bad57015a05ba88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a575d56d4413369b3db49bfeac3ff4caa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a575d56d4413369b3db49bfeac3ff4caa">close</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a575d56d4413369b3db49bfeac3ff4caa"><td class="mdescLeft"> </td><td class="mdescRight">Close the session handle. <a href="#a575d56d4413369b3db49bfeac3ff4caa">More...</a><br /></td></tr>
<tr class="separator:a575d56d4413369b3db49bfeac3ff4caa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab26e9fa8589c722544049adae0e70ad9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#ab26e9fa8589c722544049adae0e70ad9">reconfigure</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:ab26e9fa8589c722544049adae0e70ad9"><td class="mdescLeft"> </td><td class="mdescRight">Reconfigure a session handle. <a href="#ab26e9fa8589c722544049adae0e70ad9">More...</a><br /></td></tr>
<tr class="separator:ab26e9fa8589c722544049adae0e70ad9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d3664f22568a5b36bece98592cb6ea4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d3664f22568a5b36bece98592cb6ea4"></a>
String </td><td class="memItemRight" valign="bottom"><b>strerror</b> (int error) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="separator:a0d3664f22568a5b36bece98592cb6ea4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9af2da9814436f1fc35a45584ae5ac7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#af9af2da9814436f1fc35a45584ae5ac7">create</a> (String name, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:af9af2da9814436f1fc35a45584ae5ac7"><td class="mdescLeft"> </td><td class="mdescRight">Create a table, column group, index or file. <a href="#af9af2da9814436f1fc35a45584ae5ac7">More...</a><br /></td></tr>
<tr class="separator:af9af2da9814436f1fc35a45584ae5ac7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e9a2527158abf55b92f9994441a97d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a3e9a2527158abf55b92f9994441a97d6">compact</a> (String name, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a3e9a2527158abf55b92f9994441a97d6"><td class="mdescLeft"> </td><td class="mdescRight">Compact a live row- or column-store btree or LSM tree. <a href="#a3e9a2527158abf55b92f9994441a97d6">More...</a><br /></td></tr>
<tr class="separator:a3e9a2527158abf55b92f9994441a97d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08aa0622c56a5839b7c38f420b1f2a85"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a08aa0622c56a5839b7c38f420b1f2a85">drop</a> (String name, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a08aa0622c56a5839b7c38f420b1f2a85"><td class="mdescLeft"> </td><td class="mdescRight">Drop (delete) an object. <a href="#a08aa0622c56a5839b7c38f420b1f2a85">More...</a><br /></td></tr>
<tr class="separator:a08aa0622c56a5839b7c38f420b1f2a85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75ec87d13d61c38312f6097e86470b22"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a75ec87d13d61c38312f6097e86470b22">join</a> (<a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> join_cursor, <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> ref_cursor, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a75ec87d13d61c38312f6097e86470b22"><td class="mdescLeft"> </td><td class="mdescRight">Join a join cursor with a reference cursor. <a href="#a75ec87d13d61c38312f6097e86470b22">More...</a><br /></td></tr>
<tr class="separator:a75ec87d13d61c38312f6097e86470b22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8790893082bc6ca34ca288008971944"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#ac8790893082bc6ca34ca288008971944">log_flush</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:ac8790893082bc6ca34ca288008971944"><td class="mdescLeft"> </td><td class="mdescRight">Flush the log. <a href="#ac8790893082bc6ca34ca288008971944">More...</a><br /></td></tr>
<tr class="separator:ac8790893082bc6ca34ca288008971944"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a094ae49ac5f0533817961284c89b8327"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a094ae49ac5f0533817961284c89b8327">log_printf</a> (String fmt) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a094ae49ac5f0533817961284c89b8327"><td class="mdescLeft"> </td><td class="mdescRight">Insert a <a class="el" href="group__wt.html#ga8cf04a003979e7852209079d4093d783" title="message ">WT_LOGREC_MESSAGE</a> type record in the database log files (the database must be configured for logging when this method is called). <a href="#a094ae49ac5f0533817961284c89b8327">More...</a><br /></td></tr>
<tr class="separator:a094ae49ac5f0533817961284c89b8327"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8e72b903d72a3ca1f1a0dd019c186d7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#ae8e72b903d72a3ca1f1a0dd019c186d7">rebalance</a> (String uri, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:ae8e72b903d72a3ca1f1a0dd019c186d7"><td class="mdescLeft"> </td><td class="mdescRight">Rebalance a table, see <a class="el" href="rebalance.html">Rebalance</a>. <a href="#ae8e72b903d72a3ca1f1a0dd019c186d7">More...</a><br /></td></tr>
<tr class="separator:ae8e72b903d72a3ca1f1a0dd019c186d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2acb7e037b0d4bf9c8d812d264376465"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a2acb7e037b0d4bf9c8d812d264376465">rename</a> (String uri, String newuri, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a2acb7e037b0d4bf9c8d812d264376465"><td class="mdescLeft"> </td><td class="mdescRight">Rename an object. <a href="#a2acb7e037b0d4bf9c8d812d264376465">More...</a><br /></td></tr>
<tr class="separator:a2acb7e037b0d4bf9c8d812d264376465"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ce840af5f1ffff040dd097a2a3065e4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a2ce840af5f1ffff040dd097a2a3065e4">reset</a> () throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a2ce840af5f1ffff040dd097a2a3065e4"><td class="mdescLeft"> </td><td class="mdescRight">Reset the session handle. <a href="#a2ce840af5f1ffff040dd097a2a3065e4">More...</a><br /></td></tr>
<tr class="separator:a2ce840af5f1ffff040dd097a2a3065e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4687837f13f03699d9c295fdd4380398"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a4687837f13f03699d9c295fdd4380398">salvage</a> (String name, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a4687837f13f03699d9c295fdd4380398"><td class="mdescLeft"> </td><td class="mdescRight">Salvage a file or table. <a href="#a4687837f13f03699d9c295fdd4380398">More...</a><br /></td></tr>
<tr class="separator:a4687837f13f03699d9c295fdd4380398"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c58845dfd2f75cc3935185c12d29329"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a2c58845dfd2f75cc3935185c12d29329">truncate</a> (String name, <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> start, <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> stop, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a2c58845dfd2f75cc3935185c12d29329"><td class="mdescLeft"> </td><td class="mdescRight">Truncate a file, table or cursor range. <a href="#a2c58845dfd2f75cc3935185c12d29329">More...</a><br /></td></tr>
<tr class="separator:a2c58845dfd2f75cc3935185c12d29329"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac01e39f9556abb815f3b9c611d3b9cb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#aac01e39f9556abb815f3b9c611d3b9cb">upgrade</a> (String name, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:aac01e39f9556abb815f3b9c611d3b9cb"><td class="mdescLeft"> </td><td class="mdescRight">Upgrade a file or table. <a href="#aac01e39f9556abb815f3b9c611d3b9cb">More...</a><br /></td></tr>
<tr class="separator:aac01e39f9556abb815f3b9c611d3b9cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afdf398c1081c2a7232e90ab3cfb3eb98"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#afdf398c1081c2a7232e90ab3cfb3eb98">verify</a> (String name, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:afdf398c1081c2a7232e90ab3cfb3eb98"><td class="mdescLeft"> </td><td class="mdescRight">Verify a file or table. <a href="#afdf398c1081c2a7232e90ab3cfb3eb98">More...</a><br /></td></tr>
<tr class="separator:afdf398c1081c2a7232e90ab3cfb3eb98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abda8ddc193622bedbe6fba26e061405a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#abda8ddc193622bedbe6fba26e061405a">begin_transaction</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:abda8ddc193622bedbe6fba26e061405a"><td class="mdescLeft"> </td><td class="mdescRight">Start a transaction in this session. <a href="#abda8ddc193622bedbe6fba26e061405a">More...</a><br /></td></tr>
<tr class="separator:abda8ddc193622bedbe6fba26e061405a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a707380a753afffb89b3195c16938ce8f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a707380a753afffb89b3195c16938ce8f">commit_transaction</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a707380a753afffb89b3195c16938ce8f"><td class="mdescLeft"> </td><td class="mdescRight">Commit the current transaction. <a href="#a707380a753afffb89b3195c16938ce8f">More...</a><br /></td></tr>
<tr class="separator:a707380a753afffb89b3195c16938ce8f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46ce42cc35d30590975054b12f8e2013"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a46ce42cc35d30590975054b12f8e2013">rollback_transaction</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a46ce42cc35d30590975054b12f8e2013"><td class="mdescLeft"> </td><td class="mdescRight">Roll back the current transaction. <a href="#a46ce42cc35d30590975054b12f8e2013">More...</a><br /></td></tr>
<tr class="separator:a46ce42cc35d30590975054b12f8e2013"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8a3a848702a49b9c3cb8e1ed1c1afd3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#ae8a3a848702a49b9c3cb8e1ed1c1afd3">checkpoint</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:ae8a3a848702a49b9c3cb8e1ed1c1afd3"><td class="mdescLeft"> </td><td class="mdescRight">Write a transactionally consistent snapshot of a database or set of objects. <a href="#ae8a3a848702a49b9c3cb8e1ed1c1afd3">More...</a><br /></td></tr>
<tr class="separator:ae8a3a848702a49b9c3cb8e1ed1c1afd3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9c59ebe27793654d9a6206f28344809"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#aa9c59ebe27793654d9a6206f28344809">snapshot</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:aa9c59ebe27793654d9a6206f28344809"><td class="mdescLeft"> </td><td class="mdescRight">Manage named snapshot transactions. <a href="#aa9c59ebe27793654d9a6206f28344809">More...</a><br /></td></tr>
<tr class="separator:aa9c59ebe27793654d9a6206f28344809"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65ecc08c6b9d27bb108dd5bdac93b8a3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#a65ecc08c6b9d27bb108dd5bdac93b8a3">transaction_sync</a> (String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:a65ecc08c6b9d27bb108dd5bdac93b8a3"><td class="mdescLeft"> </td><td class="mdescRight">Wait for a transaction to become synchronized. <a href="#a65ecc08c6b9d27bb108dd5bdac93b8a3">More...</a><br /></td></tr>
<tr class="separator:a65ecc08c6b9d27bb108dd5bdac93b8a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc61edbe05447e070a2d0729bd36a084"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#adc61edbe05447e070a2d0729bd36a084">open_cursor</a> (String uri, <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> to_dup, String config) throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:adc61edbe05447e070a2d0729bd36a084"><td class="mdescLeft"> </td><td class="mdescRight">Open a new cursor on a data source or duplicate an existing cursor. <a href="#adc61edbe05447e070a2d0729bd36a084">More...</a><br /></td></tr>
<tr class="separator:adc61edbe05447e070a2d0729bd36a084"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aed31a501ee163947de5a82f2b31b03b9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#aed31a501ee163947de5a82f2b31b03b9">transaction_pinned_range</a> () throws com.wiredtiger.db.WiredTigerException </td></tr>
<tr class="memdesc:aed31a501ee163947de5a82f2b31b03b9"><td class="mdescLeft"> </td><td class="mdescRight">Return the transaction ID range pinned by the session handle. <a href="#aed31a501ee163947de5a82f2b31b03b9">More...</a><br /></td></tr>
<tr class="separator:aed31a501ee163947de5a82f2b31b03b9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a76afc8fe00e0b542b8424fd8b8fb5b84"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76afc8fe00e0b542b8424fd8b8fb5b84"></a>
 </td><td class="memItemRight" valign="bottom"><b>Session</b> (long cPtr, boolean cMemoryOwn)</td></tr>
<tr class="separator:a76afc8fe00e0b542b8424fd8b8fb5b84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06bf69bf9e0ec46cbe72ec014b32360d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06bf69bf9e0ec46cbe72ec014b32360d"></a>
int </td><td class="memItemRight" valign="bottom"><b>java_init</b> (Object jsess)</td></tr>
<tr class="separator:a06bf69bf9e0ec46cbe72ec014b32360d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:a2e76ab86a72d5401984d2a28cc61b4ae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e76ab86a72d5401984d2a28cc61b4ae"></a>
static long </td><td class="memItemRight" valign="bottom"><b>getCPtr</b> (<a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_session.html">Session</a> obj)</td></tr>
<tr class="separator:a2e76ab86a72d5401984d2a28cc61b4ae"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a01ea84794bd5958f00eafd98ebb329d3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01ea84794bd5958f00eafd98ebb329d3"></a>
boolean </td><td class="memItemRight" valign="bottom"><b>swigCMemOwn</b></td></tr>
<tr class="separator:a01ea84794bd5958f00eafd98ebb329d3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>All data operations are performed in the context of a <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html" title="All data operations are performed in the context of a WT_SESSION. ">WT_SESSION</a>. </p>
<p>This encapsulates the thread and transactional context of the operation.</p>
<p><b>Thread safety:</b> A <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html" title="All data operations are performed in the context of a WT_SESSION. ">WT_SESSION</a> handle is not usually shared between threads, see <a class="el" href="threads.html">Multithreading</a> for more information. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abda8ddc193622bedbe6fba26e061405a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.begin_transaction </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start a transaction in this session. </p>
<p>The transaction remains active until ended by <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a712226eca5ade5bd123026c624468fa2" title="Commit the current transaction. ">WT_SESSION::commit_transaction</a> or <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#ab45f521464ad9e54d9b15efc2ffe20a1" title="Roll back the current transaction. ">WT_SESSION::rollback_transaction</a>. Operations performed on cursors capable of supporting transactional operations that are already open in this session, or which are opened before the transaction ends, will operate in the context of the transaction.</p>
<p><a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a7e26b16b26b5870498752322fad790bf" title="Start a transaction in this session. ">WT_SESSION::begin_transaction</a> will fail if a transaction is already in progress in the session.</p>
<div class="fragment"><div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Cursors may be opened before or after the transaction begins, and in</span></div>
<div class="line"><span class="comment"> * either case, subsequent operations are included in the transaction.</span></div>
<div class="line"><span class="comment"> * Opening cursors before the transaction begins allows applications to</span></div>
<div class="line"><span class="comment"> * cache cursors and use them for multiple operations.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret =</div>
<div class="line"> session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(session, <span class="stringliteral">"table:mytable"</span>, NULL, NULL, &cursor);</div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a7e26b16b26b5870498752322fad790bf">begin_transaction</a>(session, NULL);</div>
<div class="line"></div>
<div class="line"> cursor->set_key(cursor, <span class="stringliteral">"key"</span>);</div>
<div class="line"> cursor->set_value(cursor, <span class="stringliteral">"value"</span>);</div>
<div class="line"> <span class="keywordflow">switch</span> (ret = cursor->update(cursor)) {</div>
<div class="line"> <span class="keywordflow">case</span> 0: <span class="comment">/* Update success */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a712226eca5ade5bd123026c624468fa2">commit_transaction</a>(session, NULL);</div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * If commit_transaction succeeds, cursors remain positioned; if</span></div>
<div class="line"><span class="comment"> * commit_transaction fails, the transaction was rolled-back and</span></div>
<div class="line"><span class="comment"> * and all cursors are reset.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__wt.html#ga5ee3c6fcd074e11efd118f3e68e91db8">WT_ROLLBACK</a>: <span class="comment">/* Update conflict */</span></div>
<div class="line"> <span class="keywordflow">default</span>: <span class="comment">/* Other error */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#ab45f521464ad9e54d9b15efc2ffe20a1">rollback_transaction</a>(session, NULL);</div>
<div class="line"> <span class="comment">/* The rollback_transaction call resets all cursors. */</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Cursors remain open and may be used for multiple transactions.</span></div>
<div class="line"><span class="comment"> */</span></div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>isolation</code></td><td>the isolation level for this transaction; defaults to the session's isolation level.</td><td>a string, chosen from the following options: <code>"read-uncommitted"</code>, <code>"read-committed"</code>, <code>"snapshot"</code>; default empty. </td></tr>
<tr>
<td><code>name</code></td><td>name of the transaction for tracing and debugging.</td><td>a string; default empty. </td></tr>
<tr>
<td><code>priority</code></td><td>priority of the transaction for resolving conflicts. Transactions with higher values are less likely to abort.</td><td>an integer between -100 and 100; default <code>0</code>. </td></tr>
<tr>
<td><code>snapshot</code></td><td>use a named, in-memory snapshot, see <a class="el" href="transactions.html#transaction_named_snapshots">Named Snapshots</a>.</td><td>a string; default empty. </td></tr>
<tr>
<td><code>sync</code></td><td>whether to sync log records when the transaction commits, inherited from <a class="el" href="group__wt.html#ga9e6adae3fc6964ef837a62795c7840ed" title="Open a connection to a database. ">wiredtiger_open</a> <code>transaction_sync</code>.</td><td>a boolean flag; default empty. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8a3a848702a49b9c3cb8e1ed1c1afd3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.checkpoint </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a transactionally consistent snapshot of a database or set of objects. </p>
<p>The checkpoint includes all transactions committed before the checkpoint starts. Additionally, checkpoints may optionally be discarded.</p>
<div class="fragment"><div class="line"> <span class="comment">/* Checkpoint the database. */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session, NULL);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* Checkpoint of the database, creating a named snapshot. */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session, <span class="stringliteral">"name=June01"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Checkpoint a list of objects.</span></div>
<div class="line"><span class="comment"> * JSON parsing requires quoting the list of target URIs.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = session-></div>
<div class="line"> <a class="code" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#ae8a3a848702a49b9c3cb8e1ed1c1afd3">checkpoint</a>(session, <span class="stringliteral">"target=(\"table:table1\",\"table:table2\")"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Checkpoint a list of objects, creating a named snapshot.</span></div>
<div class="line"><span class="comment"> * JSON parsing requires quoting the list of target URIs.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = session-></div>
<div class="line"> <a class="code" href="classcom_1_1wiredtiger_1_1db_1_1_session.html#ae8a3a848702a49b9c3cb8e1ed1c1afd3">checkpoint</a>(session, <span class="stringliteral">"target=(\"table:mytable\"),name=midnight"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* Checkpoint the database, discarding all previous snapshots. */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session, <span class="stringliteral">"drop=(from=all)"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* Checkpoint the database, discarding the "midnight" snapshot. */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session, <span class="stringliteral">"drop=(midnight)"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Checkpoint the database, discarding all snapshots after and</span></div>
<div class="line"><span class="comment"> * including "noon".</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session, <span class="stringliteral">"drop=(from=noon)"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Checkpoint the database, discarding all snapshots before and</span></div>
<div class="line"><span class="comment"> * including "midnight".</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session, <span class="stringliteral">"drop=(to=midnight)"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Create a checkpoint of a table, creating the "July01" snapshot and</span></div>
<div class="line"><span class="comment"> * discarding the "May01" and "June01" snapshots.</span></div>
<div class="line"><span class="comment"> * JSON parsing requires quoting the list of target URIs.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a6550c9079198955c5071583941c85bbf">checkpoint</a>(session,</div>
<div class="line"> <span class="stringliteral">"target=(\"table:mytable\"),name=July01,drop=(May01,June01)"</span>);</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>drop</code></td><td>specify a list of checkpoints to drop. The list may additionally contain one of the following keys: <code>"from=all"</code> to drop all checkpoints, <code>"from=<checkpoint>"</code> to drop all checkpoints after and including the named checkpoint, or <code>"to=<checkpoint>"</code> to drop all checkpoints before and including the named checkpoint. Checkpoints cannot be dropped while a hot backup is in progress or if open in a cursor.</td><td>a list of strings; default empty. </td></tr>
<tr>
<td><code>force</code></td><td>by default, checkpoints may be skipped if the underlying object has not been modified, this option forces the checkpoint.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>name</code></td><td>if set, specify a name for the checkpoint (note that checkpoints including LSM trees may not be named).</td><td>a string; default empty. </td></tr>
<tr>
<td><code>target</code></td><td>if non-empty, checkpoint the list of objects.</td><td>a list of strings; default empty. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a575d56d4413369b3db49bfeac3ff4caa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.close </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close the session handle. </p>
<p>This will release the resources associated with the session handle, including rolling back any active transactions and closing any cursors that remain open in the session.</p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a96f25dfa6447034aea1f67ab02ab5698">close</a>(session, NULL);</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. No values currently permitted. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a707380a753afffb89b3195c16938ce8f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.commit_transaction </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Commit the current transaction. </p>
<p>A transaction must be in progress when this method is called.</p>
<p>If <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a712226eca5ade5bd123026c624468fa2" title="Commit the current transaction. ">WT_SESSION::commit_transaction</a> returns an error, the transaction was rolled back, not committed.</p>
<div class="fragment"><div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Cursors may be opened before or after the transaction begins, and in</span></div>
<div class="line"><span class="comment"> * either case, subsequent operations are included in the transaction.</span></div>
<div class="line"><span class="comment"> * Opening cursors before the transaction begins allows applications to</span></div>
<div class="line"><span class="comment"> * cache cursors and use them for multiple operations.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> ret =</div>
<div class="line"> session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(session, <span class="stringliteral">"table:mytable"</span>, NULL, NULL, &cursor);</div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a7e26b16b26b5870498752322fad790bf">begin_transaction</a>(session, NULL);</div>
<div class="line"></div>
<div class="line"> cursor->set_key(cursor, <span class="stringliteral">"key"</span>);</div>
<div class="line"> cursor->set_value(cursor, <span class="stringliteral">"value"</span>);</div>
<div class="line"> <span class="keywordflow">switch</span> (ret = cursor->update(cursor)) {</div>
<div class="line"> <span class="keywordflow">case</span> 0: <span class="comment">/* Update success */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a712226eca5ade5bd123026c624468fa2">commit_transaction</a>(session, NULL);</div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * If commit_transaction succeeds, cursors remain positioned; if</span></div>
<div class="line"><span class="comment"> * commit_transaction fails, the transaction was rolled-back and</span></div>
<div class="line"><span class="comment"> * and all cursors are reset.</span></div>
<div class="line"><span class="comment"> */</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> <span class="keywordflow">case</span> <a class="code" href="group__wt.html#ga5ee3c6fcd074e11efd118f3e68e91db8">WT_ROLLBACK</a>: <span class="comment">/* Update conflict */</span></div>
<div class="line"> <span class="keywordflow">default</span>: <span class="comment">/* Other error */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#ab45f521464ad9e54d9b15efc2ffe20a1">rollback_transaction</a>(session, NULL);</div>
<div class="line"> <span class="comment">/* The rollback_transaction call resets all cursors. */</span></div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line"></div>
<div class="line"> <span class="comment">/*</span></div>
<div class="line"><span class="comment"> * Cursors remain open and may be used for multiple transactions.</span></div>
<div class="line"><span class="comment"> */</span></div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>sync</code></td><td>override whether to sync log records when the transaction commits, inherited from <a class="el" href="group__wt.html#ga9e6adae3fc6964ef837a62795c7840ed" title="Open a connection to a database. ">wiredtiger_open</a> <code>transaction_sync</code>. The <code>background</code> setting initiates a background synchronization intended to be used with a later call to <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a61c8c3ad80d8228172db66ca70bd90fd" title="Wait for a transaction to become synchronized. ">WT_SESSION::transaction_sync</a>. The <code>off</code> setting does not wait for record to be written or synchronized. The <code>on</code> setting forces log records to be written to the storage device.</td><td>a string, chosen from the following options: <code>"background"</code>, <code>"off"</code>, <code>"on"</code>; default empty. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a3e9a2527158abf55b92f9994441a97d6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.compact </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compact a live row- or column-store btree or LSM tree. </p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#aafa7a12a4891a5bfdc98673a5b8f9c69">compact</a>(session, <span class="stringliteral">"table:mytable"</span>, NULL);</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">name</td><td>the URI of the object to compact, such as <code>"table:stock"</code> </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>timeout</code></td><td>maximum amount of time to allow for compact in seconds. The actual amount of time spent in compact may exceed the configured value. A value of zero disables the timeout.</td><td>an integer; default <code>1200</code>. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="af9af2da9814436f1fc35a45584ae5ac7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.create </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a table, column group, index or file. </p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb">create</a>(session,</div>
<div class="line"> <span class="stringliteral">"table:mytable"</span>, <span class="stringliteral">"key_format=S,value_format=S"</span>);</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">name</td><td>the URI of the object to create, such as <code>"table:stock"</code>. For a description of URI formats see <a class="el" href="data_sources.html">Data Sources</a>. </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>allocation_size</code></td><td>the file unit allocation size, in bytes, must a power-of-two; smaller values decrease the file space required by overflow items, and the default value of 4KB is a good choice absent requirements from the operating system or storage device.</td><td>an integer between 512B and 128MB; default <code>4KB</code>. </td></tr>
<tr>
<td><code>app_metadata</code></td><td>application-owned metadata for this object.</td><td>a string; default empty. </td></tr>
<tr>
<td><code>block_allocation</code></td><td>configure block allocation. Permitted values are <code>"first"</code> or <code>"best"</code>; the <code>"first"</code> configuration uses a first-available algorithm during block allocation, the <code>"best"</code> configuration uses a best-fit algorithm.</td><td>a string, chosen from the following options: <code>"first"</code>, <code>"best"</code>; default <code>best</code>. </td></tr>
<tr>
<td><code>block_compressor</code></td><td>configure a compressor for file blocks. Permitted values are <code>"none"</code> or custom compression engine name created with <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#a4f26bfa799ae5e72b536ac93d6200783" title="Add a compression function. ">WT_CONNECTION::add_compressor</a>. If WiredTiger has builtin support for <code>"snappy"</code>, <code>"lz4"</code> or <code>"zlib"</code> compression, these names are also available. See <a class="el" href="compression.html">Compressors</a> for more information.</td><td>a string; default <code>none</code>. </td></tr>
<tr>
<td><code>cache_resident</code></td><td>do not ever evict the object's pages from cache. Not compatible with LSM tables; see <a class="el" href="tune_cache.html#tuning_cache_resident">Cache resident objects</a> for more information.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>checksum</code></td><td>configure block checksums; permitted values are <code>on</code> (checksum all blocks), <code>off</code> (checksum no blocks) and <code>uncompresssed</code> (checksum only blocks which are not compressed for any reason). The <code>uncompressed</code> setting is for applications which can rely on decompression to fail if a block has been corrupted.</td><td>a string, chosen from the following options: <code>"on"</code>, <code>"off"</code>, <code>"uncompressed"</code>; default <code>uncompressed</code>. </td></tr>
<tr>
<td><code>colgroups</code></td><td>comma-separated list of names of column groups. Each column group is stored separately, keyed by the primary key of the table. If no column groups are specified, all columns are stored together in a single file. All value columns in the table must appear in at least one column group. Each column group must be created with a separate call to <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb" title="Create a table, column group, index or file. ">WT_SESSION::create</a>.</td><td>a list of strings; default empty. </td></tr>
<tr>
<td><code>collator</code></td><td>configure custom collation for keys. Permitted values are <code>"none"</code> or a custom collator name created with <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#a89290382c55f20e5a4e1bc9216c7a8c8" title="Add a custom collation function. ">WT_CONNECTION::add_collator</a>.</td><td>a string; default <code>none</code>. </td></tr>
<tr>
<td><code>columns</code></td><td>list of the column names. Comma-separated list of the form <code>(column[,...])</code>. For tables, the number of entries must match the total number of values in <code>key_format</code> and <code>value_format</code>. For colgroups and indices, all column names must appear in the list of columns for the table.</td><td>a list of strings; default empty. </td></tr>
<tr>
<td><code>dictionary</code></td><td>the maximum number of unique values remembered in the Btree row-store leaf page value dictionary; see <a class="el" href="file_formats.html#file_formats_compression">File formats and compression</a> for more information.</td><td>an integer greater than or equal to 0; default <code>0</code>. </td></tr>
<tr>
<td><code>encryption = (</code></td><td>configure an encryptor for file blocks. When a table is created, its encryptor is not implicitly used for any related indices or column groups.</td><td>a set of related configuration options defined below. </td></tr>
<tr>
<td><code>    keyid</code></td><td>An identifier that identifies a unique instance of the encryptor. It is stored in clear text, and thus is available when the wiredtiger database is reopened. On the first use of a (name, keyid) combination, the <a class="el" href="struct_w_t___e_n_c_r_y_p_t_o_r.html#a947e253ec628a29b62e4b6656eb7b92a" title="If non-NULL, this callback is called to customize the encryptor. ">WT_ENCRYPTOR::customize</a> function is called with the keyid as an argument.</td><td>a string; default empty. </td></tr>
<tr>
<td><code>    name</code></td><td>Permitted values are <code>"none"</code> or custom encryption engine name created with <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#a59d203f4474780ca34bd3e07b8064949" title="Add an encryption function. ">WT_CONNECTION::add_encryptor</a>. See <a class="el" href="encryption.html">Encryptors</a> for more information.</td><td>a string; default <code>none</code>. </td></tr>
<tr>
<td><code> )</code></td><td></td><td></td></tr>
<tr>
<td><code>exclusive</code></td><td>fail if the object exists. When false (the default), if the object exists, check that its settings match the specified configuration.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>extractor</code></td><td>configure custom extractor for indices. Permitted values are <code>"none"</code> or an extractor name created with <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#a2d65a70a305838e2a2a728fe5cb54903" title="Add a custom extractor for index keys or column groups. ">WT_CONNECTION::add_extractor</a>.</td><td>a string; default <code>none</code>. </td></tr>
<tr>
<td><code>format</code></td><td>the file format.</td><td>a string, chosen from the following options: <code>"btree"</code>; default <code>btree</code>. </td></tr>
<tr>
<td><code>huffman_key</code></td><td>configure Huffman encoding for keys. Permitted values are <code>"none"</code>, <code>"english"</code>, <code>"utf8<file>"</code> or <code>"utf16<file>"</code>. See <a class="el" href="huffman.html">Huffman Encoding</a> for more information.</td><td>a string; default <code>none</code>. </td></tr>
<tr>
<td><code>huffman_value</code></td><td>configure Huffman encoding for values. Permitted values are <code>"none"</code>, <code>"english"</code>, <code>"utf8<file>"</code> or <code>"utf16<file>"</code>. See <a class="el" href="huffman.html">Huffman Encoding</a> for more information.</td><td>a string; default <code>none</code>. </td></tr>
<tr>
<td><code>immutable</code></td><td>configure the index to be immutable - that is an index is not changed by any update to a record in the table.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>internal_key_max</code></td><td>the largest key stored in an internal node, in bytes. If set, keys larger than the specified size are stored as overflow items (which may require additional I/O to access). The default and the maximum allowed value are both one-tenth the size of a newly split internal page.</td><td>an integer greater than or equal to 0; default <code>0</code>. </td></tr>
<tr>
<td><code>internal_key_truncate</code></td><td>configure internal key truncation, discarding unnecessary trailing bytes on internal keys (ignored for custom collators).</td><td>a boolean flag; default <code>true</code>. </td></tr>
<tr>
<td><code>internal_page_max</code></td><td>the maximum page size for internal nodes, in bytes; the size must be a multiple of the allocation size and is significant for applications wanting to avoid excessive L2 cache misses while searching the tree. The page maximum is the bytes of uncompressed data, that is, the limit is applied before any block compression is done.</td><td>an integer between 512B and 512MB; default <code>4KB</code>. </td></tr>
<tr>
<td><code>key_format</code></td><td>the format of the data packed into key items. See <a class="el" href="schema.html#schema_format_types">Format types</a> for details. By default, the key_format is <code>'u'</code> and applications use <a class="el" href="group__wt.html#struct_w_t___i_t_e_m" title="A raw item of data to be managed, including a pointer to the data and a length. ">WT_ITEM</a> structures to manipulate raw byte arrays. By default, records are stored in row-store files: keys of type <code>'r'</code> are record numbers and records referenced by record number are stored in column-store files.</td><td>a format string; default <code>u</code>. </td></tr>
<tr>
<td><code>leaf_key_max</code></td><td>the largest key stored in a leaf node, in bytes. If set, keys larger than the specified size are stored as overflow items (which may require additional I/O to access). The default value is one-tenth the size of a newly split leaf page.</td><td>an integer greater than or equal to 0; default <code>0</code>. </td></tr>
<tr>
<td><code>leaf_page_max</code></td><td>the maximum page size for leaf nodes, in bytes; the size must be a multiple of the allocation size, and is significant for applications wanting to maximize sequential data transfer from a storage device. The page maximum is the bytes of uncompressed data, that is, the limit is applied before any block compression is done.</td><td>an integer between 512B and 512MB; default <code>32KB</code>. </td></tr>
<tr>
<td><code>leaf_value_max</code></td><td>the largest value stored in a leaf node, in bytes. If set, values larger than the specified size are stored as overflow items (which may require additional I/O to access). If the size is larger than the maximum leaf page size, the page size is temporarily ignored when large values are written. The default is one-half the size of a newly split leaf page.</td><td>an integer greater than or equal to 0; default <code>0</code>. </td></tr>
<tr>
<td><code>log = (</code></td><td>the transaction log configuration for this object. Only valid if log is enabled in <a class="el" href="group__wt.html#ga9e6adae3fc6964ef837a62795c7840ed" title="Open a connection to a database. ">wiredtiger_open</a>.</td><td>a set of related configuration options defined below. </td></tr>
<tr>
<td><code>    enabled</code></td><td>if false, this object has checkpoint-level durability.</td><td>a boolean flag; default <code>true</code>. </td></tr>
<tr>
<td><code> )</code></td><td></td><td></td></tr>
<tr>
<td><code>lsm = (</code></td><td>options only relevant for LSM data sources.</td><td>a set of related configuration options defined below. </td></tr>
<tr>
<td><code>    auto_throttle</code></td><td>Throttle inserts into LSM trees if flushing to disk isn't keeping up.</td><td>a boolean flag; default <code>true</code>. </td></tr>
<tr>
<td><code>    bloom</code></td><td>create bloom filters on LSM tree chunks as they are merged.</td><td>a boolean flag; default <code>true</code>. </td></tr>
<tr>
<td><code>    bloom_bit_count</code></td><td>the number of bits used per item for LSM bloom filters.</td><td>an integer between 2 and 1000; default <code>16</code>. </td></tr>
<tr>
<td><code>    bloom_config</code></td><td>config string used when creating Bloom filter files, passed to <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb" title="Create a table, column group, index or file. ">WT_SESSION::create</a>.</td><td>a string; default empty. </td></tr>
<tr>
<td><code>    bloom_hash_count</code></td><td>the number of hash values per item used for LSM bloom filters.</td><td>an integer between 2 and 100; default <code>8</code>. </td></tr>
<tr>
<td><code>    bloom_oldest</code></td><td>create a bloom filter on the oldest LSM tree chunk. Only supported if bloom filters are enabled.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>    chunk_count_limit</code></td><td>the maximum number of chunks to allow in an LSM tree. This option automatically times out old data. As new chunks are added old chunks will be removed. Enabling this option disables LSM background merges.</td><td>an integer; default <code>0</code>. </td></tr>
<tr>
<td><code>    chunk_max</code></td><td>the maximum size a single chunk can be. Chunks larger than this size are not considered for further merges. This is a soft limit, and chunks larger than this value can be created. Must be larger than chunk_size.</td><td>an integer between 100MB and 10TB; default <code>5GB</code>. </td></tr>
<tr>
<td><code>    chunk_size</code></td><td>the maximum size of the in-memory chunk of an LSM tree. This limit is soft - it is possible for chunks to be temporarily larger than this value. This overrides the <code>memory_page_max</code> setting.</td><td>an integer between 512K and 500MB; default <code>10MB</code>. </td></tr>
<tr>
<td><code>    merge_max</code></td><td>the maximum number of chunks to include in a merge operation.</td><td>an integer between 2 and 100; default <code>15</code>. </td></tr>
<tr>
<td><code>    merge_min</code></td><td>the minimum number of chunks to include in a merge operation. If set to 0 or 1 half the value of merge_max is used.</td><td>an integer no more than 100; default <code>0</code>. </td></tr>
<tr>
<td><code> )</code></td><td></td><td></td></tr>
<tr>
<td><code>memory_page_max</code></td><td>the maximum size a page can grow to in memory before being reconciled to disk. The specified size will be adjusted to a lower bound of <code>50 * leaf_page_max</code>, and an upper bound of <code>cache_size / 2</code>. This limit is soft - it is possible for pages to be temporarily larger than this value. This setting is ignored for LSM trees, see <code>chunk_size</code>.</td><td>an integer between 512B and 10TB; default <code>5MB</code>. </td></tr>
<tr>
<td><code>os_cache_dirty_max</code></td><td>maximum dirty system buffer cache usage, in bytes. If non-zero, schedule writes for dirty blocks belonging to this object in the system buffer cache after that many bytes from this object are written into the buffer cache.</td><td>an integer greater than or equal to 0; default <code>0</code>. </td></tr>
<tr>
<td><code>os_cache_max</code></td><td>maximum system buffer cache usage, in bytes. If non-zero, evict object blocks from the system buffer cache after that many bytes from this object are read or written into the buffer cache.</td><td>an integer greater than or equal to 0; default <code>0</code>. </td></tr>
<tr>
<td><code>prefix_compression</code></td><td>configure prefix compression on row-store leaf pages.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>prefix_compression_min</code></td><td>minimum gain before prefix compression will be used on row-store leaf pages.</td><td>an integer greater than or equal to 0; default <code>4</code>. </td></tr>
<tr>
<td><code>split_pct</code></td><td>the Btree page split size as a percentage of the maximum Btree page size, that is, when a Btree page is split, it will be split into smaller pages, where each page is the specified percentage of the maximum Btree page size.</td><td>an integer between 25 and 100; default <code>75</code>. </td></tr>
<tr>
<td><code>type</code></td><td>set the type of data source used to store a column group, index or simple table. By default, a <code>"file:"</code> URI is derived from the object name. The <code>type</code> configuration can be used to switch to a different data source, such as LSM or an extension configured by the application.</td><td>a string; default <code>file</code>. </td></tr>
<tr>
<td><code>value_format</code></td><td>the format of the data packed into value items. See <a class="el" href="schema.html#schema_format_types">Format types</a> for details. By default, the value_format is <code>'u'</code> and applications use a <a class="el" href="group__wt.html#struct_w_t___i_t_e_m" title="A raw item of data to be managed, including a pointer to the data and a length. ">WT_ITEM</a> structure to manipulate raw byte arrays. Value items of type 't' are bitfields, and when configured with record number type keys, will be stored using a fixed-length store.</td><td>a format string; default <code>u</code>. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a08aa0622c56a5839b7c38f420b1f2a85"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.drop </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Drop (delete) an object. </p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#adf785ef53c16d9dcc77e22cc04c87b70">drop</a>(session, <span class="stringliteral">"table:mytable"</span>, NULL);</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">name</td><td>the URI of the object to drop, such as <code>"table:stock"</code> </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>force</code></td><td>return success if the object does not exist.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>lock_wait</code></td><td>wait for locks, if <code>lock_wait=false</code>, fail if any required locks are not available immediately.</td><td>a boolean flag; default <code>true</code>. </td></tr>
<tr>
<td><code>remove_files</code></td><td>should the underlying files be removed?.</td><td>a boolean flag; default <code>true</code>. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success, EBUSY if there are open cursors on the object and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a75ec87d13d61c38312f6097e86470b22"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.join </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> </td>
<td class="paramname"><em>join_cursor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> </td>
<td class="paramname"><em>ref_cursor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Join a join cursor with a reference cursor. </p>
<div class="fragment"><div class="line"> <span class="comment">/* Open cursors needed by the join. */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(session,</div>
<div class="line"> <span class="stringliteral">"join:table:poptable"</span>, NULL, NULL, &join_cursor);</div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(session,</div>
<div class="line"> <span class="stringliteral">"index:poptable:country"</span>, NULL, NULL, &cursor);</div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(session,</div>
<div class="line"> <span class="stringliteral">"index:poptable:immutable_year"</span>, NULL, NULL, &cursor2);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* select values WHERE country == "AU" AND year > 1900 */</span></div>
<div class="line"> cursor->set_key(cursor, <span class="stringliteral">"AU\0\0\0"</span>);</div>
<div class="line"> ret = cursor->search(cursor);</div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#ae0ab118df83d173c6a20eb1ea3f3fd84">join</a>(session, join_cursor, cursor,</div>
<div class="line"> <span class="stringliteral">"compare=eq,count=10"</span>);</div>
<div class="line"> cursor2->set_key(cursor2, (uint16_t)1900);</div>
<div class="line"> ret = cursor2->search(cursor2);</div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#ae0ab118df83d173c6a20eb1ea3f3fd84">join</a>(session, join_cursor, cursor2,</div>
<div class="line"> <span class="stringliteral">"compare=gt,count=10,strategy=bloom"</span>);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* List the values that are joined */</span></div>
<div class="line"> <span class="keywordflow">while</span> ((ret = join_cursor->next(join_cursor)) == 0) {</div>
<div class="line"> ret = join_cursor->get_key(join_cursor, &recno);</div>
<div class="line"> ret = join_cursor->get_value(join_cursor, &country, &year,</div>
<div class="line"> &population);</div>
<div class="line"> printf(<span class="stringliteral">"ID %"</span> PRIu64, recno);</div>
<div class="line"> printf(</div>
<div class="line"> <span class="stringliteral">": country %s, year %"</span> PRIu16 <span class="stringliteral">", population %"</span> PRIu64 <span class="stringliteral">"\n"</span>,</div>
<div class="line"> country, year, population);</div>
<div class="line"> }</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">join_cursor</td><td>a cursor that was opened using a <code>"join:"</code> URI. It may not have been used for any operations other than other join calls. </td></tr>
<tr><td class="paramname">ref_cursor</td><td>either an index cursor having the same base table as the join_cursor, or a table cursor open on the same base table. The ref_cursor must be positioned.</td></tr>
</table>
</dd>
</dl>
<p>The ref_cursor limits the results seen by iterating the join_cursor to table items referred to by the key in this index. The set of keys referred to is modified by the compare config option.</p>
<p>Multiple join calls builds up a set of ref_cursors, and the results seen by iteration are the intersection of the cursor ranges participating in the join.</p>
<p>After the join call completes, the ref_cursor cursor may not be used for any purpose other than get_key and get_value. Any other cursor method (e.g. next, prev,close) will fail. When the join_cursor is closed, the ref_cursor is made available for general use again. The application should close ref_cursor when finished with it, although not before the join_cursor is closed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>bloom_bit_count</code></td><td>the number of bits used per item for the bloom filter.</td><td>an integer between 2 and 1000; default <code>16</code>. </td></tr>
<tr>
<td><code>bloom_hash_count</code></td><td>the number of hash values per item for the bloom filter.</td><td>an integer between 2 and 100; default <code>8</code>. </td></tr>
<tr>
<td><code>compare</code></td><td>modifies the set of items to be returned so that the index key satisfies the given comparison relative to the key set in this cursor.</td><td>a string, chosen from the following options: <code>"eq"</code>, <code>"ge"</code>, <code>"gt"</code>, <code>"le"</code>, <code>"lt"</code>; default <code>"eq"</code>. </td></tr>
<tr>
<td><code>count</code></td><td>set an approximate count of the elements that would be included in the join. This is used in sizing the bloom filter, and also influences evaluation order for cursors in the join. When the count is equal for multiple bloom filters in a composition of joins, the bloom filter may be shared.</td><td>an integer; default <code></code>. </td></tr>
<tr>
<td><code>strategy</code></td><td>when set to bloom, a bloom filter is created and populated for this index. This has an up front cost but may reduce the number of accesses to the main table when iterating the joined cursor. The bloom setting requires that count be set.</td><td>a string, chosen from the following options: <code>"bloom"</code>, <code>"default"</code>; default empty. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="ac8790893082bc6ca34ca288008971944"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.log_flush </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em></td><td>)</td>
<td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flush the log. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>sync</code></td><td>forcibly flush the log and wait for it to achieve the synchronization level specified. The <code>background</code> setting initiates a background synchronization intended to be used with a later call to <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a61c8c3ad80d8228172db66ca70bd90fd" title="Wait for a transaction to become synchronized. ">WT_SESSION::transaction_sync</a>. The <code>off</code> setting forces any buffered log records to be written to the file system. The <code>on</code> setting forces log records to be written to the storage device.</td><td>a string, chosen from the following options: <code>"background"</code>, <code>"off"</code>, <code>"on"</code>; default <code>on</code>. </td></tr>
</table>
</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a094ae49ac5f0533817961284c89b8327"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.log_printf </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>fmt</em></td><td>)</td>
<td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Insert a <a class="el" href="group__wt.html#ga8cf04a003979e7852209079d4093d783" title="message ">WT_LOGREC_MESSAGE</a> type record in the database log files (the database must be configured for logging when this method is called). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">fmt</td><td>a printf format specifier </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="adc61edbe05447e070a2d0729bd36a084"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> com.wiredtiger.db.Session.open_cursor </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html">Cursor</a> </td>
<td class="paramname"><em>to_dup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open a new cursor on a data source or duplicate an existing cursor. </p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(</div>
<div class="line"> session, <span class="stringliteral">"table:mytable"</span>, NULL, NULL, &cursor);</div>
</div><!-- fragment --><p> An existing cursor can be duplicated by passing it as the <code>to_dup</code> parameter and setting the <code>uri</code> parameter to <code>NULL:</code> </p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(</div>
<div class="line"> session, <span class="stringliteral">"table:mytable"</span>, NULL, NULL, &cursor);</div>
<div class="line"> cursor->set_key(cursor, key);</div>
<div class="line"> ret = cursor->search(cursor);</div>
<div class="line"></div>
<div class="line"> <span class="comment">/* Duplicate the cursor. */</span></div>
<div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#afb5b4a69c2c5cafe411b2b04fdc1c75d">open_cursor</a>(session, NULL, cursor, NULL, &duplicate);</div>
</div><!-- fragment --><p> Cursors being duplicated must have a key set, and successfully duplicated cursors are positioned at the same place in the data source as the original.</p>
<p><a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_cursor.html" title="A WT_CURSOR handle is the interface to a cursor. ">Cursor</a> handles should be discarded by calling <a class="el" href="struct_w_t___c_u_r_s_o_r.html#aeea071f192cab12245a50fbe71c3460b" title="Close the cursor. ">WT_CURSOR::close</a>.</p>
<p>Cursors capable of supporting transactional operations operate in the context of the current transaction, if any.</p>
<p><a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#ab45f521464ad9e54d9b15efc2ffe20a1" title="Roll back the current transaction. ">WT_SESSION::rollback_transaction</a> implicitly resets all cursors.</p>
<p>Cursors are relatively light-weight objects but may hold references to heavier-weight objects; applications should re-use cursors when possible, but instantiating new cursors is not so expensive that applications need to cache cursors at all cost.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">uri</td><td>the data source on which the cursor operates; cursors are usually opened on tables, however, cursors can be opened on any data source, regardless of whether it is ultimately stored in a table. Some cursor types may have limited functionality (for example, they may be read-only or not support transactional updates). See <a class="el" href="data_sources.html">Data Sources</a> for more information. <br />
</td></tr>
</table>
</dd>
</dl>
<p>The following are the builtin basic cursor types: </p><table class="doxtable">
<tr>
<th>URI</th><th>Type</th><th>Notes </th></tr>
<tr>
<td><code>table:<table name>[<projection>]</code></td><td>table cursor</td><td>table key, table value(s) with optional projection of columns </td></tr>
<tr>
<td><code>colgroup:<table name>:<column group name></code></td><td>column group cursor</td><td>table key, column group value(s) </td></tr>
<tr>
<td><code>index:<table name>:<index name>[<projection>]</code></td><td>index cursor</td><td>key=index key, value=table value(s) with optional projection of columns </td></tr>
<tr>
<td><code>join:table:<table name>[<projection>]</code></td><td>join cursor</td><td>key=table key, value=table value(s) with optional projection of columns </td></tr>
</table>
<p>Some administrative tasks can be accomplished using the following special cursor types that give access to data managed by WiredTiger: </p><table class="doxtable">
<tr>
<th>URI</th><th>Type</th><th>Notes </th></tr>
<tr>
<td><code>backup:</code></td><td>backup cursor</td><td>key=<code>string</code>, see <a class="el" href="backup.html">Backups</a> for details </td></tr>
<tr>
<td><code>log:</code></td><td>log cursor</td><td>key=<code>(long fileID, long offset, int seqno)</code>,<br />
value=<code>(uint64_t txnid, uint32_t rectype,<br />
uint32_t optype, uint32_t fileid,<br />
<a class="el" href="group__wt.html#struct_w_t___i_t_e_m" title="A raw item of data to be managed, including a pointer to the data and a length. ">WT_ITEM</a> key, <a class="el" href="group__wt.html#struct_w_t___i_t_e_m" title="A raw item of data to be managed, including a pointer to the data and a length. ">WT_ITEM</a> value)</code>,<br />
see <a class="el" href="cursor_log.html">Log cursors</a> for details </td></tr>
<tr>
<td><code>metadata:[create]</code></td><td>metadata cursor (optionally only returning configuration strings for <a class="el" href="struct_w_t___s_e_s_s_i_o_n.html#a358ca4141d59c345f401c58501276bbb" title="Create a table, column group, index or file. ">WT_SESSION::create</a> if <code>create</code> is appended</td><td>key=<code>string</code>, value=<code>string</code>,<br />
see <a class="el" href="cursors.html#metadata">Reading WiredTiger Metadata</a> for details </td></tr>
<tr>
<td><code>statistics:[<data source URI>]</code></td><td>database</td><td>data source or join statistics cursor</td><td>key=<code>int id</code>,<br />
value=<code>(string description, string value, uint64_t value)</code>,<br />
see <a class="el" href="data_sources.html#data_statistics">Statistics Data</a> for details </td></tr>
</table>
<p>Advanced applications may also open the following low-level cursor types: </p><table class="doxtable">
<tr>
<th>URI</th><th>Type</th><th>Notes </th></tr>
<tr>
<td><code>file:<file name></code></td><td>file cursor</td><td>file key, file value(s) </td></tr>
<tr>
<td><code>lsm:<name></code></td><td>LSM cursor (key=LSM key, value=LSM value)</td><td>LSM key, LSM value,<br />
see <a class="el" href="lsm.html">Log-Structured Merge Trees</a> </td></tr>
</table>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">to_dup</td><td>a cursor to duplicate or gather statistics on </td></tr>
<tr><td class="paramdir"></td><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. Permitted values: <table class="doxtable">
<tr>
<th>Name</th><th>Effect</th><th>Values </th></tr>
<tr>
<td><code>append</code></td><td>append the value as a new record, creating a new record number key; valid only for cursors with record number keys.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>bulk</code></td><td>configure the cursor for bulk-loading, a fast, initial load path (see <a class="el" href="tune_bulk_load.html">Bulk-load</a> for more information). Bulk-load may only be used for newly created objects and applications should use the <a class="el" href="struct_w_t___c_u_r_s_o_r.html#aac90d9fbcc031570f924db55f8a1cee3" title="Insert a record and optionally update an existing record. ">WT_CURSOR::insert</a> method to insert rows. When bulk-loading, rows must be loaded in sorted order. The value is usually a true/false flag; when bulk-loading fixed-length column store objects, the special value <code>bitmap</code> allows chunks of a memory resident bitmap to be loaded directly into a file by passing a <code><a class="el" href="group__wt.html#struct_w_t___i_t_e_m" title="A raw item of data to be managed, including a pointer to the data and a length. ">WT_ITEM</a></code> to <a class="el" href="struct_w_t___c_u_r_s_o_r.html#a27f7cbd0cd3e561f6a145704813ad64c" title="Set the value for the next operation. ">WT_CURSOR::set_value</a> where the <code>size</code> field indicates the number of records in the bitmap (as specified by the object's <code>value_format</code> configuration). Bulk-loaded bitmap values must end on a byte boundary relative to the bit count (except for the last set of values loaded).</td><td>a string; default <code>false</code>. </td></tr>
<tr>
<td><code>checkpoint</code></td><td>the name of a checkpoint to open (the reserved name "WiredTigerCheckpoint" opens the most recent internal checkpoint taken for the object). The cursor does not support data modification.</td><td>a string; default empty. </td></tr>
<tr>
<td><code>dump</code></td><td>configure the cursor for dump format inputs and outputs: "hex" selects a simple hexadecimal format, "json" selects a JSON format with each record formatted as fields named by column names if available, and "print" selects a format where only non-printing characters are hexadecimal encoded. These formats are compatible with the <a class="el" href="command_line.html#util_dump">wt dump</a> and <a class="el" href="command_line.html#util_load">wt load</a> commands.</td><td>a string, chosen from the following options: <code>"hex"</code>, <code>"json"</code>, <code>"print"</code>; default empty. </td></tr>
<tr>
<td><code>next_random</code></td><td>configure the cursor to return a pseudo-random record from the object when the <a class="el" href="struct_w_t___c_u_r_s_o_r.html#a0503f16bd8f3d05aa3552f229b3a8e1b" title="Return the next record. ">WT_CURSOR::next</a> method is called; valid only for row-store cursors. See <a class="el" href="cursor_random.html">Cursor random</a> for details.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>next_random_sample_size</code></td><td>cursors configured by <code>next_random</code> to return pseudo-random records from the object randomly select from the entire object, by default. Setting <code>next_random_sample_size</code> to a non-zero value sets the number of samples the application expects to take using the <code>next_random</code> cursor. A cursor configured with both <code>next_random</code> and <code>next_random_sample_size</code> attempts to divide the object into <code>next_random_sample_size</code> equal-sized pieces, and each retrieval returns a record from one of those pieces. See <a class="el" href="cursor_random.html">Cursor random</a> for details.</td><td>a string; default <code>0</code>. </td></tr>
<tr>
<td><code>overwrite</code></td><td>configures whether the cursor's insert, update and remove methods check the existing state of the record. If <code>overwrite</code> is <code>false</code>, <a class="el" href="struct_w_t___c_u_r_s_o_r.html#aac90d9fbcc031570f924db55f8a1cee3" title="Insert a record and optionally update an existing record. ">WT_CURSOR::insert</a> fails with <a class="el" href="group__wt.html#gaeca1f3c4a70b8b71b56d2c2fc99a469c" title="Attempt to insert an existing key. ">WT_DUPLICATE_KEY</a> if the record exists, <a class="el" href="struct_w_t___c_u_r_s_o_r.html#a444cdc0952e7f8d55d23173516c7037f" title="Update an existing record and optionally insert a record. ">WT_CURSOR::update</a> and <a class="el" href="struct_w_t___c_u_r_s_o_r.html#abbba24fe607fee519c4c9c4669cd4455" title="Remove a record. ">WT_CURSOR::remove</a> fail with <a class="el" href="group__wt.html#ga3c9e1b494d95cf34404ab7a974af6bf8" title="Item not found. ">WT_NOTFOUND</a> if the record does not exist.</td><td>a boolean flag; default <code>true</code>. </td></tr>
<tr>
<td><code>raw</code></td><td>ignore the encodings for the key and value, manage data as if the formats were <code>"u"</code>. See <a class="el" href="cursors.html#cursor_raw">Raw mode</a> for details.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>readonly</code></td><td>only query operations are supported by this cursor. An error is returned if a modification is attempted using the cursor. The default is false for all cursor types except for log and metadata cursors.</td><td>a boolean flag; default <code>false</code>. </td></tr>
<tr>
<td><code>statistics</code></td><td>Specify the statistics to be gathered. Choosing "all" gathers statistics regardless of cost and may include traversing on-disk files; "fast" gathers a subset of relatively inexpensive statistics. The selection must agree with the database <code>statistics</code> configuration specified to <a class="el" href="group__wt.html#ga9e6adae3fc6964ef837a62795c7840ed" title="Open a connection to a database. ">wiredtiger_open</a> or <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#a579141678af06217b22869cbc604c6d4" title="Reconfigure a connection handle. ">WT_CONNECTION::reconfigure</a>. For example, "all" or "fast" can be configured when the database is configured with "all", but the cursor open will fail if "all" is specified when the database is configured with "fast", and the cursor open will fail in all cases when the database is configured with "none". If "size" is configured, only the underlying size of the object on disk is filled in and the object is not opened. If <code>statistics</code> is not configured, the default configuration is the database configuration. The "clear" configuration resets statistics after gathering them, where appropriate (for example, a cache size statistic is not cleared, while the count of cursor insert operations will be cleared). See <a class="el" href="statistics.html">Statistics</a> for more information.</td><td>a list, with values chosen from the following options: <code>"all"</code>, <code>"fast"</code>, <code>"clear"</code>, <code>"size"</code>; default empty. </td></tr>
<tr>
<td><code>target</code></td><td>if non-empty, backup the list of objects; valid only for a backup data source.</td><td>a list of strings; default empty. </td></tr>
</table>
</td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">cursorp</td><td>a pointer to the newly opened cursor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="ae8e72b903d72a3ca1f1a0dd019c186d7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int com.wiredtiger.db.Session.rebalance </td>
<td>(</td>
<td class="paramtype">String </td>
<td class="paramname"><em>uri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throws <a class="el" href="classcom_1_1wiredtiger_1_1db_1_1_wired_tiger_exception.html">com.wiredtiger.db.WiredTigerException</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Rebalance a table, see <a class="el" href="rebalance.html">Rebalance</a>. </p>
<div class="fragment"><div class="line"> ret = session-><a class="code" href="struct_w_t___s_e_s_s_i_o_n.html#ab21ec3055cade4d2682f162783314984">rebalance</a>(session, <span class="stringliteral">"table:mytable"</span>, NULL);</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>the session handle </td></tr>
<tr><td class="paramname">uri</td><td>the current URI of the object, such as <code>"table:mytable"</code> </td></tr>
<tr><td class="paramname">config</td><td>Configuration string, see <a class="el" href="config_strings.html">Configuration Strings</a>. No values currently permitted. </td></tr>
</table>
</dd>