kyotocabinet-java 0.1.0-java
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/Gemfile +15 -0
- data/LICENSE.txt +20 -0
- data/README.rdoc +19 -0
- data/Rakefile +62 -0
- data/VERSION +1 -0
- data/ext/kyotocabinet-java/.gitignore +2 -0
- data/ext/kyotocabinet-java/COPYING +674 -0
- data/ext/kyotocabinet-java/Cursor.java +268 -0
- data/ext/kyotocabinet-java/DB.java +650 -0
- data/ext/kyotocabinet-java/Error.java +257 -0
- data/ext/kyotocabinet-java/FileProcessor.java +42 -0
- data/ext/kyotocabinet-java/Loader.java +60 -0
- data/ext/kyotocabinet-java/Makefile.in +246 -0
- data/ext/kyotocabinet-java/MapReduce.java +127 -0
- data/ext/kyotocabinet-java/README +26 -0
- data/ext/kyotocabinet-java/Test.java +1494 -0
- data/ext/kyotocabinet-java/Utility.java +131 -0
- data/ext/kyotocabinet-java/VCmakefile +150 -0
- data/ext/kyotocabinet-java/ValueIterator.java +49 -0
- data/ext/kyotocabinet-java/Visitor.java +56 -0
- data/ext/kyotocabinet-java/configure.in +310 -0
- data/ext/kyotocabinet-java/doc/allclasses-frame.html +26 -0
- data/ext/kyotocabinet-java/doc/allclasses-noframe.html +26 -0
- data/ext/kyotocabinet-java/doc/constant-values.html +344 -0
- data/ext/kyotocabinet-java/doc/index-all.html +848 -0
- data/ext/kyotocabinet-java/doc/index.html +30 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/Cursor.html +711 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/DB.html +1674 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/Error.html +604 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/FileProcessor.html +210 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/MapReduce.html +461 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/Test.html +220 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/Utility.html +413 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/ValueIterator.html +221 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/Visitor.html +283 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/package-frame.html +33 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/package-summary.html +199 -0
- data/ext/kyotocabinet-java/doc/kyotocabinet/package-tree.html +141 -0
- data/ext/kyotocabinet-java/doc/overview-summary.html +285 -0
- data/ext/kyotocabinet-java/doc/overview-tree.html +145 -0
- data/ext/kyotocabinet-java/doc/package-list +1 -0
- data/ext/kyotocabinet-java/doc/resources/background.gif +0 -0
- data/ext/kyotocabinet-java/doc/resources/tab.gif +0 -0
- data/ext/kyotocabinet-java/doc/resources/titlebar.gif +0 -0
- data/ext/kyotocabinet-java/doc/resources/titlebar_end.gif +0 -0
- data/ext/kyotocabinet-java/doc/serialized-form.html +141 -0
- data/ext/kyotocabinet-java/doc/stylesheet.css +474 -0
- data/ext/kyotocabinet-java/example/KCDBEX1.java +44 -0
- data/ext/kyotocabinet-java/example/KCDBEX2.java +44 -0
- data/ext/kyotocabinet-java/example/Makefile +59 -0
- data/ext/kyotocabinet-java/kyotocabinet.cc +2187 -0
- data/ext/kyotocabinet-java/kyotocabinet_Cursor.h +157 -0
- data/ext/kyotocabinet-java/kyotocabinet_DB.h +353 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error.h +49 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XBROKEN.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XDUPREC.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XINVALID.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XLOGIC.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XMISC.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XNOIMPL.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XNOPERM.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XNOREC.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XNOREPOS.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XSUCCESS.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_Error_XSYSTEM.h +41 -0
- data/ext/kyotocabinet-java/kyotocabinet_MapReduce.h +33 -0
- data/ext/kyotocabinet-java/kyotocabinet_Utility.h +101 -0
- data/ext/kyotocabinet-java/kyotocabinet_ValueIterator.h +21 -0
- data/ext/kyotocabinet-java/overview.html +177 -0
- data/kyotocabinet-java.gemspec +129 -0
- data/lib/kyotocabinet-java.rb +141 -0
- data/lib/kyotocabinet-java/version.rb +5 -0
- metadata +222 -0
|
@@ -0,0 +1,1674 @@
|
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
2
|
+
<!-- NewPage -->
|
|
3
|
+
<html lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<!-- Generated by javadoc (version 1.7.0_04) on Fri May 25 00:40:48 JST 2012 -->
|
|
6
|
+
<title>DB (kyotocabinet)</title>
|
|
7
|
+
<meta name="date" content="2012-05-25">
|
|
8
|
+
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
9
|
+
</head>
|
|
10
|
+
<body>
|
|
11
|
+
<script type="text/javascript"><!--
|
|
12
|
+
if (location.href.indexOf('is-external=true') == -1) {
|
|
13
|
+
parent.document.title="DB (kyotocabinet)";
|
|
14
|
+
}
|
|
15
|
+
//-->
|
|
16
|
+
</script>
|
|
17
|
+
<noscript>
|
|
18
|
+
<div>JavaScript is disabled on your browser.</div>
|
|
19
|
+
</noscript>
|
|
20
|
+
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
21
|
+
<div class="topNav"><a name="navbar_top">
|
|
22
|
+
<!-- -->
|
|
23
|
+
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
24
|
+
<!-- -->
|
|
25
|
+
</a>
|
|
26
|
+
<ul class="navList" title="Navigation">
|
|
27
|
+
<li><a href="../overview-summary.html">Overview</a></li>
|
|
28
|
+
<li><a href="../kyotocabinet/package-summary.html">Package</a></li>
|
|
29
|
+
<li class="navBarCell1Rev">Class</li>
|
|
30
|
+
<li><a href="package-tree.html">Tree</a></li>
|
|
31
|
+
<li><a href="../index-all.html">Index</a></li>
|
|
32
|
+
</ul>
|
|
33
|
+
</div>
|
|
34
|
+
<div class="subNav">
|
|
35
|
+
<ul class="navList">
|
|
36
|
+
<li><a href="../kyotocabinet/Cursor.html" title="class in kyotocabinet"><span class="strong">Prev Class</span></a></li>
|
|
37
|
+
<li><a href="../kyotocabinet/Error.html" title="class in kyotocabinet"><span class="strong">Next Class</span></a></li>
|
|
38
|
+
</ul>
|
|
39
|
+
<ul class="navList">
|
|
40
|
+
<li><a href="../index.html?kyotocabinet/DB.html" target="_top">Frames</a></li>
|
|
41
|
+
<li><a href="DB.html" target="_top">No Frames</a></li>
|
|
42
|
+
</ul>
|
|
43
|
+
<ul class="navList" id="allclasses_navbar_top">
|
|
44
|
+
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
|
45
|
+
</ul>
|
|
46
|
+
<div>
|
|
47
|
+
<script type="text/javascript"><!--
|
|
48
|
+
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
49
|
+
if(window==top) {
|
|
50
|
+
allClassesLink.style.display = "block";
|
|
51
|
+
}
|
|
52
|
+
else {
|
|
53
|
+
allClassesLink.style.display = "none";
|
|
54
|
+
}
|
|
55
|
+
//-->
|
|
56
|
+
</script>
|
|
57
|
+
</div>
|
|
58
|
+
<div>
|
|
59
|
+
<ul class="subNavList">
|
|
60
|
+
<li>Summary: </li>
|
|
61
|
+
<li>Nested | </li>
|
|
62
|
+
<li><a href="#field_summary">Field</a> | </li>
|
|
63
|
+
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
64
|
+
<li><a href="#method_summary">Method</a></li>
|
|
65
|
+
</ul>
|
|
66
|
+
<ul class="subNavList">
|
|
67
|
+
<li>Detail: </li>
|
|
68
|
+
<li><a href="#field_detail">Field</a> | </li>
|
|
69
|
+
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
70
|
+
<li><a href="#method_detail">Method</a></li>
|
|
71
|
+
</ul>
|
|
72
|
+
</div>
|
|
73
|
+
<a name="skip-navbar_top">
|
|
74
|
+
<!-- -->
|
|
75
|
+
</a></div>
|
|
76
|
+
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
77
|
+
<!-- ======== START OF CLASS DATA ======== -->
|
|
78
|
+
<div class="header">
|
|
79
|
+
<div class="subTitle">kyotocabinet</div>
|
|
80
|
+
<h2 title="Class DB" class="title">Class DB</h2>
|
|
81
|
+
</div>
|
|
82
|
+
<div class="contentContainer">
|
|
83
|
+
<ul class="inheritance">
|
|
84
|
+
<li>Object</li>
|
|
85
|
+
<li>
|
|
86
|
+
<ul class="inheritance">
|
|
87
|
+
<li>DB</li>
|
|
88
|
+
</ul>
|
|
89
|
+
</li>
|
|
90
|
+
</ul>
|
|
91
|
+
<div class="description">
|
|
92
|
+
<ul class="blockList">
|
|
93
|
+
<li class="blockList">
|
|
94
|
+
<hr>
|
|
95
|
+
<br>
|
|
96
|
+
<pre>public class <span class="strong">DB</span>
|
|
97
|
+
extends Object</pre>
|
|
98
|
+
<div class="block">Interface of database abstraction.</div>
|
|
99
|
+
</li>
|
|
100
|
+
</ul>
|
|
101
|
+
</div>
|
|
102
|
+
<div class="summary">
|
|
103
|
+
<ul class="blockList">
|
|
104
|
+
<li class="blockList">
|
|
105
|
+
<!-- =========== FIELD SUMMARY =========== -->
|
|
106
|
+
<ul class="blockList">
|
|
107
|
+
<li class="blockList"><a name="field_summary">
|
|
108
|
+
<!-- -->
|
|
109
|
+
</a>
|
|
110
|
+
<h3>Field Summary</h3>
|
|
111
|
+
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
112
|
+
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
113
|
+
<tr>
|
|
114
|
+
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
115
|
+
<th class="colLast" scope="col">Field and Description</th>
|
|
116
|
+
</tr>
|
|
117
|
+
<tr class="altColor">
|
|
118
|
+
<td class="colFirst"><code>static int</code></td>
|
|
119
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#GEXCEPTIONAL">GEXCEPTIONAL</a></strong></code>
|
|
120
|
+
<div class="block">generic mode: exceptional mode</div>
|
|
121
|
+
</td>
|
|
122
|
+
</tr>
|
|
123
|
+
<tr class="rowColor">
|
|
124
|
+
<td class="colFirst"><code>static int</code></td>
|
|
125
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#MADD">MADD</a></strong></code>
|
|
126
|
+
<div class="block">merge mode: keep the existing value</div>
|
|
127
|
+
</td>
|
|
128
|
+
</tr>
|
|
129
|
+
<tr class="altColor">
|
|
130
|
+
<td class="colFirst"><code>static int</code></td>
|
|
131
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#MAPPEND">MAPPEND</a></strong></code>
|
|
132
|
+
<div class="block">merge mode: append the new value</div>
|
|
133
|
+
</td>
|
|
134
|
+
</tr>
|
|
135
|
+
<tr class="rowColor">
|
|
136
|
+
<td class="colFirst"><code>static int</code></td>
|
|
137
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#MREPLACE">MREPLACE</a></strong></code>
|
|
138
|
+
<div class="block">merge mode: modify the existing record only</div>
|
|
139
|
+
</td>
|
|
140
|
+
</tr>
|
|
141
|
+
<tr class="altColor">
|
|
142
|
+
<td class="colFirst"><code>static int</code></td>
|
|
143
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#MSET">MSET</a></strong></code>
|
|
144
|
+
<div class="block">merge mode: overwrite the existing value</div>
|
|
145
|
+
</td>
|
|
146
|
+
</tr>
|
|
147
|
+
<tr class="rowColor">
|
|
148
|
+
<td class="colFirst"><code>static int</code></td>
|
|
149
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OAUTOSYNC">OAUTOSYNC</a></strong></code>
|
|
150
|
+
<div class="block">open mode: auto synchronization</div>
|
|
151
|
+
</td>
|
|
152
|
+
</tr>
|
|
153
|
+
<tr class="altColor">
|
|
154
|
+
<td class="colFirst"><code>static int</code></td>
|
|
155
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OAUTOTRAN">OAUTOTRAN</a></strong></code>
|
|
156
|
+
<div class="block">open mode: auto transaction</div>
|
|
157
|
+
</td>
|
|
158
|
+
</tr>
|
|
159
|
+
<tr class="rowColor">
|
|
160
|
+
<td class="colFirst"><code>static int</code></td>
|
|
161
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OCREATE">OCREATE</a></strong></code>
|
|
162
|
+
<div class="block">open mode: writer creating</div>
|
|
163
|
+
</td>
|
|
164
|
+
</tr>
|
|
165
|
+
<tr class="altColor">
|
|
166
|
+
<td class="colFirst"><code>static int</code></td>
|
|
167
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#ONOLOCK">ONOLOCK</a></strong></code>
|
|
168
|
+
<div class="block">open mode: open without locking</div>
|
|
169
|
+
</td>
|
|
170
|
+
</tr>
|
|
171
|
+
<tr class="rowColor">
|
|
172
|
+
<td class="colFirst"><code>static int</code></td>
|
|
173
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#ONOREPAIR">ONOREPAIR</a></strong></code>
|
|
174
|
+
<div class="block">open mode: open without auto repair</div>
|
|
175
|
+
</td>
|
|
176
|
+
</tr>
|
|
177
|
+
<tr class="altColor">
|
|
178
|
+
<td class="colFirst"><code>static int</code></td>
|
|
179
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OREADER">OREADER</a></strong></code>
|
|
180
|
+
<div class="block">open mode: open as a reader</div>
|
|
181
|
+
</td>
|
|
182
|
+
</tr>
|
|
183
|
+
<tr class="rowColor">
|
|
184
|
+
<td class="colFirst"><code>static int</code></td>
|
|
185
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OTRUNCATE">OTRUNCATE</a></strong></code>
|
|
186
|
+
<div class="block">open mode: writer truncating</div>
|
|
187
|
+
</td>
|
|
188
|
+
</tr>
|
|
189
|
+
<tr class="altColor">
|
|
190
|
+
<td class="colFirst"><code>static int</code></td>
|
|
191
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OTRYLOCK">OTRYLOCK</a></strong></code>
|
|
192
|
+
<div class="block">open mode: lock without blocking</div>
|
|
193
|
+
</td>
|
|
194
|
+
</tr>
|
|
195
|
+
<tr class="rowColor">
|
|
196
|
+
<td class="colFirst"><code>static int</code></td>
|
|
197
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#OWRITER">OWRITER</a></strong></code>
|
|
198
|
+
<div class="block">open mode: open as a writer</div>
|
|
199
|
+
</td>
|
|
200
|
+
</tr>
|
|
201
|
+
</table>
|
|
202
|
+
</li>
|
|
203
|
+
</ul>
|
|
204
|
+
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
205
|
+
<ul class="blockList">
|
|
206
|
+
<li class="blockList"><a name="constructor_summary">
|
|
207
|
+
<!-- -->
|
|
208
|
+
</a>
|
|
209
|
+
<h3>Constructor Summary</h3>
|
|
210
|
+
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
211
|
+
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
212
|
+
<tr>
|
|
213
|
+
<th class="colOne" scope="col">Constructor and Description</th>
|
|
214
|
+
</tr>
|
|
215
|
+
<tr class="altColor">
|
|
216
|
+
<td class="colOne"><code><strong><a href="../kyotocabinet/DB.html#DB()">DB</a></strong>()</code>
|
|
217
|
+
<div class="block">Create an instance.</div>
|
|
218
|
+
</td>
|
|
219
|
+
</tr>
|
|
220
|
+
<tr class="rowColor">
|
|
221
|
+
<td class="colOne"><code><strong><a href="../kyotocabinet/DB.html#DB(int)">DB</a></strong>(int opts)</code>
|
|
222
|
+
<div class="block">Create an instance with options.</div>
|
|
223
|
+
</td>
|
|
224
|
+
</tr>
|
|
225
|
+
</table>
|
|
226
|
+
</li>
|
|
227
|
+
</ul>
|
|
228
|
+
<!-- ========== METHOD SUMMARY =========== -->
|
|
229
|
+
<ul class="blockList">
|
|
230
|
+
<li class="blockList"><a name="method_summary">
|
|
231
|
+
<!-- -->
|
|
232
|
+
</a>
|
|
233
|
+
<h3>Method Summary</h3>
|
|
234
|
+
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
235
|
+
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
236
|
+
<tr>
|
|
237
|
+
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
238
|
+
<th class="colLast" scope="col">Method and Description</th>
|
|
239
|
+
</tr>
|
|
240
|
+
<tr class="altColor">
|
|
241
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
242
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#accept_bulk(byte[][], kyotocabinet.Visitor, boolean)">accept_bulk</a></strong>(byte[][] keys,
|
|
243
|
+
<a href="../kyotocabinet/Visitor.html" title="interface in kyotocabinet">Visitor</a> visitor,
|
|
244
|
+
boolean writable)</code>
|
|
245
|
+
<div class="block">Accept a visitor to multiple records at once.</div>
|
|
246
|
+
</td>
|
|
247
|
+
</tr>
|
|
248
|
+
<tr class="rowColor">
|
|
249
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
250
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#accept(byte[], kyotocabinet.Visitor, boolean)">accept</a></strong>(byte[] key,
|
|
251
|
+
<a href="../kyotocabinet/Visitor.html" title="interface in kyotocabinet">Visitor</a> visitor,
|
|
252
|
+
boolean writable)</code>
|
|
253
|
+
<div class="block">Accept a visitor to a record.</div>
|
|
254
|
+
</td>
|
|
255
|
+
</tr>
|
|
256
|
+
<tr class="altColor">
|
|
257
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
258
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#add(byte[], byte[])">add</a></strong>(byte[] key,
|
|
259
|
+
byte[] value)</code>
|
|
260
|
+
<div class="block">Add a record.</div>
|
|
261
|
+
</td>
|
|
262
|
+
</tr>
|
|
263
|
+
<tr class="rowColor">
|
|
264
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
265
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#add(java.lang.String, java.lang.String)">add</a></strong>(String key,
|
|
266
|
+
String value)</code>
|
|
267
|
+
<div class="block">Add a record.</div>
|
|
268
|
+
</td>
|
|
269
|
+
</tr>
|
|
270
|
+
<tr class="altColor">
|
|
271
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
272
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#append(byte[], byte[])">append</a></strong>(byte[] key,
|
|
273
|
+
byte[] value)</code>
|
|
274
|
+
<div class="block">Append the value of a record.</div>
|
|
275
|
+
</td>
|
|
276
|
+
</tr>
|
|
277
|
+
<tr class="rowColor">
|
|
278
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
279
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#append(java.lang.String, java.lang.String)">append</a></strong>(String key,
|
|
280
|
+
String value)</code>
|
|
281
|
+
<div class="block">Append the value of a record.</div>
|
|
282
|
+
</td>
|
|
283
|
+
</tr>
|
|
284
|
+
<tr class="altColor">
|
|
285
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
286
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#begin_transaction(boolean)">begin_transaction</a></strong>(boolean hard)</code>
|
|
287
|
+
<div class="block">Begin transaction.</div>
|
|
288
|
+
</td>
|
|
289
|
+
</tr>
|
|
290
|
+
<tr class="rowColor">
|
|
291
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
292
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#cas(byte[], byte[], byte[])">cas</a></strong>(byte[] key,
|
|
293
|
+
byte[] oval,
|
|
294
|
+
byte[] nval)</code>
|
|
295
|
+
<div class="block">Perform compare-and-swap.</div>
|
|
296
|
+
</td>
|
|
297
|
+
</tr>
|
|
298
|
+
<tr class="altColor">
|
|
299
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
300
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#cas(java.lang.String, java.lang.String, java.lang.String)">cas</a></strong>(String key,
|
|
301
|
+
String oval,
|
|
302
|
+
String nval)</code>
|
|
303
|
+
<div class="block">Perform compare-and-swap.</div>
|
|
304
|
+
</td>
|
|
305
|
+
</tr>
|
|
306
|
+
<tr class="rowColor">
|
|
307
|
+
<td class="colFirst"><code>int</code></td>
|
|
308
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#check(byte[])">check</a></strong>(byte[] key)</code>
|
|
309
|
+
<div class="block">Check the existence of a record.</div>
|
|
310
|
+
</td>
|
|
311
|
+
</tr>
|
|
312
|
+
<tr class="altColor">
|
|
313
|
+
<td class="colFirst"><code>int</code></td>
|
|
314
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#check(java.lang.String)">check</a></strong>(String key)</code>
|
|
315
|
+
<div class="block">Retrieve the value of a record.</div>
|
|
316
|
+
</td>
|
|
317
|
+
</tr>
|
|
318
|
+
<tr class="rowColor">
|
|
319
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
320
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#clear()">clear</a></strong>()</code>
|
|
321
|
+
<div class="block">Remove all records.</div>
|
|
322
|
+
</td>
|
|
323
|
+
</tr>
|
|
324
|
+
<tr class="altColor">
|
|
325
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
326
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#close()">close</a></strong>()</code>
|
|
327
|
+
<div class="block">Close the database file.</div>
|
|
328
|
+
</td>
|
|
329
|
+
</tr>
|
|
330
|
+
<tr class="rowColor">
|
|
331
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
332
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#copy(java.lang.String)">copy</a></strong>(String dest)</code>
|
|
333
|
+
<div class="block">Create a copy of the database file.</div>
|
|
334
|
+
</td>
|
|
335
|
+
</tr>
|
|
336
|
+
<tr class="altColor">
|
|
337
|
+
<td class="colFirst"><code>long</code></td>
|
|
338
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#count()">count</a></strong>()</code>
|
|
339
|
+
<div class="block">Get the number of records.</div>
|
|
340
|
+
</td>
|
|
341
|
+
</tr>
|
|
342
|
+
<tr class="rowColor">
|
|
343
|
+
<td class="colFirst"><code><a href="../kyotocabinet/Cursor.html" title="class in kyotocabinet">Cursor</a></code></td>
|
|
344
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#cursor()">cursor</a></strong>()</code>
|
|
345
|
+
<div class="block">Create a cursor object.</div>
|
|
346
|
+
</td>
|
|
347
|
+
</tr>
|
|
348
|
+
<tr class="altColor">
|
|
349
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
350
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#dump_snapshot(java.lang.String)">dump_snapshot</a></strong>(String dest)</code>
|
|
351
|
+
<div class="block">Dump records into a snapshot file.</div>
|
|
352
|
+
</td>
|
|
353
|
+
</tr>
|
|
354
|
+
<tr class="rowColor">
|
|
355
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
356
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#end_transaction(boolean)">end_transaction</a></strong>(boolean commit)</code>
|
|
357
|
+
<div class="block">End transaction.</div>
|
|
358
|
+
</td>
|
|
359
|
+
</tr>
|
|
360
|
+
<tr class="altColor">
|
|
361
|
+
<td class="colFirst"><code><a href="../kyotocabinet/Error.html" title="class in kyotocabinet">Error</a></code></td>
|
|
362
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#error()">error</a></strong>()</code>
|
|
363
|
+
<div class="block">Get the last happened error.</div>
|
|
364
|
+
</td>
|
|
365
|
+
</tr>
|
|
366
|
+
<tr class="rowColor">
|
|
367
|
+
<td class="colFirst"><code>protected void</code></td>
|
|
368
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#finalize()">finalize</a></strong>()</code>
|
|
369
|
+
<div class="block">Release resources.</div>
|
|
370
|
+
</td>
|
|
371
|
+
</tr>
|
|
372
|
+
<tr class="altColor">
|
|
373
|
+
<td class="colFirst"><code>byte[][]</code></td>
|
|
374
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#get_bulk(byte[][], boolean)">get_bulk</a></strong>(byte[][] keys,
|
|
375
|
+
boolean atomic)</code>
|
|
376
|
+
<div class="block">Retrieve records at once.</div>
|
|
377
|
+
</td>
|
|
378
|
+
</tr>
|
|
379
|
+
<tr class="rowColor">
|
|
380
|
+
<td class="colFirst"><code>Map<String,String></code></td>
|
|
381
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#get_bulk(java.util.List, boolean)">get_bulk</a></strong>(List<String> keys,
|
|
382
|
+
boolean atomic)</code>
|
|
383
|
+
<div class="block">Retrieve records at once.</div>
|
|
384
|
+
</td>
|
|
385
|
+
</tr>
|
|
386
|
+
<tr class="altColor">
|
|
387
|
+
<td class="colFirst"><code>byte[]</code></td>
|
|
388
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#get(byte[])">get</a></strong>(byte[] key)</code>
|
|
389
|
+
<div class="block">Retrieve the value of a record.</div>
|
|
390
|
+
</td>
|
|
391
|
+
</tr>
|
|
392
|
+
<tr class="rowColor">
|
|
393
|
+
<td class="colFirst"><code>String</code></td>
|
|
394
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#get(java.lang.String)">get</a></strong>(String key)</code>
|
|
395
|
+
<div class="block">Retrieve the value of a record.</div>
|
|
396
|
+
</td>
|
|
397
|
+
</tr>
|
|
398
|
+
<tr class="altColor">
|
|
399
|
+
<td class="colFirst"><code>double</code></td>
|
|
400
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#increment_double(byte[], double, double)">increment_double</a></strong>(byte[] key,
|
|
401
|
+
double num,
|
|
402
|
+
double orig)</code>
|
|
403
|
+
<div class="block">Add a number to the numeric double value of a record.</div>
|
|
404
|
+
</td>
|
|
405
|
+
</tr>
|
|
406
|
+
<tr class="rowColor">
|
|
407
|
+
<td class="colFirst"><code>double</code></td>
|
|
408
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#increment_double(java.lang.String, double, double)">increment_double</a></strong>(String key,
|
|
409
|
+
double num,
|
|
410
|
+
double orig)</code>
|
|
411
|
+
<div class="block">Add a number to the numeric double value of a record.</div>
|
|
412
|
+
</td>
|
|
413
|
+
</tr>
|
|
414
|
+
<tr class="altColor">
|
|
415
|
+
<td class="colFirst"><code>long</code></td>
|
|
416
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#increment(byte[], long, long)">increment</a></strong>(byte[] key,
|
|
417
|
+
long num,
|
|
418
|
+
long orig)</code>
|
|
419
|
+
<div class="block">Add a number to the numeric integer value of a record.</div>
|
|
420
|
+
</td>
|
|
421
|
+
</tr>
|
|
422
|
+
<tr class="rowColor">
|
|
423
|
+
<td class="colFirst"><code>long</code></td>
|
|
424
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#increment(java.lang.String, long, long)">increment</a></strong>(String key,
|
|
425
|
+
long num,
|
|
426
|
+
long orig)</code>
|
|
427
|
+
<div class="block">Add a number to the numeric integer value of a record.</div>
|
|
428
|
+
</td>
|
|
429
|
+
</tr>
|
|
430
|
+
<tr class="altColor">
|
|
431
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
432
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#iterate(kyotocabinet.Visitor, boolean)">iterate</a></strong>(<a href="../kyotocabinet/Visitor.html" title="interface in kyotocabinet">Visitor</a> visitor,
|
|
433
|
+
boolean writable)</code>
|
|
434
|
+
<div class="block">Iterate to accept a visitor for each record.</div>
|
|
435
|
+
</td>
|
|
436
|
+
</tr>
|
|
437
|
+
<tr class="rowColor">
|
|
438
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
439
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#load_snapshot(java.lang.String)">load_snapshot</a></strong>(String src)</code>
|
|
440
|
+
<div class="block">Load records from a snapshot file.</div>
|
|
441
|
+
</td>
|
|
442
|
+
</tr>
|
|
443
|
+
<tr class="altColor">
|
|
444
|
+
<td class="colFirst"><code>List<String></code></td>
|
|
445
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#match_prefix(java.lang.String, long)">match_prefix</a></strong>(String prefix,
|
|
446
|
+
long max)</code>
|
|
447
|
+
<div class="block">Get keys matching a prefix string.</div>
|
|
448
|
+
</td>
|
|
449
|
+
</tr>
|
|
450
|
+
<tr class="rowColor">
|
|
451
|
+
<td class="colFirst"><code>List<String></code></td>
|
|
452
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#match_regex(java.lang.String, long)">match_regex</a></strong>(String regex,
|
|
453
|
+
long max)</code>
|
|
454
|
+
<div class="block">Get keys matching a regular expression string.</div>
|
|
455
|
+
</td>
|
|
456
|
+
</tr>
|
|
457
|
+
<tr class="altColor">
|
|
458
|
+
<td class="colFirst"><code>List<String></code></td>
|
|
459
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#match_similar(java.lang.String, long, boolean, long)">match_similar</a></strong>(String origin,
|
|
460
|
+
long range,
|
|
461
|
+
boolean utf,
|
|
462
|
+
long max)</code>
|
|
463
|
+
<div class="block">Get keys similar to a string in terms of the levenshtein distance.</div>
|
|
464
|
+
</td>
|
|
465
|
+
</tr>
|
|
466
|
+
<tr class="rowColor">
|
|
467
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
468
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#merge(kyotocabinet.DB[], int)">merge</a></strong>(<a href="../kyotocabinet/DB.html" title="class in kyotocabinet">DB</a>[] srcary,
|
|
469
|
+
int mode)</code>
|
|
470
|
+
<div class="block">Merge records from other databases.</div>
|
|
471
|
+
</td>
|
|
472
|
+
</tr>
|
|
473
|
+
<tr class="altColor">
|
|
474
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
475
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#occupy(boolean, kyotocabinet.FileProcessor)">occupy</a></strong>(boolean writable,
|
|
476
|
+
<a href="../kyotocabinet/FileProcessor.html" title="interface in kyotocabinet">FileProcessor</a> proc)</code>
|
|
477
|
+
<div class="block">Occupy database by locking and do something meanwhile.</div>
|
|
478
|
+
</td>
|
|
479
|
+
</tr>
|
|
480
|
+
<tr class="rowColor">
|
|
481
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
482
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#open(java.lang.String, int)">open</a></strong>(String path,
|
|
483
|
+
int mode)</code>
|
|
484
|
+
<div class="block">Open a database file.</div>
|
|
485
|
+
</td>
|
|
486
|
+
</tr>
|
|
487
|
+
<tr class="altColor">
|
|
488
|
+
<td class="colFirst"><code>String</code></td>
|
|
489
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#path()">path</a></strong>()</code>
|
|
490
|
+
<div class="block">Get the path of the database file.</div>
|
|
491
|
+
</td>
|
|
492
|
+
</tr>
|
|
493
|
+
<tr class="rowColor">
|
|
494
|
+
<td class="colFirst"><code>long</code></td>
|
|
495
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#remove_bulk(byte[][], boolean)">remove_bulk</a></strong>(byte[][] keys,
|
|
496
|
+
boolean atomic)</code>
|
|
497
|
+
<div class="block">Remove records at once.</div>
|
|
498
|
+
</td>
|
|
499
|
+
</tr>
|
|
500
|
+
<tr class="altColor">
|
|
501
|
+
<td class="colFirst"><code>long</code></td>
|
|
502
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#remove_bulk(java.util.List, boolean)">remove_bulk</a></strong>(List<String> keys,
|
|
503
|
+
boolean atomic)</code>
|
|
504
|
+
<div class="block">Remove records at once.</div>
|
|
505
|
+
</td>
|
|
506
|
+
</tr>
|
|
507
|
+
<tr class="rowColor">
|
|
508
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
509
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#remove(byte[])">remove</a></strong>(byte[] key)</code>
|
|
510
|
+
<div class="block">Remove a record.</div>
|
|
511
|
+
</td>
|
|
512
|
+
</tr>
|
|
513
|
+
<tr class="altColor">
|
|
514
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
515
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#remove(java.lang.String)">remove</a></strong>(String key)</code> </td>
|
|
516
|
+
</tr>
|
|
517
|
+
<tr class="rowColor">
|
|
518
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
519
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#replace(byte[], byte[])">replace</a></strong>(byte[] key,
|
|
520
|
+
byte[] value)</code>
|
|
521
|
+
<div class="block">Replace the value of a record.</div>
|
|
522
|
+
</td>
|
|
523
|
+
</tr>
|
|
524
|
+
<tr class="altColor">
|
|
525
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
526
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#replace(java.lang.String, java.lang.String)">replace</a></strong>(String key,
|
|
527
|
+
String value)</code>
|
|
528
|
+
<div class="block">Replace the value of a record.</div>
|
|
529
|
+
</td>
|
|
530
|
+
</tr>
|
|
531
|
+
<tr class="rowColor">
|
|
532
|
+
<td class="colFirst"><code>byte[]</code></td>
|
|
533
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#seize(byte[])">seize</a></strong>(byte[] key)</code>
|
|
534
|
+
<div class="block">Retrieve the value of a record and remove it atomically.</div>
|
|
535
|
+
</td>
|
|
536
|
+
</tr>
|
|
537
|
+
<tr class="altColor">
|
|
538
|
+
<td class="colFirst"><code>String</code></td>
|
|
539
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#seize(java.lang.String)">seize</a></strong>(String key)</code>
|
|
540
|
+
<div class="block">Retrieve the value of a record and remove it atomically.</div>
|
|
541
|
+
</td>
|
|
542
|
+
</tr>
|
|
543
|
+
<tr class="rowColor">
|
|
544
|
+
<td class="colFirst"><code>long</code></td>
|
|
545
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#set_bulk(byte[][], boolean)">set_bulk</a></strong>(byte[][] recs,
|
|
546
|
+
boolean atomic)</code>
|
|
547
|
+
<div class="block">Store records at once.</div>
|
|
548
|
+
</td>
|
|
549
|
+
</tr>
|
|
550
|
+
<tr class="altColor">
|
|
551
|
+
<td class="colFirst"><code>long</code></td>
|
|
552
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#set_bulk(java.util.Map, boolean)">set_bulk</a></strong>(Map<String,String> recs,
|
|
553
|
+
boolean atomic)</code>
|
|
554
|
+
<div class="block">Store records at once.</div>
|
|
555
|
+
</td>
|
|
556
|
+
</tr>
|
|
557
|
+
<tr class="rowColor">
|
|
558
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
559
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#set(byte[], byte[])">set</a></strong>(byte[] key,
|
|
560
|
+
byte[] value)</code>
|
|
561
|
+
<div class="block">Set the value of a record.</div>
|
|
562
|
+
</td>
|
|
563
|
+
</tr>
|
|
564
|
+
<tr class="altColor">
|
|
565
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
566
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#set(java.lang.String, java.lang.String)">set</a></strong>(String key,
|
|
567
|
+
String value)</code>
|
|
568
|
+
<div class="block">Set the value of a record.</div>
|
|
569
|
+
</td>
|
|
570
|
+
</tr>
|
|
571
|
+
<tr class="rowColor">
|
|
572
|
+
<td class="colFirst"><code>long</code></td>
|
|
573
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#size()">size</a></strong>()</code>
|
|
574
|
+
<div class="block">Get the size of the database file.</div>
|
|
575
|
+
</td>
|
|
576
|
+
</tr>
|
|
577
|
+
<tr class="altColor">
|
|
578
|
+
<td class="colFirst"><code>Map<String,String></code></td>
|
|
579
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#status()">status</a></strong>()</code>
|
|
580
|
+
<div class="block">Get the miscellaneous status information.</div>
|
|
581
|
+
</td>
|
|
582
|
+
</tr>
|
|
583
|
+
<tr class="rowColor">
|
|
584
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
585
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#synchronize(boolean, kyotocabinet.FileProcessor)">synchronize</a></strong>(boolean hard,
|
|
586
|
+
<a href="../kyotocabinet/FileProcessor.html" title="interface in kyotocabinet">FileProcessor</a> proc)</code>
|
|
587
|
+
<div class="block">Synchronize updated contents with the file and the device.</div>
|
|
588
|
+
</td>
|
|
589
|
+
</tr>
|
|
590
|
+
<tr class="altColor">
|
|
591
|
+
<td class="colFirst"><code>String</code></td>
|
|
592
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#toString()">toString</a></strong>()</code>
|
|
593
|
+
<div class="block">Get the string expression.</div>
|
|
594
|
+
</td>
|
|
595
|
+
</tr>
|
|
596
|
+
<tr class="rowColor">
|
|
597
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
598
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#tune_encoding(java.lang.String)">tune_encoding</a></strong>(String encname)</code>
|
|
599
|
+
<div class="block">Set the encoding of external strings.</div>
|
|
600
|
+
</td>
|
|
601
|
+
</tr>
|
|
602
|
+
<tr class="altColor">
|
|
603
|
+
<td class="colFirst"><code>boolean</code></td>
|
|
604
|
+
<td class="colLast"><code><strong><a href="../kyotocabinet/DB.html#tune_exception_rule(int[])">tune_exception_rule</a></strong>(int[] codes)</code>
|
|
605
|
+
<div class="block">Set the rule about throwing exception.</div>
|
|
606
|
+
</td>
|
|
607
|
+
</tr>
|
|
608
|
+
</table>
|
|
609
|
+
<ul class="blockList">
|
|
610
|
+
<li class="blockList"><a name="methods_inherited_from_class_Object">
|
|
611
|
+
<!-- -->
|
|
612
|
+
</a>
|
|
613
|
+
<h3>Methods inherited from class Object</h3>
|
|
614
|
+
<code>clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
|
|
615
|
+
</ul>
|
|
616
|
+
</li>
|
|
617
|
+
</ul>
|
|
618
|
+
</li>
|
|
619
|
+
</ul>
|
|
620
|
+
</div>
|
|
621
|
+
<div class="details">
|
|
622
|
+
<ul class="blockList">
|
|
623
|
+
<li class="blockList">
|
|
624
|
+
<!-- ============ FIELD DETAIL =========== -->
|
|
625
|
+
<ul class="blockList">
|
|
626
|
+
<li class="blockList"><a name="field_detail">
|
|
627
|
+
<!-- -->
|
|
628
|
+
</a>
|
|
629
|
+
<h3>Field Detail</h3>
|
|
630
|
+
<a name="GEXCEPTIONAL">
|
|
631
|
+
<!-- -->
|
|
632
|
+
</a>
|
|
633
|
+
<ul class="blockList">
|
|
634
|
+
<li class="blockList">
|
|
635
|
+
<h4>GEXCEPTIONAL</h4>
|
|
636
|
+
<pre>public static final int GEXCEPTIONAL</pre>
|
|
637
|
+
<div class="block">generic mode: exceptional mode</div>
|
|
638
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.GEXCEPTIONAL">Constant Field Values</a></dd></dl>
|
|
639
|
+
</li>
|
|
640
|
+
</ul>
|
|
641
|
+
<a name="MADD">
|
|
642
|
+
<!-- -->
|
|
643
|
+
</a>
|
|
644
|
+
<ul class="blockList">
|
|
645
|
+
<li class="blockList">
|
|
646
|
+
<h4>MADD</h4>
|
|
647
|
+
<pre>public static final int MADD</pre>
|
|
648
|
+
<div class="block">merge mode: keep the existing value</div>
|
|
649
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.MADD">Constant Field Values</a></dd></dl>
|
|
650
|
+
</li>
|
|
651
|
+
</ul>
|
|
652
|
+
<a name="MAPPEND">
|
|
653
|
+
<!-- -->
|
|
654
|
+
</a>
|
|
655
|
+
<ul class="blockList">
|
|
656
|
+
<li class="blockList">
|
|
657
|
+
<h4>MAPPEND</h4>
|
|
658
|
+
<pre>public static final int MAPPEND</pre>
|
|
659
|
+
<div class="block">merge mode: append the new value</div>
|
|
660
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.MAPPEND">Constant Field Values</a></dd></dl>
|
|
661
|
+
</li>
|
|
662
|
+
</ul>
|
|
663
|
+
<a name="MREPLACE">
|
|
664
|
+
<!-- -->
|
|
665
|
+
</a>
|
|
666
|
+
<ul class="blockList">
|
|
667
|
+
<li class="blockList">
|
|
668
|
+
<h4>MREPLACE</h4>
|
|
669
|
+
<pre>public static final int MREPLACE</pre>
|
|
670
|
+
<div class="block">merge mode: modify the existing record only</div>
|
|
671
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.MREPLACE">Constant Field Values</a></dd></dl>
|
|
672
|
+
</li>
|
|
673
|
+
</ul>
|
|
674
|
+
<a name="MSET">
|
|
675
|
+
<!-- -->
|
|
676
|
+
</a>
|
|
677
|
+
<ul class="blockList">
|
|
678
|
+
<li class="blockList">
|
|
679
|
+
<h4>MSET</h4>
|
|
680
|
+
<pre>public static final int MSET</pre>
|
|
681
|
+
<div class="block">merge mode: overwrite the existing value</div>
|
|
682
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.MSET">Constant Field Values</a></dd></dl>
|
|
683
|
+
</li>
|
|
684
|
+
</ul>
|
|
685
|
+
<a name="OAUTOSYNC">
|
|
686
|
+
<!-- -->
|
|
687
|
+
</a>
|
|
688
|
+
<ul class="blockList">
|
|
689
|
+
<li class="blockList">
|
|
690
|
+
<h4>OAUTOSYNC</h4>
|
|
691
|
+
<pre>public static final int OAUTOSYNC</pre>
|
|
692
|
+
<div class="block">open mode: auto synchronization</div>
|
|
693
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OAUTOSYNC">Constant Field Values</a></dd></dl>
|
|
694
|
+
</li>
|
|
695
|
+
</ul>
|
|
696
|
+
<a name="OAUTOTRAN">
|
|
697
|
+
<!-- -->
|
|
698
|
+
</a>
|
|
699
|
+
<ul class="blockList">
|
|
700
|
+
<li class="blockList">
|
|
701
|
+
<h4>OAUTOTRAN</h4>
|
|
702
|
+
<pre>public static final int OAUTOTRAN</pre>
|
|
703
|
+
<div class="block">open mode: auto transaction</div>
|
|
704
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OAUTOTRAN">Constant Field Values</a></dd></dl>
|
|
705
|
+
</li>
|
|
706
|
+
</ul>
|
|
707
|
+
<a name="OCREATE">
|
|
708
|
+
<!-- -->
|
|
709
|
+
</a>
|
|
710
|
+
<ul class="blockList">
|
|
711
|
+
<li class="blockList">
|
|
712
|
+
<h4>OCREATE</h4>
|
|
713
|
+
<pre>public static final int OCREATE</pre>
|
|
714
|
+
<div class="block">open mode: writer creating</div>
|
|
715
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OCREATE">Constant Field Values</a></dd></dl>
|
|
716
|
+
</li>
|
|
717
|
+
</ul>
|
|
718
|
+
<a name="ONOLOCK">
|
|
719
|
+
<!-- -->
|
|
720
|
+
</a>
|
|
721
|
+
<ul class="blockList">
|
|
722
|
+
<li class="blockList">
|
|
723
|
+
<h4>ONOLOCK</h4>
|
|
724
|
+
<pre>public static final int ONOLOCK</pre>
|
|
725
|
+
<div class="block">open mode: open without locking</div>
|
|
726
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.ONOLOCK">Constant Field Values</a></dd></dl>
|
|
727
|
+
</li>
|
|
728
|
+
</ul>
|
|
729
|
+
<a name="ONOREPAIR">
|
|
730
|
+
<!-- -->
|
|
731
|
+
</a>
|
|
732
|
+
<ul class="blockList">
|
|
733
|
+
<li class="blockList">
|
|
734
|
+
<h4>ONOREPAIR</h4>
|
|
735
|
+
<pre>public static final int ONOREPAIR</pre>
|
|
736
|
+
<div class="block">open mode: open without auto repair</div>
|
|
737
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.ONOREPAIR">Constant Field Values</a></dd></dl>
|
|
738
|
+
</li>
|
|
739
|
+
</ul>
|
|
740
|
+
<a name="OREADER">
|
|
741
|
+
<!-- -->
|
|
742
|
+
</a>
|
|
743
|
+
<ul class="blockList">
|
|
744
|
+
<li class="blockList">
|
|
745
|
+
<h4>OREADER</h4>
|
|
746
|
+
<pre>public static final int OREADER</pre>
|
|
747
|
+
<div class="block">open mode: open as a reader</div>
|
|
748
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OREADER">Constant Field Values</a></dd></dl>
|
|
749
|
+
</li>
|
|
750
|
+
</ul>
|
|
751
|
+
<a name="OTRUNCATE">
|
|
752
|
+
<!-- -->
|
|
753
|
+
</a>
|
|
754
|
+
<ul class="blockList">
|
|
755
|
+
<li class="blockList">
|
|
756
|
+
<h4>OTRUNCATE</h4>
|
|
757
|
+
<pre>public static final int OTRUNCATE</pre>
|
|
758
|
+
<div class="block">open mode: writer truncating</div>
|
|
759
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OTRUNCATE">Constant Field Values</a></dd></dl>
|
|
760
|
+
</li>
|
|
761
|
+
</ul>
|
|
762
|
+
<a name="OTRYLOCK">
|
|
763
|
+
<!-- -->
|
|
764
|
+
</a>
|
|
765
|
+
<ul class="blockList">
|
|
766
|
+
<li class="blockList">
|
|
767
|
+
<h4>OTRYLOCK</h4>
|
|
768
|
+
<pre>public static final int OTRYLOCK</pre>
|
|
769
|
+
<div class="block">open mode: lock without blocking</div>
|
|
770
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OTRYLOCK">Constant Field Values</a></dd></dl>
|
|
771
|
+
</li>
|
|
772
|
+
</ul>
|
|
773
|
+
<a name="OWRITER">
|
|
774
|
+
<!-- -->
|
|
775
|
+
</a>
|
|
776
|
+
<ul class="blockListLast">
|
|
777
|
+
<li class="blockList">
|
|
778
|
+
<h4>OWRITER</h4>
|
|
779
|
+
<pre>public static final int OWRITER</pre>
|
|
780
|
+
<div class="block">open mode: open as a writer</div>
|
|
781
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../constant-values.html#kyotocabinet.DB.OWRITER">Constant Field Values</a></dd></dl>
|
|
782
|
+
</li>
|
|
783
|
+
</ul>
|
|
784
|
+
</li>
|
|
785
|
+
</ul>
|
|
786
|
+
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
787
|
+
<ul class="blockList">
|
|
788
|
+
<li class="blockList"><a name="constructor_detail">
|
|
789
|
+
<!-- -->
|
|
790
|
+
</a>
|
|
791
|
+
<h3>Constructor Detail</h3>
|
|
792
|
+
<a name="DB()">
|
|
793
|
+
<!-- -->
|
|
794
|
+
</a>
|
|
795
|
+
<ul class="blockList">
|
|
796
|
+
<li class="blockList">
|
|
797
|
+
<h4>DB</h4>
|
|
798
|
+
<pre>public DB()</pre>
|
|
799
|
+
<div class="block">Create an instance.</div>
|
|
800
|
+
</li>
|
|
801
|
+
</ul>
|
|
802
|
+
<a name="DB(int)">
|
|
803
|
+
<!-- -->
|
|
804
|
+
</a>
|
|
805
|
+
<ul class="blockListLast">
|
|
806
|
+
<li class="blockList">
|
|
807
|
+
<h4>DB</h4>
|
|
808
|
+
<pre>public DB(int opts)</pre>
|
|
809
|
+
<div class="block">Create an instance with options.</div>
|
|
810
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>opts</code> - the optional features by bitwise-or: DB.GEXCEPTIONAL for the exceptional mode.</dd><dt><span class="strong">Note:</span></dt>
|
|
811
|
+
<dd>The exceptional mode means that fatal errors caused by methods are reported by
|
|
812
|
+
exceptions thrown.</dd></dl>
|
|
813
|
+
</li>
|
|
814
|
+
</ul>
|
|
815
|
+
</li>
|
|
816
|
+
</ul>
|
|
817
|
+
<!-- ============ METHOD DETAIL ========== -->
|
|
818
|
+
<ul class="blockList">
|
|
819
|
+
<li class="blockList"><a name="method_detail">
|
|
820
|
+
<!-- -->
|
|
821
|
+
</a>
|
|
822
|
+
<h3>Method Detail</h3>
|
|
823
|
+
<a name="accept_bulk(byte[][], kyotocabinet.Visitor, boolean)">
|
|
824
|
+
<!-- -->
|
|
825
|
+
</a>
|
|
826
|
+
<ul class="blockList">
|
|
827
|
+
<li class="blockList">
|
|
828
|
+
<h4>accept_bulk</h4>
|
|
829
|
+
<pre>public boolean accept_bulk(byte[][] keys,
|
|
830
|
+
<a href="../kyotocabinet/Visitor.html" title="interface in kyotocabinet">Visitor</a> visitor,
|
|
831
|
+
boolean writable)</pre>
|
|
832
|
+
<div class="block">Accept a visitor to multiple records at once.</div>
|
|
833
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - specifies an array of the keys.</dd><dd><code>visitor</code> - a visitor object.</dd><dd><code>writable</code> - true for writable operation, or false for read-only operation.</dd>
|
|
834
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
835
|
+
<dd>The operations for specified records are performed atomically and other threads
|
|
836
|
+
accessing the same records are blocked. To avoid deadlock, any explicit database operation
|
|
837
|
+
must not be performed in this method.</dd></dl>
|
|
838
|
+
</li>
|
|
839
|
+
</ul>
|
|
840
|
+
<a name="accept(byte[], kyotocabinet.Visitor, boolean)">
|
|
841
|
+
<!-- -->
|
|
842
|
+
</a>
|
|
843
|
+
<ul class="blockList">
|
|
844
|
+
<li class="blockList">
|
|
845
|
+
<h4>accept</h4>
|
|
846
|
+
<pre>public boolean accept(byte[] key,
|
|
847
|
+
<a href="../kyotocabinet/Visitor.html" title="interface in kyotocabinet">Visitor</a> visitor,
|
|
848
|
+
boolean writable)</pre>
|
|
849
|
+
<div class="block">Accept a visitor to a record.</div>
|
|
850
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>visitor</code> - a visitor object which implements the Visitor interface.</dd><dd><code>writable</code> - true for writable operation, or false for read-only operation.</dd>
|
|
851
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
852
|
+
<dd>The operation for each record is performed atomically and other threads accessing the
|
|
853
|
+
same record are blocked. To avoid deadlock, any explicit database operation must not be
|
|
854
|
+
performed in this method.</dd></dl>
|
|
855
|
+
</li>
|
|
856
|
+
</ul>
|
|
857
|
+
<a name="add(byte[], byte[])">
|
|
858
|
+
<!-- -->
|
|
859
|
+
</a>
|
|
860
|
+
<ul class="blockList">
|
|
861
|
+
<li class="blockList">
|
|
862
|
+
<h4>add</h4>
|
|
863
|
+
<pre>public boolean add(byte[] key,
|
|
864
|
+
byte[] value)</pre>
|
|
865
|
+
<div class="block">Add a record.</div>
|
|
866
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>value</code> - the value.</dd>
|
|
867
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
868
|
+
<dd>If no record corresponds to the key, a new record is created. If the corresponding
|
|
869
|
+
record exists, the record is not modified and false is returned.</dd></dl>
|
|
870
|
+
</li>
|
|
871
|
+
</ul>
|
|
872
|
+
<a name="add(java.lang.String, java.lang.String)">
|
|
873
|
+
<!-- -->
|
|
874
|
+
</a>
|
|
875
|
+
<ul class="blockList">
|
|
876
|
+
<li class="blockList">
|
|
877
|
+
<h4>add</h4>
|
|
878
|
+
<pre>public boolean add(String key,
|
|
879
|
+
String value)</pre>
|
|
880
|
+
<div class="block">Add a record.</div>
|
|
881
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#add(byte[], byte[])"><code>add(byte[], byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
882
|
+
<dd>Equal to the original DB.add method except that the parameters are String.</dd></dl>
|
|
883
|
+
</li>
|
|
884
|
+
</ul>
|
|
885
|
+
<a name="append(byte[], byte[])">
|
|
886
|
+
<!-- -->
|
|
887
|
+
</a>
|
|
888
|
+
<ul class="blockList">
|
|
889
|
+
<li class="blockList">
|
|
890
|
+
<h4>append</h4>
|
|
891
|
+
<pre>public boolean append(byte[] key,
|
|
892
|
+
byte[] value)</pre>
|
|
893
|
+
<div class="block">Append the value of a record.</div>
|
|
894
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>value</code> - the value.</dd>
|
|
895
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
896
|
+
<dd>If no record corresponds to the key, a new record is created. If the corresponding
|
|
897
|
+
record exists, the given value is appended at the end of the existing value.</dd></dl>
|
|
898
|
+
</li>
|
|
899
|
+
</ul>
|
|
900
|
+
<a name="append(java.lang.String, java.lang.String)">
|
|
901
|
+
<!-- -->
|
|
902
|
+
</a>
|
|
903
|
+
<ul class="blockList">
|
|
904
|
+
<li class="blockList">
|
|
905
|
+
<h4>append</h4>
|
|
906
|
+
<pre>public boolean append(String key,
|
|
907
|
+
String value)</pre>
|
|
908
|
+
<div class="block">Append the value of a record.</div>
|
|
909
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#append(byte[], byte[])"><code>append(byte[], byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
910
|
+
<dd>Equal to the original DB.append method except that the parameters are String.</dd></dl>
|
|
911
|
+
</li>
|
|
912
|
+
</ul>
|
|
913
|
+
<a name="begin_transaction(boolean)">
|
|
914
|
+
<!-- -->
|
|
915
|
+
</a>
|
|
916
|
+
<ul class="blockList">
|
|
917
|
+
<li class="blockList">
|
|
918
|
+
<h4>begin_transaction</h4>
|
|
919
|
+
<pre>public boolean begin_transaction(boolean hard)</pre>
|
|
920
|
+
<div class="block">Begin transaction.</div>
|
|
921
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hard</code> - true for physical synchronization with the device, or false for logical
|
|
922
|
+
synchronization with the file system.</dd>
|
|
923
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
924
|
+
</li>
|
|
925
|
+
</ul>
|
|
926
|
+
<a name="cas(byte[], byte[], byte[])">
|
|
927
|
+
<!-- -->
|
|
928
|
+
</a>
|
|
929
|
+
<ul class="blockList">
|
|
930
|
+
<li class="blockList">
|
|
931
|
+
<h4>cas</h4>
|
|
932
|
+
<pre>public boolean cas(byte[] key,
|
|
933
|
+
byte[] oval,
|
|
934
|
+
byte[] nval)</pre>
|
|
935
|
+
<div class="block">Perform compare-and-swap.</div>
|
|
936
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>oval</code> - the old value. null means that no record corresponds.</dd><dd><code>nval</code> - the new value. null means that the record is removed.</dd>
|
|
937
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
938
|
+
</li>
|
|
939
|
+
</ul>
|
|
940
|
+
<a name="cas(java.lang.String, java.lang.String, java.lang.String)">
|
|
941
|
+
<!-- -->
|
|
942
|
+
</a>
|
|
943
|
+
<ul class="blockList">
|
|
944
|
+
<li class="blockList">
|
|
945
|
+
<h4>cas</h4>
|
|
946
|
+
<pre>public boolean cas(String key,
|
|
947
|
+
String oval,
|
|
948
|
+
String nval)</pre>
|
|
949
|
+
<div class="block">Perform compare-and-swap.</div>
|
|
950
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#cas(byte[], byte[], byte[])"><code>cas(byte[], byte[], byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
951
|
+
<dd>Equal to the original DB.cas method except that the parameters are String.</dd></dl>
|
|
952
|
+
</li>
|
|
953
|
+
</ul>
|
|
954
|
+
<a name="check(byte[])">
|
|
955
|
+
<!-- -->
|
|
956
|
+
</a>
|
|
957
|
+
<ul class="blockList">
|
|
958
|
+
<li class="blockList">
|
|
959
|
+
<h4>check</h4>
|
|
960
|
+
<pre>public int check(byte[] key)</pre>
|
|
961
|
+
<div class="block">Check the existence of a record.</div>
|
|
962
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd>
|
|
963
|
+
<dt><span class="strong">Returns:</span></dt><dd>the size of the value, or -1 on failure.</dd></dl>
|
|
964
|
+
</li>
|
|
965
|
+
</ul>
|
|
966
|
+
<a name="check(java.lang.String)">
|
|
967
|
+
<!-- -->
|
|
968
|
+
</a>
|
|
969
|
+
<ul class="blockList">
|
|
970
|
+
<li class="blockList">
|
|
971
|
+
<h4>check</h4>
|
|
972
|
+
<pre>public int check(String key)</pre>
|
|
973
|
+
<div class="block">Retrieve the value of a record.</div>
|
|
974
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#check(byte[])"><code>check(byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
975
|
+
<dd>Equal to the original DB.check method except that the parameter is String.</dd></dl>
|
|
976
|
+
</li>
|
|
977
|
+
</ul>
|
|
978
|
+
<a name="clear()">
|
|
979
|
+
<!-- -->
|
|
980
|
+
</a>
|
|
981
|
+
<ul class="blockList">
|
|
982
|
+
<li class="blockList">
|
|
983
|
+
<h4>clear</h4>
|
|
984
|
+
<pre>public boolean clear()</pre>
|
|
985
|
+
<div class="block">Remove all records.</div>
|
|
986
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
987
|
+
</li>
|
|
988
|
+
</ul>
|
|
989
|
+
<a name="close()">
|
|
990
|
+
<!-- -->
|
|
991
|
+
</a>
|
|
992
|
+
<ul class="blockList">
|
|
993
|
+
<li class="blockList">
|
|
994
|
+
<h4>close</h4>
|
|
995
|
+
<pre>public boolean close()</pre>
|
|
996
|
+
<div class="block">Close the database file.</div>
|
|
997
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
998
|
+
</li>
|
|
999
|
+
</ul>
|
|
1000
|
+
<a name="copy(java.lang.String)">
|
|
1001
|
+
<!-- -->
|
|
1002
|
+
</a>
|
|
1003
|
+
<ul class="blockList">
|
|
1004
|
+
<li class="blockList">
|
|
1005
|
+
<h4>copy</h4>
|
|
1006
|
+
<pre>public boolean copy(String dest)</pre>
|
|
1007
|
+
<div class="block">Create a copy of the database file.</div>
|
|
1008
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - the path of the destination file.</dd>
|
|
1009
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
1010
|
+
</li>
|
|
1011
|
+
</ul>
|
|
1012
|
+
<a name="count()">
|
|
1013
|
+
<!-- -->
|
|
1014
|
+
</a>
|
|
1015
|
+
<ul class="blockList">
|
|
1016
|
+
<li class="blockList">
|
|
1017
|
+
<h4>count</h4>
|
|
1018
|
+
<pre>public long count()</pre>
|
|
1019
|
+
<div class="block">Get the number of records.</div>
|
|
1020
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of records, or -1 on failure.</dd></dl>
|
|
1021
|
+
</li>
|
|
1022
|
+
</ul>
|
|
1023
|
+
<a name="cursor()">
|
|
1024
|
+
<!-- -->
|
|
1025
|
+
</a>
|
|
1026
|
+
<ul class="blockList">
|
|
1027
|
+
<li class="blockList">
|
|
1028
|
+
<h4>cursor</h4>
|
|
1029
|
+
<pre>public <a href="../kyotocabinet/Cursor.html" title="class in kyotocabinet">Cursor</a> cursor()</pre>
|
|
1030
|
+
<div class="block">Create a cursor object.</div>
|
|
1031
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>the return value is the created cursor object. Each cursor should be disabled
|
|
1032
|
+
with the Cursor#disable method when it is no longer in use.</dd></dl>
|
|
1033
|
+
</li>
|
|
1034
|
+
</ul>
|
|
1035
|
+
<a name="dump_snapshot(java.lang.String)">
|
|
1036
|
+
<!-- -->
|
|
1037
|
+
</a>
|
|
1038
|
+
<ul class="blockList">
|
|
1039
|
+
<li class="blockList">
|
|
1040
|
+
<h4>dump_snapshot</h4>
|
|
1041
|
+
<pre>public boolean dump_snapshot(String dest)</pre>
|
|
1042
|
+
<div class="block">Dump records into a snapshot file.</div>
|
|
1043
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - the name of the destination file.</dd>
|
|
1044
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
1045
|
+
</li>
|
|
1046
|
+
</ul>
|
|
1047
|
+
<a name="end_transaction(boolean)">
|
|
1048
|
+
<!-- -->
|
|
1049
|
+
</a>
|
|
1050
|
+
<ul class="blockList">
|
|
1051
|
+
<li class="blockList">
|
|
1052
|
+
<h4>end_transaction</h4>
|
|
1053
|
+
<pre>public boolean end_transaction(boolean commit)</pre>
|
|
1054
|
+
<div class="block">End transaction.</div>
|
|
1055
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>commit</code> - true to commit the transaction, or false to abort the transaction.</dd>
|
|
1056
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
1057
|
+
</li>
|
|
1058
|
+
</ul>
|
|
1059
|
+
<a name="error()">
|
|
1060
|
+
<!-- -->
|
|
1061
|
+
</a>
|
|
1062
|
+
<ul class="blockList">
|
|
1063
|
+
<li class="blockList">
|
|
1064
|
+
<h4>error</h4>
|
|
1065
|
+
<pre>public <a href="../kyotocabinet/Error.html" title="class in kyotocabinet">Error</a> error()</pre>
|
|
1066
|
+
<div class="block">Get the last happened error.</div>
|
|
1067
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>the last happened error.</dd></dl>
|
|
1068
|
+
</li>
|
|
1069
|
+
</ul>
|
|
1070
|
+
<a name="finalize()">
|
|
1071
|
+
<!-- -->
|
|
1072
|
+
</a>
|
|
1073
|
+
<ul class="blockList">
|
|
1074
|
+
<li class="blockList">
|
|
1075
|
+
<h4>finalize</h4>
|
|
1076
|
+
<pre>protected void finalize()</pre>
|
|
1077
|
+
<div class="block">Release resources.</div>
|
|
1078
|
+
<dl>
|
|
1079
|
+
<dt><strong>Overrides:</strong></dt>
|
|
1080
|
+
<dd><code>finalize</code> in class <code>Object</code></dd>
|
|
1081
|
+
</dl>
|
|
1082
|
+
</li>
|
|
1083
|
+
</ul>
|
|
1084
|
+
<a name="get_bulk(byte[][], boolean)">
|
|
1085
|
+
<!-- -->
|
|
1086
|
+
</a>
|
|
1087
|
+
<ul class="blockList">
|
|
1088
|
+
<li class="blockList">
|
|
1089
|
+
<h4>get_bulk</h4>
|
|
1090
|
+
<pre>public byte[][] get_bulk(byte[][] keys,
|
|
1091
|
+
boolean atomic)</pre>
|
|
1092
|
+
<div class="block">Retrieve records at once.</div>
|
|
1093
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - the keys of the records to retrieve.</dd><dd><code>atomic</code> - true to perform all operations atomically, or false for non-atomic operations.</dd>
|
|
1094
|
+
<dt><span class="strong">Returns:</span></dt><dd>an array of retrieved records, or null on failure. Each key and each value is
|
|
1095
|
+
placed alternately.</dd></dl>
|
|
1096
|
+
</li>
|
|
1097
|
+
</ul>
|
|
1098
|
+
<a name="get_bulk(java.util.List, boolean)">
|
|
1099
|
+
<!-- -->
|
|
1100
|
+
</a>
|
|
1101
|
+
<ul class="blockList">
|
|
1102
|
+
<li class="blockList">
|
|
1103
|
+
<h4>get_bulk</h4>
|
|
1104
|
+
<pre>public Map<String,String> get_bulk(List<String> keys,
|
|
1105
|
+
boolean atomic)</pre>
|
|
1106
|
+
<div class="block">Retrieve records at once.</div>
|
|
1107
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#get_bulk(byte[][], boolean)"><code>get_bulk(byte[][], boolean)</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1108
|
+
<dd>Equal to the original DB.get_bulk method except that the parameter is List and the
|
|
1109
|
+
return value is Map.</dd></dl>
|
|
1110
|
+
</li>
|
|
1111
|
+
</ul>
|
|
1112
|
+
<a name="get(byte[])">
|
|
1113
|
+
<!-- -->
|
|
1114
|
+
</a>
|
|
1115
|
+
<ul class="blockList">
|
|
1116
|
+
<li class="blockList">
|
|
1117
|
+
<h4>get</h4>
|
|
1118
|
+
<pre>public byte[] get(byte[] key)</pre>
|
|
1119
|
+
<div class="block">Retrieve the value of a record.</div>
|
|
1120
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd>
|
|
1121
|
+
<dt><span class="strong">Returns:</span></dt><dd>the value of the corresponding record, or null on failure.</dd></dl>
|
|
1122
|
+
</li>
|
|
1123
|
+
</ul>
|
|
1124
|
+
<a name="get(java.lang.String)">
|
|
1125
|
+
<!-- -->
|
|
1126
|
+
</a>
|
|
1127
|
+
<ul class="blockList">
|
|
1128
|
+
<li class="blockList">
|
|
1129
|
+
<h4>get</h4>
|
|
1130
|
+
<pre>public String get(String key)</pre>
|
|
1131
|
+
<div class="block">Retrieve the value of a record.</div>
|
|
1132
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#get(byte[])"><code>get(byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1133
|
+
<dd>Equal to the original DB.get method except that the parameter and the return value
|
|
1134
|
+
are String.</dd></dl>
|
|
1135
|
+
</li>
|
|
1136
|
+
</ul>
|
|
1137
|
+
<a name="increment_double(byte[], double, double)">
|
|
1138
|
+
<!-- -->
|
|
1139
|
+
</a>
|
|
1140
|
+
<ul class="blockList">
|
|
1141
|
+
<li class="blockList">
|
|
1142
|
+
<h4>increment_double</h4>
|
|
1143
|
+
<pre>public double increment_double(byte[] key,
|
|
1144
|
+
double num,
|
|
1145
|
+
double orig)</pre>
|
|
1146
|
+
<div class="block">Add a number to the numeric double value of a record.</div>
|
|
1147
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>num</code> - the additional number.</dd><dd><code>orig</code> - the origin number if no record corresponds to the key. If it is negative
|
|
1148
|
+
infinity and no record corresponds, this method fails. If it is positive infinity, the
|
|
1149
|
+
value is set as the additional number regardless of the current value.</dd>
|
|
1150
|
+
<dt><span class="strong">Returns:</span></dt><dd>the result value, or Not-a-number on failure.</dd></dl>
|
|
1151
|
+
</li>
|
|
1152
|
+
</ul>
|
|
1153
|
+
<a name="increment_double(java.lang.String, double, double)">
|
|
1154
|
+
<!-- -->
|
|
1155
|
+
</a>
|
|
1156
|
+
<ul class="blockList">
|
|
1157
|
+
<li class="blockList">
|
|
1158
|
+
<h4>increment_double</h4>
|
|
1159
|
+
<pre>public double increment_double(String key,
|
|
1160
|
+
double num,
|
|
1161
|
+
double orig)</pre>
|
|
1162
|
+
<div class="block">Add a number to the numeric double value of a record.</div>
|
|
1163
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#increment_double(byte[], double, double)"><code>increment_double(byte[], double, double)</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1164
|
+
<dd>Equal to the original DB.increment method except that the parameter is String.</dd></dl>
|
|
1165
|
+
</li>
|
|
1166
|
+
</ul>
|
|
1167
|
+
<a name="increment(byte[], long, long)">
|
|
1168
|
+
<!-- -->
|
|
1169
|
+
</a>
|
|
1170
|
+
<ul class="blockList">
|
|
1171
|
+
<li class="blockList">
|
|
1172
|
+
<h4>increment</h4>
|
|
1173
|
+
<pre>public long increment(byte[] key,
|
|
1174
|
+
long num,
|
|
1175
|
+
long orig)</pre>
|
|
1176
|
+
<div class="block">Add a number to the numeric integer value of a record.</div>
|
|
1177
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>num</code> - the additional number.</dd><dd><code>orig</code> - the origin number if no record corresponds to the key. If it is Long.MIN_VALUE
|
|
1178
|
+
and no record corresponds, this method fails. If it is Long.MAX_VALUE, the value is set as
|
|
1179
|
+
the additional number regardless of the current value.</dd>
|
|
1180
|
+
<dt><span class="strong">Returns:</span></dt><dd>the result value, or Long.MIN_VALUE on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1181
|
+
<dd>The value is serialized as an 8-byte binary integer in big-endian order, not a decimal
|
|
1182
|
+
string. If existing value is not 8-byte, this method fails.</dd></dl>
|
|
1183
|
+
</li>
|
|
1184
|
+
</ul>
|
|
1185
|
+
<a name="increment(java.lang.String, long, long)">
|
|
1186
|
+
<!-- -->
|
|
1187
|
+
</a>
|
|
1188
|
+
<ul class="blockList">
|
|
1189
|
+
<li class="blockList">
|
|
1190
|
+
<h4>increment</h4>
|
|
1191
|
+
<pre>public long increment(String key,
|
|
1192
|
+
long num,
|
|
1193
|
+
long orig)</pre>
|
|
1194
|
+
<div class="block">Add a number to the numeric integer value of a record.</div>
|
|
1195
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#increment(byte[], long, long)"><code>increment(byte[], long, long)</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1196
|
+
<dd>Equal to the original DB.increment method except that the parameter is String.</dd></dl>
|
|
1197
|
+
</li>
|
|
1198
|
+
</ul>
|
|
1199
|
+
<a name="iterate(kyotocabinet.Visitor, boolean)">
|
|
1200
|
+
<!-- -->
|
|
1201
|
+
</a>
|
|
1202
|
+
<ul class="blockList">
|
|
1203
|
+
<li class="blockList">
|
|
1204
|
+
<h4>iterate</h4>
|
|
1205
|
+
<pre>public boolean iterate(<a href="../kyotocabinet/Visitor.html" title="interface in kyotocabinet">Visitor</a> visitor,
|
|
1206
|
+
boolean writable)</pre>
|
|
1207
|
+
<div class="block">Iterate to accept a visitor for each record.</div>
|
|
1208
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>visitor</code> - a visitor object which implements the Visitor interface.</dd><dd><code>writable</code> - true for writable operation, or false for read-only operation.</dd>
|
|
1209
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1210
|
+
<dd>The whole iteration is performed atomically and other threads are blocked. To avoid
|
|
1211
|
+
deadlock, any explicit database operation must not be performed in this method.</dd></dl>
|
|
1212
|
+
</li>
|
|
1213
|
+
</ul>
|
|
1214
|
+
<a name="load_snapshot(java.lang.String)">
|
|
1215
|
+
<!-- -->
|
|
1216
|
+
</a>
|
|
1217
|
+
<ul class="blockList">
|
|
1218
|
+
<li class="blockList">
|
|
1219
|
+
<h4>load_snapshot</h4>
|
|
1220
|
+
<pre>public boolean load_snapshot(String src)</pre>
|
|
1221
|
+
<div class="block">Load records from a snapshot file.</div>
|
|
1222
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>src</code> - the name of the source file.</dd>
|
|
1223
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
1224
|
+
</li>
|
|
1225
|
+
</ul>
|
|
1226
|
+
<a name="match_prefix(java.lang.String, long)">
|
|
1227
|
+
<!-- -->
|
|
1228
|
+
</a>
|
|
1229
|
+
<ul class="blockList">
|
|
1230
|
+
<li class="blockList">
|
|
1231
|
+
<h4>match_prefix</h4>
|
|
1232
|
+
<pre>public List<String> match_prefix(String prefix,
|
|
1233
|
+
long max)</pre>
|
|
1234
|
+
<div class="block">Get keys matching a prefix string.</div>
|
|
1235
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - the prefix string.</dd><dd><code>max</code> - the maximum number to retrieve. If it is negative, no limit is specified.</dd>
|
|
1236
|
+
<dt><span class="strong">Returns:</span></dt><dd>a list object of matching keys, or null on failure.</dd></dl>
|
|
1237
|
+
</li>
|
|
1238
|
+
</ul>
|
|
1239
|
+
<a name="match_regex(java.lang.String, long)">
|
|
1240
|
+
<!-- -->
|
|
1241
|
+
</a>
|
|
1242
|
+
<ul class="blockList">
|
|
1243
|
+
<li class="blockList">
|
|
1244
|
+
<h4>match_regex</h4>
|
|
1245
|
+
<pre>public List<String> match_regex(String regex,
|
|
1246
|
+
long max)</pre>
|
|
1247
|
+
<div class="block">Get keys matching a regular expression string.</div>
|
|
1248
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>regex</code> - the regular expression string.</dd><dd><code>max</code> - the maximum number to retrieve. If it is negative, no limit is specified.</dd>
|
|
1249
|
+
<dt><span class="strong">Returns:</span></dt><dd>a list object of matching keys, or null on failure.</dd></dl>
|
|
1250
|
+
</li>
|
|
1251
|
+
</ul>
|
|
1252
|
+
<a name="match_similar(java.lang.String, long, boolean, long)">
|
|
1253
|
+
<!-- -->
|
|
1254
|
+
</a>
|
|
1255
|
+
<ul class="blockList">
|
|
1256
|
+
<li class="blockList">
|
|
1257
|
+
<h4>match_similar</h4>
|
|
1258
|
+
<pre>public List<String> match_similar(String origin,
|
|
1259
|
+
long range,
|
|
1260
|
+
boolean utf,
|
|
1261
|
+
long max)</pre>
|
|
1262
|
+
<div class="block">Get keys similar to a string in terms of the levenshtein distance.</div>
|
|
1263
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>origin</code> - the origin string.</dd><dd><code>range</code> - the maximum distance of keys to adopt.</dd><dd><code>utf</code> - flag to treat keys as UTF-8 strings.</dd><dd><code>max</code> - the maximum number to retrieve. If it is negative, no limit is specified.</dd>
|
|
1264
|
+
<dt><span class="strong">Returns:</span></dt><dd>a list object of matching keys, or null on failure.</dd></dl>
|
|
1265
|
+
</li>
|
|
1266
|
+
</ul>
|
|
1267
|
+
<a name="merge(kyotocabinet.DB[], int)">
|
|
1268
|
+
<!-- -->
|
|
1269
|
+
</a>
|
|
1270
|
+
<ul class="blockList">
|
|
1271
|
+
<li class="blockList">
|
|
1272
|
+
<h4>merge</h4>
|
|
1273
|
+
<pre>public boolean merge(<a href="../kyotocabinet/DB.html" title="class in kyotocabinet">DB</a>[] srcary,
|
|
1274
|
+
int mode)</pre>
|
|
1275
|
+
<div class="block">Merge records from other databases.</div>
|
|
1276
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>srcary</code> - an array of the source detabase objects.</dd><dd><code>mode</code> - the merge mode. DB.MSET to overwrite the existing value, DB.MADD to keep the
|
|
1277
|
+
existing value, DB.MAPPEND to append the new value.</dd>
|
|
1278
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
1279
|
+
</li>
|
|
1280
|
+
</ul>
|
|
1281
|
+
<a name="occupy(boolean, kyotocabinet.FileProcessor)">
|
|
1282
|
+
<!-- -->
|
|
1283
|
+
</a>
|
|
1284
|
+
<ul class="blockList">
|
|
1285
|
+
<li class="blockList">
|
|
1286
|
+
<h4>occupy</h4>
|
|
1287
|
+
<pre>public boolean occupy(boolean writable,
|
|
1288
|
+
<a href="../kyotocabinet/FileProcessor.html" title="interface in kyotocabinet">FileProcessor</a> proc)</pre>
|
|
1289
|
+
<div class="block">Occupy database by locking and do something meanwhile.</div>
|
|
1290
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writable</code> - true to use writer lock, or false to use reader lock.</dd><dd><code>proc</code> - a processor object which implements the FileProcessor interface. If it is null,
|
|
1291
|
+
no processing is performed.</dd>
|
|
1292
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1293
|
+
<dd>The operation of the processor is performed atomically and other threads accessing the
|
|
1294
|
+
same record are blocked. To avoid deadlock, any explicit database operation must not be
|
|
1295
|
+
performed in this method.</dd></dl>
|
|
1296
|
+
</li>
|
|
1297
|
+
</ul>
|
|
1298
|
+
<a name="open(java.lang.String, int)">
|
|
1299
|
+
<!-- -->
|
|
1300
|
+
</a>
|
|
1301
|
+
<ul class="blockList">
|
|
1302
|
+
<li class="blockList">
|
|
1303
|
+
<h4>open</h4>
|
|
1304
|
+
<pre>public boolean open(String path,
|
|
1305
|
+
int mode)</pre>
|
|
1306
|
+
<div class="block">Open a database file.</div>
|
|
1307
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path of a database file. If it is "-", the database will be a prototype
|
|
1308
|
+
hash database. If it is "+", the database will be a prototype tree database. If it is ":",
|
|
1309
|
+
the database will be a stash database. If it is "*", the database will be a cache hash
|
|
1310
|
+
database. If it is "%", the database will be a cache tree database. If its suffix is
|
|
1311
|
+
".kch", the database will be a file hash database. If its suffix is ".kct", the database
|
|
1312
|
+
will be a file tree database. If its suffix is ".kcd", the database will be a directory
|
|
1313
|
+
hash database. If its suffix is ".kcf", the database will be a directory tree database.
|
|
1314
|
+
If its suffix is ".kcx", the database will be a plain text database. Otherwise, this
|
|
1315
|
+
function fails. Tuning parameters can trail the name, separated by "#". Each parameter is
|
|
1316
|
+
composed of the name and the value, separated by "=". If the "type" parameter is specified,
|
|
1317
|
+
the database type is determined by the value in "-", "+", ":", "*", "%", "kch", "kct",
|
|
1318
|
+
"kcd", kcf", and "kcx". All database types support the logging parameters of "log",
|
|
1319
|
+
"logkinds", and "logpx". The prototype hash database and the prototype tree database do
|
|
1320
|
+
not support any other tuning parameter. The stash database supports "bnum". The cache
|
|
1321
|
+
hash database supports "opts", "bnum", "zcomp", "capcnt", "capsiz", and "zkey". The cache
|
|
1322
|
+
tree database supports all parameters of the cache hash database except for capacity
|
|
1323
|
+
limitation, and supports "psiz", "rcomp", "pccap" in addition. The file hash database
|
|
1324
|
+
supports "apow", "fpow", "opts", "bnum", "msiz", "dfunit", "zcomp", and "zkey". The file
|
|
1325
|
+
tree database supports all parameters of the file hash database and "psiz", "rcomp",
|
|
1326
|
+
"pccap" in addition. The directory hash database supports "opts", "zcomp", and "zkey".
|
|
1327
|
+
The directory tree database supports all parameters of the directory hash database and
|
|
1328
|
+
"psiz", "rcomp", "pccap" in addition. The plain text database does not support any other
|
|
1329
|
+
tuning parameter.</dd><dd><code>mode</code> - the connection mode. DB.OWRITER as a writer, DB.OREADER as a
|
|
1330
|
+
reader. The following may be added to the writer mode by bitwise-or: DB.OCREATE,
|
|
1331
|
+
which means it creates a new database if the file does not exist, DB.OTRUNCATE, which
|
|
1332
|
+
means it creates a new database regardless if the file exists, DB.OAUTOTRAN, which
|
|
1333
|
+
means each updating operation is performed in implicit transaction, DB.OAUTOSYNC,
|
|
1334
|
+
which means each updating operation is followed by implicit synchronization with the file
|
|
1335
|
+
system. The following may be added to both of the reader mode and the writer mode by
|
|
1336
|
+
bitwise-or: DB.ONOLOCK, which means it opens the database file without file locking,
|
|
1337
|
+
DB.OTRYLOCK, which means locking is performed without blocking, DB.ONOREPAIR,
|
|
1338
|
+
which means the database file is not repaired implicitly even if file destruction is
|
|
1339
|
+
detected.</dd>
|
|
1340
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1341
|
+
<dd>The tuning parameter "log" is for the original "tune_logger" and the value specifies
|
|
1342
|
+
the path of the log file, or "-" for the standard output, or "+" for the standard error.
|
|
1343
|
+
"logkinds" specifies kinds of logged messages and the value can be "debug", "info", "warn",
|
|
1344
|
+
or "error". "logpx" specifies the prefix of each log message. "opts" is for "tune_options"
|
|
1345
|
+
and the value can contain "s" for the small option, "l" for the linear option, and "c" for
|
|
1346
|
+
the compress option. "bnum" corresponds to "tune_bucket". "zcomp" is for "tune_compressor"
|
|
1347
|
+
and the value can be "zlib" for the ZLIB raw compressor, "def" for the ZLIB deflate
|
|
1348
|
+
compressor, "gz" for the ZLIB gzip compressor, "lzo" for the LZO compressor, "lzma" for the
|
|
1349
|
+
LZMA compressor, or "arc" for the Arcfour cipher. "zkey" specifies the cipher key of the
|
|
1350
|
+
compressor. "capcnt" is for "cap_count". "capsiz" is for "cap_size". "psiz" is for
|
|
1351
|
+
"tune_page". "rcomp" is for "tune_comparator" and the value can be "lex" for the lexical
|
|
1352
|
+
comparator, "dec" for the decimal comparator, "lexdesc" for the lexical descending
|
|
1353
|
+
comparator, or "decdesc" for the decimal descending comparator. "pccap" is for
|
|
1354
|
+
"tune_page_cache". "apow" is for "tune_alignment". "fpow" is for "tune_fbp". "msiz" is
|
|
1355
|
+
for "tune_map". "dfunit" is for "tune_defrag". Every opened database must be closed by
|
|
1356
|
+
the DB.close method when it is no longer in use. It is not allowed for two or more
|
|
1357
|
+
database objects in the same process to keep their connections to the same database file at
|
|
1358
|
+
the same time.</dd></dl>
|
|
1359
|
+
</li>
|
|
1360
|
+
</ul>
|
|
1361
|
+
<a name="path()">
|
|
1362
|
+
<!-- -->
|
|
1363
|
+
</a>
|
|
1364
|
+
<ul class="blockList">
|
|
1365
|
+
<li class="blockList">
|
|
1366
|
+
<h4>path</h4>
|
|
1367
|
+
<pre>public String path()</pre>
|
|
1368
|
+
<div class="block">Get the path of the database file.</div>
|
|
1369
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>the path of the database file, or null on failure.</dd></dl>
|
|
1370
|
+
</li>
|
|
1371
|
+
</ul>
|
|
1372
|
+
<a name="remove_bulk(byte[][], boolean)">
|
|
1373
|
+
<!-- -->
|
|
1374
|
+
</a>
|
|
1375
|
+
<ul class="blockList">
|
|
1376
|
+
<li class="blockList">
|
|
1377
|
+
<h4>remove_bulk</h4>
|
|
1378
|
+
<pre>public long remove_bulk(byte[][] keys,
|
|
1379
|
+
boolean atomic)</pre>
|
|
1380
|
+
<div class="block">Remove records at once.</div>
|
|
1381
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>keys</code> - the keys of the records to remove.</dd><dd><code>atomic</code> - true to perform all operations atomically, or false for non-atomic operations.</dd>
|
|
1382
|
+
<dt><span class="strong">Returns:</span></dt><dd>the number of removed records, or -1 on failure.</dd></dl>
|
|
1383
|
+
</li>
|
|
1384
|
+
</ul>
|
|
1385
|
+
<a name="remove_bulk(java.util.List, boolean)">
|
|
1386
|
+
<!-- -->
|
|
1387
|
+
</a>
|
|
1388
|
+
<ul class="blockList">
|
|
1389
|
+
<li class="blockList">
|
|
1390
|
+
<h4>remove_bulk</h4>
|
|
1391
|
+
<pre>public long remove_bulk(List<String> keys,
|
|
1392
|
+
boolean atomic)</pre>
|
|
1393
|
+
<div class="block">Remove records at once.</div>
|
|
1394
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#remove_bulk(byte[][], boolean)"><code>remove_bulk(byte[][], boolean)</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1395
|
+
<dd>Equal to the original DB.remove_bulk method except that the parameter is List.</dd></dl>
|
|
1396
|
+
</li>
|
|
1397
|
+
</ul>
|
|
1398
|
+
<a name="remove(byte[])">
|
|
1399
|
+
<!-- -->
|
|
1400
|
+
</a>
|
|
1401
|
+
<ul class="blockList">
|
|
1402
|
+
<li class="blockList">
|
|
1403
|
+
<h4>remove</h4>
|
|
1404
|
+
<pre>public boolean remove(byte[] key)</pre>
|
|
1405
|
+
<div class="block">Remove a record.</div>
|
|
1406
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd>
|
|
1407
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1408
|
+
<dd>If no record corresponds to the key, false is returned.</dd></dl>
|
|
1409
|
+
</li>
|
|
1410
|
+
</ul>
|
|
1411
|
+
<a name="remove(java.lang.String)">
|
|
1412
|
+
<!-- -->
|
|
1413
|
+
</a>
|
|
1414
|
+
<ul class="blockList">
|
|
1415
|
+
<li class="blockList">
|
|
1416
|
+
<h4>remove</h4>
|
|
1417
|
+
<pre>public boolean remove(String key)</pre>
|
|
1418
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#remove(byte[])"><code>remove(byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1419
|
+
<dd>Equal to the original DB.remove method except that the parameter is String.</dd></dl>
|
|
1420
|
+
</li>
|
|
1421
|
+
</ul>
|
|
1422
|
+
<a name="replace(byte[], byte[])">
|
|
1423
|
+
<!-- -->
|
|
1424
|
+
</a>
|
|
1425
|
+
<ul class="blockList">
|
|
1426
|
+
<li class="blockList">
|
|
1427
|
+
<h4>replace</h4>
|
|
1428
|
+
<pre>public boolean replace(byte[] key,
|
|
1429
|
+
byte[] value)</pre>
|
|
1430
|
+
<div class="block">Replace the value of a record.</div>
|
|
1431
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>value</code> - the value.</dd>
|
|
1432
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1433
|
+
<dd>If no record corresponds to the key, no new record is created and false is returned.
|
|
1434
|
+
If the corresponding record exists, the value is modified.</dd></dl>
|
|
1435
|
+
</li>
|
|
1436
|
+
</ul>
|
|
1437
|
+
<a name="replace(java.lang.String, java.lang.String)">
|
|
1438
|
+
<!-- -->
|
|
1439
|
+
</a>
|
|
1440
|
+
<ul class="blockList">
|
|
1441
|
+
<li class="blockList">
|
|
1442
|
+
<h4>replace</h4>
|
|
1443
|
+
<pre>public boolean replace(String key,
|
|
1444
|
+
String value)</pre>
|
|
1445
|
+
<div class="block">Replace the value of a record.</div>
|
|
1446
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#add(byte[], byte[])"><code>add(byte[], byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1447
|
+
<dd>Equal to the original DB.replace method except that the parameters are String.</dd></dl>
|
|
1448
|
+
</li>
|
|
1449
|
+
</ul>
|
|
1450
|
+
<a name="seize(byte[])">
|
|
1451
|
+
<!-- -->
|
|
1452
|
+
</a>
|
|
1453
|
+
<ul class="blockList">
|
|
1454
|
+
<li class="blockList">
|
|
1455
|
+
<h4>seize</h4>
|
|
1456
|
+
<pre>public byte[] seize(byte[] key)</pre>
|
|
1457
|
+
<div class="block">Retrieve the value of a record and remove it atomically.</div>
|
|
1458
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd>
|
|
1459
|
+
<dt><span class="strong">Returns:</span></dt><dd>the value of the corresponding record, or null on failure.</dd></dl>
|
|
1460
|
+
</li>
|
|
1461
|
+
</ul>
|
|
1462
|
+
<a name="seize(java.lang.String)">
|
|
1463
|
+
<!-- -->
|
|
1464
|
+
</a>
|
|
1465
|
+
<ul class="blockList">
|
|
1466
|
+
<li class="blockList">
|
|
1467
|
+
<h4>seize</h4>
|
|
1468
|
+
<pre>public String seize(String key)</pre>
|
|
1469
|
+
<div class="block">Retrieve the value of a record and remove it atomically.</div>
|
|
1470
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#seize(byte[])"><code>seize(byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1471
|
+
<dd>Equal to the original DB.seize method except that the parameter and the return value
|
|
1472
|
+
are String.</dd></dl>
|
|
1473
|
+
</li>
|
|
1474
|
+
</ul>
|
|
1475
|
+
<a name="set_bulk(byte[][], boolean)">
|
|
1476
|
+
<!-- -->
|
|
1477
|
+
</a>
|
|
1478
|
+
<ul class="blockList">
|
|
1479
|
+
<li class="blockList">
|
|
1480
|
+
<h4>set_bulk</h4>
|
|
1481
|
+
<pre>public long set_bulk(byte[][] recs,
|
|
1482
|
+
boolean atomic)</pre>
|
|
1483
|
+
<div class="block">Store records at once.</div>
|
|
1484
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recs</code> - the records to store. Each key and each value must be placed alternately.</dd><dd><code>atomic</code> - true to perform all operations atomically, or false for non-atomic operations.</dd>
|
|
1485
|
+
<dt><span class="strong">Returns:</span></dt><dd>the number of stored records, or -1 on failure.</dd></dl>
|
|
1486
|
+
</li>
|
|
1487
|
+
</ul>
|
|
1488
|
+
<a name="set_bulk(java.util.Map, boolean)">
|
|
1489
|
+
<!-- -->
|
|
1490
|
+
</a>
|
|
1491
|
+
<ul class="blockList">
|
|
1492
|
+
<li class="blockList">
|
|
1493
|
+
<h4>set_bulk</h4>
|
|
1494
|
+
<pre>public long set_bulk(Map<String,String> recs,
|
|
1495
|
+
boolean atomic)</pre>
|
|
1496
|
+
<div class="block">Store records at once.</div>
|
|
1497
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#set_bulk(byte[][], boolean)"><code>set_bulk(byte[][], boolean)</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1498
|
+
<dd>Equal to the original DB.set_bulk method except that the parameter is Map.</dd></dl>
|
|
1499
|
+
</li>
|
|
1500
|
+
</ul>
|
|
1501
|
+
<a name="set(byte[], byte[])">
|
|
1502
|
+
<!-- -->
|
|
1503
|
+
</a>
|
|
1504
|
+
<ul class="blockList">
|
|
1505
|
+
<li class="blockList">
|
|
1506
|
+
<h4>set</h4>
|
|
1507
|
+
<pre>public boolean set(byte[] key,
|
|
1508
|
+
byte[] value)</pre>
|
|
1509
|
+
<div class="block">Set the value of a record.</div>
|
|
1510
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key.</dd><dd><code>value</code> - the value.</dd>
|
|
1511
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1512
|
+
<dd>If no record corresponds to the key, a new record is created. If the corresponding
|
|
1513
|
+
record exists, the value is overwritten.</dd></dl>
|
|
1514
|
+
</li>
|
|
1515
|
+
</ul>
|
|
1516
|
+
<a name="set(java.lang.String, java.lang.String)">
|
|
1517
|
+
<!-- -->
|
|
1518
|
+
</a>
|
|
1519
|
+
<ul class="blockList">
|
|
1520
|
+
<li class="blockList">
|
|
1521
|
+
<h4>set</h4>
|
|
1522
|
+
<pre>public boolean set(String key,
|
|
1523
|
+
String value)</pre>
|
|
1524
|
+
<div class="block">Set the value of a record.</div>
|
|
1525
|
+
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../kyotocabinet/DB.html#set(byte[], byte[])"><code>set(byte[], byte[])</code></a></dd><dt><span class="strong">Note:</span></dt>
|
|
1526
|
+
<dd>Equal to the original DB.set method except that the parameters are String.</dd></dl>
|
|
1527
|
+
</li>
|
|
1528
|
+
</ul>
|
|
1529
|
+
<a name="size()">
|
|
1530
|
+
<!-- -->
|
|
1531
|
+
</a>
|
|
1532
|
+
<ul class="blockList">
|
|
1533
|
+
<li class="blockList">
|
|
1534
|
+
<h4>size</h4>
|
|
1535
|
+
<pre>public long size()</pre>
|
|
1536
|
+
<div class="block">Get the size of the database file.</div>
|
|
1537
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>the size of the database file in bytes, or -1 on failure.</dd></dl>
|
|
1538
|
+
</li>
|
|
1539
|
+
</ul>
|
|
1540
|
+
<a name="status()">
|
|
1541
|
+
<!-- -->
|
|
1542
|
+
</a>
|
|
1543
|
+
<ul class="blockList">
|
|
1544
|
+
<li class="blockList">
|
|
1545
|
+
<h4>status</h4>
|
|
1546
|
+
<pre>public Map<String,String> status()</pre>
|
|
1547
|
+
<div class="block">Get the miscellaneous status information.</div>
|
|
1548
|
+
<dl><dt><span class="strong">Returns:</span></dt><dd>a map object of the status information, or null on failure.</dd></dl>
|
|
1549
|
+
</li>
|
|
1550
|
+
</ul>
|
|
1551
|
+
<a name="synchronize(boolean, kyotocabinet.FileProcessor)">
|
|
1552
|
+
<!-- -->
|
|
1553
|
+
</a>
|
|
1554
|
+
<ul class="blockList">
|
|
1555
|
+
<li class="blockList">
|
|
1556
|
+
<h4>synchronize</h4>
|
|
1557
|
+
<pre>public boolean synchronize(boolean hard,
|
|
1558
|
+
<a href="../kyotocabinet/FileProcessor.html" title="interface in kyotocabinet">FileProcessor</a> proc)</pre>
|
|
1559
|
+
<div class="block">Synchronize updated contents with the file and the device.</div>
|
|
1560
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hard</code> - true for physical synchronization with the device, or false for logical
|
|
1561
|
+
synchronization with the file system.</dd><dd><code>proc</code> - a postprocessor object which implements the FileProcessor interface. If it is
|
|
1562
|
+
null, no postprocessing is performed.</dd>
|
|
1563
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1564
|
+
<dd>The operation of the postprocessor is performed atomically and other threads accessing
|
|
1565
|
+
the same record are blocked. To avoid deadlock, any explicit database operation must not
|
|
1566
|
+
be performed in this method.</dd></dl>
|
|
1567
|
+
</li>
|
|
1568
|
+
</ul>
|
|
1569
|
+
<a name="toString()">
|
|
1570
|
+
<!-- -->
|
|
1571
|
+
</a>
|
|
1572
|
+
<ul class="blockList">
|
|
1573
|
+
<li class="blockList">
|
|
1574
|
+
<h4>toString</h4>
|
|
1575
|
+
<pre>public String toString()</pre>
|
|
1576
|
+
<div class="block">Get the string expression.</div>
|
|
1577
|
+
<dl>
|
|
1578
|
+
<dt><strong>Overrides:</strong></dt>
|
|
1579
|
+
<dd><code>toString</code> in class <code>Object</code></dd>
|
|
1580
|
+
<dt><span class="strong">Returns:</span></dt><dd>the string expression.</dd></dl>
|
|
1581
|
+
</li>
|
|
1582
|
+
</ul>
|
|
1583
|
+
<a name="tune_encoding(java.lang.String)">
|
|
1584
|
+
<!-- -->
|
|
1585
|
+
</a>
|
|
1586
|
+
<ul class="blockList">
|
|
1587
|
+
<li class="blockList">
|
|
1588
|
+
<h4>tune_encoding</h4>
|
|
1589
|
+
<pre>public boolean tune_encoding(String encname)</pre>
|
|
1590
|
+
<div class="block">Set the encoding of external strings.</div>
|
|
1591
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encname</code> - the name of the encoding.</dd>
|
|
1592
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd><dt><span class="strong">Note:</span></dt>
|
|
1593
|
+
<dd>The default encoding of external strings is UTF-8.</dd></dl>
|
|
1594
|
+
</li>
|
|
1595
|
+
</ul>
|
|
1596
|
+
<a name="tune_exception_rule(int[])">
|
|
1597
|
+
<!-- -->
|
|
1598
|
+
</a>
|
|
1599
|
+
<ul class="blockListLast">
|
|
1600
|
+
<li class="blockList">
|
|
1601
|
+
<h4>tune_exception_rule</h4>
|
|
1602
|
+
<pre>public boolean tune_exception_rule(int[] codes)</pre>
|
|
1603
|
+
<div class="block">Set the rule about throwing exception.</div>
|
|
1604
|
+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>codes</code> - an array of error codes. If each method occurs an error corresponding to one
|
|
1605
|
+
of the specified codes, the error is thrown as an exception.</dd>
|
|
1606
|
+
<dt><span class="strong">Returns:</span></dt><dd>true on success, or false on failure.</dd></dl>
|
|
1607
|
+
</li>
|
|
1608
|
+
</ul>
|
|
1609
|
+
</li>
|
|
1610
|
+
</ul>
|
|
1611
|
+
</li>
|
|
1612
|
+
</ul>
|
|
1613
|
+
</div>
|
|
1614
|
+
</div>
|
|
1615
|
+
<!-- ========= END OF CLASS DATA ========= -->
|
|
1616
|
+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
1617
|
+
<div class="bottomNav"><a name="navbar_bottom">
|
|
1618
|
+
<!-- -->
|
|
1619
|
+
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
1620
|
+
<!-- -->
|
|
1621
|
+
</a>
|
|
1622
|
+
<ul class="navList" title="Navigation">
|
|
1623
|
+
<li><a href="../overview-summary.html">Overview</a></li>
|
|
1624
|
+
<li><a href="../kyotocabinet/package-summary.html">Package</a></li>
|
|
1625
|
+
<li class="navBarCell1Rev">Class</li>
|
|
1626
|
+
<li><a href="package-tree.html">Tree</a></li>
|
|
1627
|
+
<li><a href="../index-all.html">Index</a></li>
|
|
1628
|
+
</ul>
|
|
1629
|
+
</div>
|
|
1630
|
+
<div class="subNav">
|
|
1631
|
+
<ul class="navList">
|
|
1632
|
+
<li><a href="../kyotocabinet/Cursor.html" title="class in kyotocabinet"><span class="strong">Prev Class</span></a></li>
|
|
1633
|
+
<li><a href="../kyotocabinet/Error.html" title="class in kyotocabinet"><span class="strong">Next Class</span></a></li>
|
|
1634
|
+
</ul>
|
|
1635
|
+
<ul class="navList">
|
|
1636
|
+
<li><a href="../index.html?kyotocabinet/DB.html" target="_top">Frames</a></li>
|
|
1637
|
+
<li><a href="DB.html" target="_top">No Frames</a></li>
|
|
1638
|
+
</ul>
|
|
1639
|
+
<ul class="navList" id="allclasses_navbar_bottom">
|
|
1640
|
+
<li><a href="../allclasses-noframe.html">All Classes</a></li>
|
|
1641
|
+
</ul>
|
|
1642
|
+
<div>
|
|
1643
|
+
<script type="text/javascript"><!--
|
|
1644
|
+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
1645
|
+
if(window==top) {
|
|
1646
|
+
allClassesLink.style.display = "block";
|
|
1647
|
+
}
|
|
1648
|
+
else {
|
|
1649
|
+
allClassesLink.style.display = "none";
|
|
1650
|
+
}
|
|
1651
|
+
//-->
|
|
1652
|
+
</script>
|
|
1653
|
+
</div>
|
|
1654
|
+
<div>
|
|
1655
|
+
<ul class="subNavList">
|
|
1656
|
+
<li>Summary: </li>
|
|
1657
|
+
<li>Nested | </li>
|
|
1658
|
+
<li><a href="#field_summary">Field</a> | </li>
|
|
1659
|
+
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
1660
|
+
<li><a href="#method_summary">Method</a></li>
|
|
1661
|
+
</ul>
|
|
1662
|
+
<ul class="subNavList">
|
|
1663
|
+
<li>Detail: </li>
|
|
1664
|
+
<li><a href="#field_detail">Field</a> | </li>
|
|
1665
|
+
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
1666
|
+
<li><a href="#method_detail">Method</a></li>
|
|
1667
|
+
</ul>
|
|
1668
|
+
</div>
|
|
1669
|
+
<a name="skip-navbar_bottom">
|
|
1670
|
+
<!-- -->
|
|
1671
|
+
</a></div>
|
|
1672
|
+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
1673
|
+
</body>
|
|
1674
|
+
</html>
|