1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:46 EDT 2010 --> 6<TITLE> 7DatabaseConfig (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="DatabaseConfig (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DatabaseConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/db/DatabaseConfig.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="DatabaseConfig.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.db</FONT> 92<BR> 93Class DatabaseConfig</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.DatabaseConfig</B> 97</PRE> 98<DL> 99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD> 100</DL> 101<DL> 102<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A></DD> 103</DL> 104<HR> 105<DL> 106<DT><PRE>public class <B>DatabaseConfig</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL> 107</PRE> 108 109<P> 110Specify the attributes of a database. 111<P> 112 113<P> 114<HR> 115 116<P> 117<!-- =========== FIELD SUMMARY =========== --> 118 119<A NAME="field_summary"><!-- --></A> 120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 123<B>Field Summary</B></FONT></TH> 124</TR> 125<TR BGCOLOR="white" CLASS="TableRowColor"> 126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 127<CODE>static <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A></CODE></FONT></TD> 128<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#DEFAULT">DEFAULT</A></B></CODE> 129 130<BR> 131 An instance created using the default constructor is initialized 132 with the system's default settings.</TD> 133</TR> 134</TABLE> 135 136<!-- ======== CONSTRUCTOR SUMMARY ======== --> 137 138<A NAME="constructor_summary"><!-- --></A> 139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 142<B>Constructor Summary</B></FONT></TH> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#DatabaseConfig()">DatabaseConfig</A></B>()</CODE> 146 147<BR> 148 An instance created using the default constructor is initialized with 149 the system's default settings.</TD> 150</TR> 151</TABLE> 152 153<!-- ========== METHOD SUMMARY =========== --> 154 155<A NAME="method_summary"><!-- --></A> 156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 157<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 158<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 159<B>Method Summary</B></FONT></TH> 160</TR> 161<TR BGCOLOR="white" CLASS="TableRowColor"> 162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 163<CODE> <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A></CODE></FONT></TD> 164<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#cloneConfig()">cloneConfig</A></B>()</CODE> 165 166<BR> 167 Returns a copy of this configuration object.</TD> 168</TR> 169<TR BGCOLOR="white" CLASS="TableRowColor"> 170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 171<CODE> boolean</CODE></FONT></TD> 172<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getAllowCreate()">getAllowCreate</A></B>()</CODE> 173 174<BR> 175 Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured 176 to create the database if it does not already exist.</TD> 177</TR> 178<TR BGCOLOR="white" CLASS="TableRowColor"> 179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 180<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A></CODE></FONT></TD> 181<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeComparator()">getBtreeComparator</A></B>()</CODE> 182 183<BR> 184 </TD> 185</TR> 186<TR BGCOLOR="white" CLASS="TableRowColor"> 187<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 188<CODE> <A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A></CODE></FONT></TD> 189<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeCompressor()">getBtreeCompressor</A></B>()</CODE> 190 191<BR> 192 Get the Btree compression callbacks.</TD> 193</TR> 194<TR BGCOLOR="white" CLASS="TableRowColor"> 195<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 196<CODE> int</CODE></FONT></TD> 197<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeMinKey()">getBtreeMinKey</A></B>()</CODE> 198 199<BR> 200 Return the minimum number of key/data pairs intended to be stored 201 on any single Btree leaf page.</TD> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 205<CODE> <A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A></CODE></FONT></TD> 206<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreePrefixCalculator()">getBtreePrefixCalculator</A></B>()</CODE> 207 208<BR> 209 Return the Btree prefix callback.</TD> 210</TR> 211<TR BGCOLOR="white" CLASS="TableRowColor"> 212<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 213<CODE> boolean</CODE></FONT></TD> 214<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeRecordNumbers()">getBtreeRecordNumbers</A></B>()</CODE> 215 216<BR> 217 Return true if the Btree is configured to support retrieval by record number.</TD> 218</TR> 219<TR BGCOLOR="white" CLASS="TableRowColor"> 220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 221<CODE> int</CODE></FONT></TD> 222<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getByteOrder()">getByteOrder</A></B>()</CODE> 223 224<BR> 225 Return the database byte order; a byte order of 4,321 indicates a 226 big endian order, and a byte order of 1,234 indicates a little 227 endian order.</TD> 228</TR> 229<TR BGCOLOR="white" CLASS="TableRowColor"> 230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 231<CODE> boolean</CODE></FONT></TD> 232<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getByteSwapped()">getByteSwapped</A></B>()</CODE> 233 234<BR> 235 Return if the underlying database files were created on an architecture 236 of the same byte order as the current one.</TD> 237</TR> 238<TR BGCOLOR="white" CLASS="TableRowColor"> 239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 240<CODE> int</CODE></FONT></TD> 241<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getCacheCount()">getCacheCount</A></B>()</CODE> 242 243<BR> 244 Return the number of shared memory buffer pools, that is, the number 245 of caches.</TD> 246</TR> 247<TR BGCOLOR="white" CLASS="TableRowColor"> 248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 249<CODE> long</CODE></FONT></TD> 250<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getCacheSize()">getCacheSize</A></B>()</CODE> 251 252<BR> 253 Return the size of the shared memory buffer pool, that is, the cache.</TD> 254</TR> 255<TR BGCOLOR="white" CLASS="TableRowColor"> 256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 257<CODE> boolean</CODE></FONT></TD> 258<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getChecksum()">getChecksum</A></B>()</CODE> 259 260<BR> 261 Return true if the database environment is configured to do checksum 262 verification of pages read into the cache from the backing 263 filestore.</TD> 264</TR> 265<TR BGCOLOR="white" CLASS="TableRowColor"> 266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 267<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> 268<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getCreateDir()">getCreateDir</A></B>()</CODE> 269 270<BR> 271 Return the directory a database will/has been created in or looked for.</TD> 272</TR> 273<TR BGCOLOR="white" CLASS="TableRowColor"> 274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 275<CODE> boolean</CODE></FONT></TD> 276<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getDirtyRead()">getDirtyRead</A></B>()</CODE> 277 278<BR> 279 <B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()"><CODE>getReadUncommitted()</CODE></A> to conform to ANSI 280 database isolation terminology.</I></TD> 281</TR> 282<TR BGCOLOR="white" CLASS="TableRowColor"> 283<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 284<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A></CODE></FONT></TD> 285<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getDuplicateComparator()">getDuplicateComparator</A></B>()</CODE> 286 287<BR> 288 </TD> 289</TR> 290<TR BGCOLOR="white" CLASS="TableRowColor"> 291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 292<CODE> boolean</CODE></FONT></TD> 293<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getEncrypted()">getEncrypted</A></B>()</CODE> 294 295<BR> 296 Return true if the database has been configured to perform encryption.</TD> 297</TR> 298<TR BGCOLOR="white" CLASS="TableRowColor"> 299<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 300<CODE> <A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A></CODE></FONT></TD> 301<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getErrorHandler()">getErrorHandler</A></B>()</CODE> 302 303<BR> 304 Return the function to be called if an error occurs.</TD> 305</TR> 306<TR BGCOLOR="white" CLASS="TableRowColor"> 307<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 308<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 309<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getErrorPrefix()">getErrorPrefix</A></B>()</CODE> 310 311<BR> 312 Return the prefix string that appears before error messages.</TD> 313</TR> 314<TR BGCOLOR="white" CLASS="TableRowColor"> 315<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 316<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD> 317<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getErrorStream()">getErrorStream</A></B>()</CODE> 318 319<BR> 320 Return the an OutputStream for displaying error messages.</TD> 321</TR> 322<TR BGCOLOR="white" CLASS="TableRowColor"> 323<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 324<CODE> boolean</CODE></FONT></TD> 325<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getExclusiveCreate()">getExclusiveCreate</A></B>()</CODE> 326 327<BR> 328 Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured 329 to fail if the database already exists.</TD> 330</TR> 331<TR BGCOLOR="white" CLASS="TableRowColor"> 332<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 333<CODE> <A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A></CODE></FONT></TD> 334<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getFeedbackHandler()">getFeedbackHandler</A></B>()</CODE> 335 336<BR> 337 Return the object's methods to be called to provide feedback.</TD> 338</TR> 339<TR BGCOLOR="white" CLASS="TableRowColor"> 340<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 341<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A></CODE></FONT></TD> 342<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHashComparator()">getHashComparator</A></B>()</CODE> 343 344<BR> 345 Return the Comparator used to compare keys in a Hash database.</TD> 346</TR> 347<TR BGCOLOR="white" CLASS="TableRowColor"> 348<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 349<CODE> <A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A></CODE></FONT></TD> 350<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHasher()">getHasher</A></B>()</CODE> 351 352<BR> 353 Return the database-specific hash function.</TD> 354</TR> 355<TR BGCOLOR="white" CLASS="TableRowColor"> 356<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 357<CODE> int</CODE></FONT></TD> 358<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHashFillFactor()">getHashFillFactor</A></B>()</CODE> 359 360<BR> 361 Return the hash table density.</TD> 362</TR> 363<TR BGCOLOR="white" CLASS="TableRowColor"> 364<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 365<CODE> int</CODE></FONT></TD> 366<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHashNumElements()">getHashNumElements</A></B>()</CODE> 367 368<BR> 369 Return the estimate of the final size of the hash table.</TD> 370</TR> 371<TR BGCOLOR="white" CLASS="TableRowColor"> 372<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 373<CODE> <A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A></CODE></FONT></TD> 374<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMessageHandler()">getMessageHandler</A></B>()</CODE> 375 376<BR> 377 Return the function to be called with an informational message.</TD> 378</TR> 379<TR BGCOLOR="white" CLASS="TableRowColor"> 380<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 381<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD> 382<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMessageStream()">getMessageStream</A></B>()</CODE> 383 384<BR> 385 Return the an OutputStream for displaying informational messages.</TD> 386</TR> 387<TR BGCOLOR="white" CLASS="TableRowColor"> 388<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 389<CODE> long</CODE></FONT></TD> 390<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMode()">getMode</A></B>()</CODE> 391 392<BR> 393 Return the mode used to create files.</TD> 394</TR> 395<TR BGCOLOR="white" CLASS="TableRowColor"> 396<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 397<CODE> boolean</CODE></FONT></TD> 398<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMultiversion()">getMultiversion</A></B>()</CODE> 399 400<BR> 401 Return true if the database is configured for multiversion concurrency control.</TD> 402</TR> 403<TR BGCOLOR="white" CLASS="TableRowColor"> 404<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 405<CODE> boolean</CODE></FONT></TD> 406<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getNoMMap()">getNoMMap</A></B>()</CODE> 407 408<BR> 409 Return true if the library is configured to not map this database into 410 memory.</TD> 411</TR> 412<TR BGCOLOR="white" CLASS="TableRowColor"> 413<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 414<CODE> int</CODE></FONT></TD> 415<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPageSize()">getPageSize</A></B>()</CODE> 416 417<BR> 418 Return the size of the pages used to hold items in the database, in bytes.</TD> 419</TR> 420<TR BGCOLOR="white" CLASS="TableRowColor"> 421<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 422<CODE> <A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A></CODE></FONT></TD> 423<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPanicHandler()">getPanicHandler</A></B>()</CODE> 424 425<BR> 426 Return the function to be called if the database environment panics.</TD> 427</TR> 428<TR BGCOLOR="white" CLASS="TableRowColor"> 429<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 430<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[]</CODE></FONT></TD> 431<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionDirs()">getPartitionDirs</A></B>()</CODE> 432 433<BR> 434 Return the array of directories the database extents should be created in or 435looked for.</TD> 436</TR> 437<TR BGCOLOR="white" CLASS="TableRowColor"> 438<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 439<CODE> <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A></CODE></FONT></TD> 440<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionHandler()">getPartitionHandler</A></B>()</CODE> 441 442<BR> 443 Return the function to be called to determine which partition a key resides in.</TD> 444</TR> 445<TR BGCOLOR="white" CLASS="TableRowColor"> 446<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 447<CODE> <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></FONT></TD> 448<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionKeys()">getPartitionKeys</A></B>()</CODE> 449 450<BR> 451 Return the array of keys the database is configured to partition with.</TD> 452</TR> 453<TR BGCOLOR="white" CLASS="TableRowColor"> 454<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 455<CODE> int</CODE></FONT></TD> 456<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionParts()">getPartitionParts</A></B>()</CODE> 457 458<BR> 459 Return the number of partitions the database is configured for.</TD> 460</TR> 461<TR BGCOLOR="white" CLASS="TableRowColor"> 462<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 463<CODE> <A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A></CODE></FONT></TD> 464<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPriority()">getPriority</A></B>()</CODE> 465 466<BR> 467 Return the the cache priority for pages referenced by this handle.</TD> 468</TR> 469<TR BGCOLOR="white" CLASS="TableRowColor"> 470<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 471<CODE> int</CODE></FONT></TD> 472<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getQueueExtentSize()">getQueueExtentSize</A></B>()</CODE> 473 474<BR> 475 Return the size of the extents used to hold pages in a Queue database, 476 specified as a number of pages.</TD> 477</TR> 478<TR BGCOLOR="white" CLASS="TableRowColor"> 479<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 480<CODE> boolean</CODE></FONT></TD> 481<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getQueueInOrder()">getQueueInOrder</A></B>()</CODE> 482 483<BR> 484 Return true if the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method is configured to return 485 key/data pairs in order, always returning the key/data item from the 486 head of the queue.</TD> 487</TR> 488<TR BGCOLOR="white" CLASS="TableRowColor"> 489<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 490<CODE> boolean</CODE></FONT></TD> 491<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReadOnly()">getReadOnly</A></B>()</CODE> 492 493<BR> 494 Return true if the database is configured in read-only mode.</TD> 495</TR> 496<TR BGCOLOR="white" CLASS="TableRowColor"> 497<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 498<CODE> boolean</CODE></FONT></TD> 499<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()">getReadUncommitted</A></B>()</CODE> 500 501<BR> 502 Return true if the database is configured to support read uncommitted.</TD> 503</TR> 504<TR BGCOLOR="white" CLASS="TableRowColor"> 505<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 506<CODE> int</CODE></FONT></TD> 507<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordDelimiter()">getRecordDelimiter</A></B>()</CODE> 508 509<BR> 510 Return the delimiting byte used to mark the end of a record in the 511 backing source file for the Recno access method.</TD> 512</TR> 513<TR BGCOLOR="white" CLASS="TableRowColor"> 514<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 515<CODE> int</CODE></FONT></TD> 516<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordLength()">getRecordLength</A></B>()</CODE> 517 518<BR> 519 Return the database record length, in bytes.</TD> 520</TR> 521<TR BGCOLOR="white" CLASS="TableRowColor"> 522<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 523<CODE> <A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A></CODE></FONT></TD> 524<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordNumberAppender()">getRecordNumberAppender</A></B>()</CODE> 525 526<BR> 527 Return the function to call after the record number has been 528 selected but before the data has been stored into the database.</TD> 529</TR> 530<TR BGCOLOR="white" CLASS="TableRowColor"> 531<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 532<CODE> int</CODE></FONT></TD> 533<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordPad()">getRecordPad</A></B>()</CODE> 534 535<BR> 536 Return the padding character for short, fixed-length records for the 537 Queue and Recno access methods.</TD> 538</TR> 539<TR BGCOLOR="white" CLASS="TableRowColor"> 540<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 541<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> 542<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordSource()">getRecordSource</A></B>()</CODE> 543 544<BR> 545 Return the name of an underlying flat text database file that is 546 read to initialize a transient record number index.</TD> 547</TR> 548<TR BGCOLOR="white" CLASS="TableRowColor"> 549<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 550<CODE> boolean</CODE></FONT></TD> 551<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRenumbering()">getRenumbering</A></B>()</CODE> 552 553<BR> 554 Return true if the logical record numbers are mutable, and change as 555 records are added to and deleted from the database.</TD> 556</TR> 557<TR BGCOLOR="white" CLASS="TableRowColor"> 558<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 559<CODE> boolean</CODE></FONT></TD> 560<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReverseSplitOff()">getReverseSplitOff</A></B>()</CODE> 561 562<BR> 563 Return true if the Btree has been configured to not do reverse splits.</TD> 564</TR> 565<TR BGCOLOR="white" CLASS="TableRowColor"> 566<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 567<CODE> boolean</CODE></FONT></TD> 568<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getSnapshot()">getSnapshot</A></B>()</CODE> 569 570<BR> 571 Return true if the any specified backing source file will be read in its 572 entirety when the database is opened.</TD> 573</TR> 574<TR BGCOLOR="white" CLASS="TableRowColor"> 575<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 576<CODE> boolean</CODE></FONT></TD> 577<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getSortedDuplicates()">getSortedDuplicates</A></B>()</CODE> 578 579<BR> 580 Return true if the database is configured to support sorted duplicate data 581 items.</TD> 582</TR> 583<TR BGCOLOR="white" CLASS="TableRowColor"> 584<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 585<CODE> boolean</CODE></FONT></TD> 586<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getTransactional()">getTransactional</A></B>()</CODE> 587 588<BR> 589 Return true if the database open is enclosed within a transaction.</TD> 590</TR> 591<TR BGCOLOR="white" CLASS="TableRowColor"> 592<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 593<CODE> boolean</CODE></FONT></TD> 594<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getTransactionNotDurable()">getTransactionNotDurable</A></B>()</CODE> 595 596<BR> 597 Return true if the database environment is configured to not write log 598 records for this database.</TD> 599</TR> 600<TR BGCOLOR="white" CLASS="TableRowColor"> 601<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 602<CODE> boolean</CODE></FONT></TD> 603<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getTruncate()">getTruncate</A></B>()</CODE> 604 605<BR> 606 Return true if the database has been configured to be physically truncated 607 by truncating the underlying file, discarding all previous databases 608 it might have held.</TD> 609</TR> 610<TR BGCOLOR="white" CLASS="TableRowColor"> 611<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 612<CODE> <A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A></CODE></FONT></TD> 613<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getType()">getType</A></B>()</CODE> 614 615<BR> 616 Return the type of the database.</TD> 617</TR> 618<TR BGCOLOR="white" CLASS="TableRowColor"> 619<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 620<CODE> boolean</CODE></FONT></TD> 621<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getUnsortedDuplicates()">getUnsortedDuplicates</A></B>()</CODE> 622 623<BR> 624 Return true if the database is configured to support duplicate data items.</TD> 625</TR> 626<TR BGCOLOR="white" CLASS="TableRowColor"> 627<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 628<CODE> void</CODE></FONT></TD> 629<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setAllowCreate(boolean)">setAllowCreate</A></B>(boolean allowCreate)</CODE> 630 631<BR> 632 Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to create 633 the database if it does not already exist.</TD> 634</TR> 635<TR BGCOLOR="white" CLASS="TableRowColor"> 636<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 637<CODE> void</CODE></FONT></TD> 638<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeComparator(java.util.Comparator)">setBtreeComparator</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> btreeComparator)</CODE> 639 640<BR> 641 By default, a byte by byte lexicographic comparison is used for 642 btree keys.</TD> 643</TR> 644<TR BGCOLOR="white" CLASS="TableRowColor"> 645<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 646<CODE> void</CODE></FONT></TD> 647<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeCompressor(com.sleepycat.db.BtreeCompressor)">setBtreeCompressor</A></B>(<A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A> btreeCompressor)</CODE> 648 649<BR> 650 Set the Btree compression callbacks.</TD> 651</TR> 652<TR BGCOLOR="white" CLASS="TableRowColor"> 653<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 654<CODE> void</CODE></FONT></TD> 655<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeMinKey(int)">setBtreeMinKey</A></B>(int btMinKey)</CODE> 656 657<BR> 658 Set the minimum number of key/data pairs intended to be stored on any 659 single Btree leaf page.</TD> 660</TR> 661<TR BGCOLOR="white" CLASS="TableRowColor"> 662<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 663<CODE> void</CODE></FONT></TD> 664<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)">setBtreePrefixCalculator</A></B>(<A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A> btreePrefixCalculator)</CODE> 665 666<BR> 667 Set the Btree prefix callback.</TD> 668</TR> 669<TR BGCOLOR="white" CLASS="TableRowColor"> 670<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 671<CODE> void</CODE></FONT></TD> 672<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeRecordNumbers(boolean)">setBtreeRecordNumbers</A></B>(boolean btreeRecordNumbers)</CODE> 673 674<BR> 675 Configure the Btree to support retrieval by record number.</TD> 676</TR> 677<TR BGCOLOR="white" CLASS="TableRowColor"> 678<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 679<CODE> void</CODE></FONT></TD> 680<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setByteOrder(int)">setByteOrder</A></B>(int byteOrder)</CODE> 681 682<BR> 683 Set the byte order for integers in the stored database metadata.</TD> 684</TR> 685<TR BGCOLOR="white" CLASS="TableRowColor"> 686<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 687<CODE> void</CODE></FONT></TD> 688<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setCacheCount(int)">setCacheCount</A></B>(int cacheCount)</CODE> 689 690<BR> 691 Set the number of shared memory buffer pools, that is, the number of 692caches.</TD> 693</TR> 694<TR BGCOLOR="white" CLASS="TableRowColor"> 695<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 696<CODE> void</CODE></FONT></TD> 697<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setCacheSize(long)">setCacheSize</A></B>(long cacheSize)</CODE> 698 699<BR> 700 Set the size of the shared memory buffer pool, that is, the size of the 701cache.</TD> 702</TR> 703<TR BGCOLOR="white" CLASS="TableRowColor"> 704<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 705<CODE> void</CODE></FONT></TD> 706<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setChecksum(boolean)">setChecksum</A></B>(boolean checksum)</CODE> 707 708<BR> 709 Configure the database environment to do checksum verification of 710 pages read into the cache from the backing filestore.</TD> 711</TR> 712<TR BGCOLOR="white" CLASS="TableRowColor"> 713<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 714<CODE> void</CODE></FONT></TD> 715<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setCreateDir(java.io.File)">setCreateDir</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> createDir)</CODE> 716 717<BR> 718 Specify which directory a database should be created in or looked for.</TD> 719</TR> 720<TR BGCOLOR="white" CLASS="TableRowColor"> 721<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 722<CODE> void</CODE></FONT></TD> 723<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setDirtyRead(boolean)">setDirtyRead</A></B>(boolean dirtyRead)</CODE> 724 725<BR> 726 <B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)"><CODE>setReadUncommitted(boolean)</CODE></A> to conform to ANSI 727 database isolation terminology.</I></TD> 728</TR> 729<TR BGCOLOR="white" CLASS="TableRowColor"> 730<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 731<CODE> void</CODE></FONT></TD> 732<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setDuplicateComparator(java.util.Comparator)">setDuplicateComparator</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> duplicateComparator)</CODE> 733 734<BR> 735 Set the duplicate data item comparison callback.</TD> 736</TR> 737<TR BGCOLOR="white" CLASS="TableRowColor"> 738<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 739<CODE> void</CODE></FONT></TD> 740<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setEncrypted(java.lang.String)">setEncrypted</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE> 741 742<BR> 743 Set the password used to perform encryption and decryption.</TD> 744</TR> 745<TR BGCOLOR="white" CLASS="TableRowColor"> 746<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 747<CODE> void</CODE></FONT></TD> 748<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)">setErrorHandler</A></B>(<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> errorHandler)</CODE> 749 750<BR> 751 Set the function to be called if an error occurs.</TD> 752</TR> 753<TR BGCOLOR="white" CLASS="TableRowColor"> 754<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 755<CODE> void</CODE></FONT></TD> 756<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)">setErrorPrefix</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> errorPrefix)</CODE> 757 758<BR> 759 Set the prefix string that appears before error messages.</TD> 760</TR> 761<TR BGCOLOR="white" CLASS="TableRowColor"> 762<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 763<CODE> void</CODE></FONT></TD> 764<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)">setErrorStream</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> errorStream)</CODE> 765 766<BR> 767 Set an OutputStream for displaying error messages.</TD> 768</TR> 769<TR BGCOLOR="white" CLASS="TableRowColor"> 770<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 771<CODE> void</CODE></FONT></TD> 772<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setExclusiveCreate(boolean)">setExclusiveCreate</A></B>(boolean exclusiveCreate)</CODE> 773 774<BR> 775 Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to fail if 776 the database already exists.</TD> 777</TR> 778<TR BGCOLOR="white" CLASS="TableRowColor"> 779<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 780<CODE> void</CODE></FONT></TD> 781<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setFeedbackHandler(com.sleepycat.db.FeedbackHandler)">setFeedbackHandler</A></B>(<A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> feedbackHandler)</CODE> 782 783<BR> 784 Set an object whose methods are called to provide feedback.</TD> 785</TR> 786<TR BGCOLOR="white" CLASS="TableRowColor"> 787<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 788<CODE> void</CODE></FONT></TD> 789<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setHashComparator(java.util.Comparator)">setHashComparator</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> hashComparator)</CODE> 790 791<BR> 792 Set the Hash key comparison function.</TD> 793</TR> 794<TR BGCOLOR="white" CLASS="TableRowColor"> 795<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 796<CODE> void</CODE></FONT></TD> 797<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setHasher(com.sleepycat.db.Hasher)">setHasher</A></B>(<A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A> hasher)</CODE> 798 799<BR> 800 Set a database-specific hash function.</TD> 801</TR> 802<TR BGCOLOR="white" CLASS="TableRowColor"> 803<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 804<CODE> void</CODE></FONT></TD> 805<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setHashFillFactor(int)">setHashFillFactor</A></B>(int hashFillFactor)</CODE> 806 807<BR> 808 Set the desired density within the hash table.</TD> 809</TR> 810<TR BGCOLOR="white" CLASS="TableRowColor"> 811<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 812<CODE> void</CODE></FONT></TD> 813<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setHashNumElements(int)">setHashNumElements</A></B>(int hashNumElements)</CODE> 814 815<BR> 816 Set an estimate of the final size of the hash table.</TD> 817</TR> 818<TR BGCOLOR="white" CLASS="TableRowColor"> 819<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 820<CODE> void</CODE></FONT></TD> 821<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)">setMessageHandler</A></B>(<A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> messageHandler)</CODE> 822 823<BR> 824 Set a function to be called with an informational message.</TD> 825</TR> 826<TR BGCOLOR="white" CLASS="TableRowColor"> 827<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 828<CODE> void</CODE></FONT></TD> 829<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)">setMessageStream</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> messageStream)</CODE> 830 831<BR> 832 Set an OutputStream for displaying informational messages.</TD> 833</TR> 834<TR BGCOLOR="white" CLASS="TableRowColor"> 835<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 836<CODE> void</CODE></FONT></TD> 837<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMode(int)">setMode</A></B>(int mode)</CODE> 838 839<BR> 840 On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files 841 created by the database open are created with mode <code>mode</code> 842 (as described in the <code>chmod</code>(2) manual page) and modified 843 by the process' umask value at the time of creation (see the 844 <code>umask</code>(2) manual page).</TD> 845</TR> 846<TR BGCOLOR="white" CLASS="TableRowColor"> 847<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 848<CODE> void</CODE></FONT></TD> 849<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMultiversion(boolean)">setMultiversion</A></B>(boolean multiversion)</CODE> 850 851<BR> 852 Configured the database with support for multiversion concurrency control.</TD> 853</TR> 854<TR BGCOLOR="white" CLASS="TableRowColor"> 855<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 856<CODE> void</CODE></FONT></TD> 857<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setNoMMap(boolean)">setNoMMap</A></B>(boolean noMMap)</CODE> 858 859<BR> 860 Configure the library to not map this database into memory.</TD> 861</TR> 862<TR BGCOLOR="white" CLASS="TableRowColor"> 863<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 864<CODE> void</CODE></FONT></TD> 865<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)">setPageSize</A></B>(int pageSize)</CODE> 866 867<BR> 868 Set the size of the pages used to hold items in the database, in bytes.</TD> 869</TR> 870<TR BGCOLOR="white" CLASS="TableRowColor"> 871<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 872<CODE> void</CODE></FONT></TD> 873<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)">setPanicHandler</A></B>(<A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> panicHandler)</CODE> 874 875<BR> 876 Set the function to be called if the database environment panics.</TD> 877</TR> 878<TR BGCOLOR="white" CLASS="TableRowColor"> 879<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 880<CODE> void</CODE></FONT></TD> 881<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByCallback(int, com.sleepycat.db.PartitionHandler)">setPartitionByCallback</A></B>(int parts, 882 <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A> partitionHandler)</CODE> 883 884<BR> 885 Enable or disable database partitioning, and set the callback that will 886be used for the partitioning.</TD> 887</TR> 888<TR BGCOLOR="white" CLASS="TableRowColor"> 889<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 890<CODE> void</CODE></FONT></TD> 891<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByRange(int, com.sleepycat.db.MultipleDataEntry)">setPartitionByRange</A></B>(int parts, 892 <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</A> keys)</CODE> 893 894<BR> 895 Enable or disable database partitioning, and set key ranges that will be 896 used for the partitioning.</TD> 897</TR> 898<TR BGCOLOR="white" CLASS="TableRowColor"> 899<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 900<CODE> void</CODE></FONT></TD> 901<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionDirs(java.io.File[])">setPartitionDirs</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] dirs)</CODE> 902 903<BR> 904 Specify the array of directories the database extents should be created in or 905looked for.</TD> 906</TR> 907<TR BGCOLOR="white" CLASS="TableRowColor"> 908<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 909<CODE> void</CODE></FONT></TD> 910<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</A></B>(<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> priority)</CODE> 911 912<BR> 913 Set the cache priority for pages referenced by the DB handle.</TD> 914</TR> 915<TR BGCOLOR="white" CLASS="TableRowColor"> 916<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 917<CODE> void</CODE></FONT></TD> 918<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setQueueExtentSize(int)">setQueueExtentSize</A></B>(int queueExtentSize)</CODE> 919 920<BR> 921 Set the size of the extents used to hold pages in a Queue database, 922 specified as a number of pages.</TD> 923</TR> 924<TR BGCOLOR="white" CLASS="TableRowColor"> 925<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 926<CODE> void</CODE></FONT></TD> 927<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setQueueInOrder(boolean)">setQueueInOrder</A></B>(boolean queueInOrder)</CODE> 928 929<BR> 930 Configure <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> to return key/data pairs in 931 order, always returning the key/data item from the head of the 932 queue.</TD> 933</TR> 934<TR BGCOLOR="white" CLASS="TableRowColor"> 935<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 936<CODE> void</CODE></FONT></TD> 937<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReadOnly(boolean)">setReadOnly</A></B>(boolean readOnly)</CODE> 938 939<BR> 940 Configure the database in read-only mode.</TD> 941</TR> 942<TR BGCOLOR="white" CLASS="TableRowColor"> 943<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 944<CODE> void</CODE></FONT></TD> 945<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)">setReadUncommitted</A></B>(boolean readUncommitted)</CODE> 946 947<BR> 948 Configure the database to support read uncommitted.</TD> 949</TR> 950<TR BGCOLOR="white" CLASS="TableRowColor"> 951<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 952<CODE> void</CODE></FONT></TD> 953<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)">setRecordDelimiter</A></B>(int recordDelimiter)</CODE> 954 955<BR> 956 Set the delimiting byte used to mark the end of a record in the backing 957 source file for the Recno access method.</TD> 958</TR> 959<TR BGCOLOR="white" CLASS="TableRowColor"> 960<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 961<CODE> void</CODE></FONT></TD> 962<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordLength(int)">setRecordLength</A></B>(int recordLength)</CODE> 963 964<BR> 965 Specify the database record length, in bytes.</TD> 966</TR> 967<TR BGCOLOR="white" CLASS="TableRowColor"> 968<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 969<CODE> void</CODE></FONT></TD> 970<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)">setRecordNumberAppender</A></B>(<A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A> recnoAppender)</CODE> 971 972<BR> 973 Configure <A HREF="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>Database.append</CODE></A> to call the function after the 974 record number has been selected but before the data has been stored 975 into the database.</TD> 976</TR> 977<TR BGCOLOR="white" CLASS="TableRowColor"> 978<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 979<CODE> void</CODE></FONT></TD> 980<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordPad(int)">setRecordPad</A></B>(int recordPad)</CODE> 981 982<BR> 983 Set the padding character for short, fixed-length records for the Queue 984 and Recno access methods.</TD> 985</TR> 986<TR BGCOLOR="white" CLASS="TableRowColor"> 987<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 988<CODE> void</CODE></FONT></TD> 989<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordSource(java.io.File)">setRecordSource</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> recordSource)</CODE> 990 991<BR> 992 Set the underlying source file for the Recno access method.</TD> 993</TR> 994<TR BGCOLOR="white" CLASS="TableRowColor"> 995<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 996<CODE> void</CODE></FONT></TD> 997<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRenumbering(boolean)">setRenumbering</A></B>(boolean renumbering)</CODE> 998 999<BR> 1000 Configure the logical record numbers to be mutable, and change as 1001 records are added to and deleted from the database.</TD> 1002</TR> 1003<TR BGCOLOR="white" CLASS="TableRowColor"> 1004<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1005<CODE> void</CODE></FONT></TD> 1006<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReverseSplitOff(boolean)">setReverseSplitOff</A></B>(boolean reverseSplitOff)</CODE> 1007 1008<BR> 1009 Configure the Btree to not do reverse splits.</TD> 1010</TR> 1011<TR BGCOLOR="white" CLASS="TableRowColor"> 1012<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1013<CODE> void</CODE></FONT></TD> 1014<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setSnapshot(boolean)">setSnapshot</A></B>(boolean snapshot)</CODE> 1015 1016<BR> 1017 Specify that any specified backing source file be read in its entirety 1018 when the database is opened.</TD> 1019</TR> 1020<TR BGCOLOR="white" CLASS="TableRowColor"> 1021<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1022<CODE> void</CODE></FONT></TD> 1023<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setSortedDuplicates(boolean)">setSortedDuplicates</A></B>(boolean sortedDuplicates)</CODE> 1024 1025<BR> 1026 Configure the database to support sorted, duplicate data items.</TD> 1027</TR> 1028<TR BGCOLOR="white" CLASS="TableRowColor"> 1029<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1030<CODE> void</CODE></FONT></TD> 1031<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)">setTransactional</A></B>(boolean transactional)</CODE> 1032 1033<BR> 1034 Enclose the database open within a transaction.</TD> 1035</TR> 1036<TR BGCOLOR="white" CLASS="TableRowColor"> 1037<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1038<CODE> void</CODE></FONT></TD> 1039<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactionNotDurable(boolean)">setTransactionNotDurable</A></B>(boolean transactionNotDurable)</CODE> 1040 1041<BR> 1042 Configure the database environment to not write log records for this 1043 database.</TD> 1044</TR> 1045<TR BGCOLOR="white" CLASS="TableRowColor"> 1046<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1047<CODE> void</CODE></FONT></TD> 1048<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTruncate(boolean)">setTruncate</A></B>(boolean truncate)</CODE> 1049 1050<BR> 1051 Configure the database to be physically truncated by truncating the 1052 underlying file, discarding all previous databases it might have 1053 held.</TD> 1054</TR> 1055<TR BGCOLOR="white" CLASS="TableRowColor"> 1056<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1057<CODE> void</CODE></FONT></TD> 1058<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setType(com.sleepycat.db.DatabaseType)">setType</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A> type)</CODE> 1059 1060<BR> 1061 Configure the type of the database.</TD> 1062</TR> 1063<TR BGCOLOR="white" CLASS="TableRowColor"> 1064<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 1065<CODE> void</CODE></FONT></TD> 1066<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setUnsortedDuplicates(boolean)">setUnsortedDuplicates</A></B>(boolean unsortedDuplicates)</CODE> 1067 1068<BR> 1069 Configure the database to support unsorted duplicate data items.</TD> 1070</TR> 1071</TABLE> 1072 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 1073<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 1074<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 1075<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 1076</TR> 1077<TR BGCOLOR="white" CLASS="TableRowColor"> 1078<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 1079</TR> 1080</TABLE> 1081 1082<P> 1083 1084<!-- ============ FIELD DETAIL =========== --> 1085 1086<A NAME="field_detail"><!-- --></A> 1087<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 1088<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 1089<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 1090<B>Field Detail</B></FONT></TH> 1091</TR> 1092</TABLE> 1093 1094<A NAME="DEFAULT"><!-- --></A><H3> 1095DEFAULT</H3> 1096<PRE> 1097public static final <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> <B>DEFAULT</B></PRE> 1098<DL> 1099<DD>An instance created using the default constructor is initialized 1100 with the system's default settings. 1101<P> 1102<DL> 1103</DL> 1104</DL> 1105 1106<!-- ========= CONSTRUCTOR DETAIL ======== --> 1107 1108<A NAME="constructor_detail"><!-- --></A> 1109<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 1110<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 1111<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 1112<B>Constructor Detail</B></FONT></TH> 1113</TR> 1114</TABLE> 1115 1116<A NAME="DatabaseConfig()"><!-- --></A><H3> 1117DatabaseConfig</H3> 1118<PRE> 1119public <B>DatabaseConfig</B>()</PRE> 1120<DL> 1121<DD>An instance created using the default constructor is initialized with 1122 the system's default settings. 1123<P> 1124</DL> 1125 1126<!-- ============ METHOD DETAIL ========== --> 1127 1128<A NAME="method_detail"><!-- --></A> 1129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 1130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 1131<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 1132<B>Method Detail</B></FONT></TH> 1133</TR> 1134</TABLE> 1135 1136<A NAME="cloneConfig()"><!-- --></A><H3> 1137cloneConfig</H3> 1138<PRE> 1139public <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> <B>cloneConfig</B>()</PRE> 1140<DL> 1141<DD>Returns a copy of this configuration object. 1142<P> 1143<DD><DL> 1144</DL> 1145</DD> 1146<DD><DL> 1147</DL> 1148</DD> 1149</DL> 1150<HR> 1151 1152<A NAME="setAllowCreate(boolean)"><!-- --></A><H3> 1153setAllowCreate</H3> 1154<PRE> 1155public void <B>setAllowCreate</B>(boolean allowCreate)</PRE> 1156<DL> 1157<DD>Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to create 1158 the database if it does not already exist. 1159 <p> 1160<P> 1161<DD><DL> 1162</DL> 1163</DD> 1164<DD><DL> 1165<DT><B>Parameters:</B><DD><CODE>allowCreate</CODE> - If true, configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to 1166 create the database if it does not already exist.</DL> 1167</DD> 1168</DL> 1169<HR> 1170 1171<A NAME="getAllowCreate()"><!-- --></A><H3> 1172getAllowCreate</H3> 1173<PRE> 1174public boolean <B>getAllowCreate</B>()</PRE> 1175<DL> 1176<DD>Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured 1177 to create the database if it does not already exist. 1178<p> 1179This method may be called at any time during the life of the application. 1180<p> 1181<P> 1182<DD><DL> 1183</DL> 1184</DD> 1185<DD><DL> 1186 1187<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured 1188 to create the database if it does not already exist.</DL> 1189</DD> 1190</DL> 1191<HR> 1192 1193<A NAME="setBtreeComparator(java.util.Comparator)"><!-- --></A><H3> 1194setBtreeComparator</H3> 1195<PRE> 1196public void <B>setBtreeComparator</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> btreeComparator)</PRE> 1197<DL> 1198<DD>By default, a byte by byte lexicographic comparison is used for 1199 btree keys. To customize the comparison, supply a different 1200 Comparator. 1201 <p> 1202 The <code>compare</code> method is passed the byte arrays representing 1203 keys that are stored in the database. If you know how your data is 1204 organized in the byte array, then you can write a comparison routine that 1205 directly examines the contents of the arrays. Otherwise, you have to 1206 reconstruct your original objects, and then perform the comparison. 1207<P> 1208<DD><DL> 1209</DL> 1210</DD> 1211<DD><DL> 1212</DL> 1213</DD> 1214</DL> 1215<HR> 1216 1217<A NAME="getBtreeComparator()"><!-- --></A><H3> 1218getBtreeComparator</H3> 1219<PRE> 1220public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> <B>getBtreeComparator</B>()</PRE> 1221<DL> 1222<DD><DL> 1223</DL> 1224</DD> 1225<DD><DL> 1226</DL> 1227</DD> 1228</DL> 1229<HR> 1230 1231<A NAME="setBtreeMinKey(int)"><!-- --></A><H3> 1232setBtreeMinKey</H3> 1233<PRE> 1234public void <B>setBtreeMinKey</B>(int btMinKey)</PRE> 1235<DL> 1236<DD>Set the minimum number of key/data pairs intended to be stored on any 1237 single Btree leaf page. 1238 <p> 1239 This value is used to determine if key or data items will be stored 1240 on overflow pages instead of Btree leaf pages. The value must be 1241 at least 2; if the value is not explicitly set, a value of 2 is used. 1242 <p> 1243 This method configures a database, not only operations performed using 1244the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 1245 <p> 1246 This method may not be called after the database is opened. 1247If the database already exists when it is opened, 1248the information specified to this method will be ignored. 1249 <p> 1250<P> 1251<DD><DL> 1252</DL> 1253</DD> 1254<DD><DL> 1255<DT><B>Parameters:</B><DD><CODE>btMinKey</CODE> - The minimum number of key/data pairs intended to be stored on any 1256 single Btree leaf page.</DL> 1257</DD> 1258</DL> 1259<HR> 1260 1261<A NAME="getBtreeMinKey()"><!-- --></A><H3> 1262getBtreeMinKey</H3> 1263<PRE> 1264public int <B>getBtreeMinKey</B>()</PRE> 1265<DL> 1266<DD>Return the minimum number of key/data pairs intended to be stored 1267 on any single Btree leaf page. 1268<p> 1269This method may be called at any time during the life of the application. 1270<p> 1271<P> 1272<DD><DL> 1273</DL> 1274</DD> 1275<DD><DL> 1276 1277<DT><B>Returns:</B><DD>The minimum number of key/data pairs intended to be stored 1278 on any single Btree leaf page.</DL> 1279</DD> 1280</DL> 1281<HR> 1282 1283<A NAME="setByteOrder(int)"><!-- --></A><H3> 1284setByteOrder</H3> 1285<PRE> 1286public void <B>setByteOrder</B>(int byteOrder)</PRE> 1287<DL> 1288<DD>Set the byte order for integers in the stored database metadata. 1289 <p> 1290 The host byte order of the machine where the process is running will 1291 be used if no byte order is set. 1292 <p> 1293 <b> 1294 The access methods provide no guarantees about the byte ordering of the 1295 application data stored in the database, and applications are 1296 responsible for maintaining any necessary ordering. 1297 </b> 1298 <p> 1299 This method configures a database, not only operations performed using 1300the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 1301 <p> 1302 This method may not be called after the database is opened. 1303If the database already exists when it is opened, 1304the information specified to this method will be ignored. 1305 If creating additional databases in a single physical file, information 1306 specified to this method will be ignored and the byte order of the 1307 existing databases will be used. 1308 <p> 1309<P> 1310<DD><DL> 1311</DL> 1312</DD> 1313<DD><DL> 1314<DT><B>Parameters:</B><DD><CODE>byteOrder</CODE> - The byte order as an integer; for example, big endian order is the 1315 number 4,321, and little endian order is the number 1,234.</DL> 1316</DD> 1317</DL> 1318<HR> 1319 1320<A NAME="getByteOrder()"><!-- --></A><H3> 1321getByteOrder</H3> 1322<PRE> 1323public int <B>getByteOrder</B>()</PRE> 1324<DL> 1325<DD>Return the database byte order; a byte order of 4,321 indicates a 1326 big endian order, and a byte order of 1,234 indicates a little 1327 endian order. 1328<p> 1329This method may be called at any time during the life of the application. 1330<p> 1331<P> 1332<DD><DL> 1333</DL> 1334</DD> 1335<DD><DL> 1336 1337<DT><B>Returns:</B><DD>The database byte order; a byte order of 4,321 indicates a 1338 big endian order, and a byte order of 1,234 indicates a little 1339 endian order.</DL> 1340</DD> 1341</DL> 1342<HR> 1343 1344<A NAME="getByteSwapped()"><!-- --></A><H3> 1345getByteSwapped</H3> 1346<PRE> 1347public boolean <B>getByteSwapped</B>()</PRE> 1348<DL> 1349<DD>Return if the underlying database files were created on an architecture 1350 of the same byte order as the current one. 1351 <p> 1352 This information may be used to determine whether application data 1353 needs to be adjusted for this architecture or not. 1354 <p> 1355 This method may not be called before the 1356database has been opened. 1357 <p> 1358<P> 1359<DD><DL> 1360</DL> 1361</DD> 1362<DD><DL> 1363 1364<DT><B>Returns:</B><DD>Return false if the underlying database files were created on an 1365 architecture of the same byte order as the current one, and true if 1366 they were not (that is, big-endian on a little-endian machine, or 1367 vice versa).</DL> 1368</DD> 1369</DL> 1370<HR> 1371 1372<A NAME="setBtreeCompressor(com.sleepycat.db.BtreeCompressor)"><!-- --></A><H3> 1373setBtreeCompressor</H3> 1374<PRE> 1375public void <B>setBtreeCompressor</B>(<A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A> btreeCompressor)</PRE> 1376<DL> 1377<DD>Set the Btree compression callbacks. 1378<P> 1379<DD><DL> 1380</DL> 1381</DD> 1382<DD><DL> 1383</DL> 1384</DD> 1385</DL> 1386<HR> 1387 1388<A NAME="getBtreeCompressor()"><!-- --></A><H3> 1389getBtreeCompressor</H3> 1390<PRE> 1391public <A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A> <B>getBtreeCompressor</B>()</PRE> 1392<DL> 1393<DD>Get the Btree compression callbacks. 1394<P> 1395<DD><DL> 1396</DL> 1397</DD> 1398<DD><DL> 1399</DL> 1400</DD> 1401</DL> 1402<HR> 1403 1404<A NAME="setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)"><!-- --></A><H3> 1405setBtreePrefixCalculator</H3> 1406<PRE> 1407public void <B>setBtreePrefixCalculator</B>(<A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A> btreePrefixCalculator)</PRE> 1408<DL> 1409<DD>Set the Btree prefix callback. The prefix callback is used to determine 1410 the amount by which keys stored on the Btree internal pages can be 1411 safely truncated without losing their uniqueness. See the 1412 <a href="../../../../programmer_reference/bt_conf.html#am_conf_bt_prefix" target="_top">Btree prefix 1413 comparison</a> section of the Berkeley DB Reference Guide for more 1414 details about how this works. The usefulness of this is data-dependent, 1415 but can produce significantly reduced tree sizes and search times in 1416 some data sets. 1417 <p> 1418 If no prefix callback or key comparison callback is specified by the 1419 application, a default lexical comparison function is used to calculate 1420 prefixes. If no prefix callback is specified and a key comparison 1421 callback is specified, no prefix function is used. It is an error to 1422 specify a prefix function without also specifying a Btree key comparison 1423 function. 1424<P> 1425<DD><DL> 1426</DL> 1427</DD> 1428<DD><DL> 1429</DL> 1430</DD> 1431</DL> 1432<HR> 1433 1434<A NAME="getBtreePrefixCalculator()"><!-- --></A><H3> 1435getBtreePrefixCalculator</H3> 1436<PRE> 1437public <A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A> <B>getBtreePrefixCalculator</B>()</PRE> 1438<DL> 1439<DD>Return the Btree prefix callback. 1440<p> 1441This method may be called at any time during the life of the application. 1442<p> 1443<P> 1444<DD><DL> 1445</DL> 1446</DD> 1447<DD><DL> 1448 1449<DT><B>Returns:</B><DD>The Btree prefix callback.</DL> 1450</DD> 1451</DL> 1452<HR> 1453 1454<A NAME="setCacheSize(long)"><!-- --></A><H3> 1455setCacheSize</H3> 1456<PRE> 1457public void <B>setCacheSize</B>(long cacheSize)</PRE> 1458<DL> 1459<DD>Set the size of the shared memory buffer pool, that is, the size of the 1460cache. 1461<p> 1462The cache should be the size of the normal working data set of the 1463application, with some small amount of additional memory for unusual 1464situations. (Note: the working set is not the same as the number of 1465pages accessed simultaneously, and is usually much larger.) 1466<p> 1467The default cache size is 256KB, and may not be specified as less than 146820KB. Any cache size less than 500MB is automatically increased by 25% 1469to account for buffer pool overhead; cache sizes larger than 500MB are 1470used as specified. The current maximum size of a single cache is 4GB. 1471(All sizes are in powers-of-two, that is, 256KB is 2^18 not 256,000.) 1472<p> 1473Because databases opened within database environments use the cache 1474specified to the environment, it is an error to attempt to configure a 1475cache size in a database created within an environment. 1476<p> 1477This method may not be called after the database is opened. 1478<p> 1479This method may be called at any time during the life of the application. 1480<p> 1481<P> 1482<DD><DL> 1483</DL> 1484</DD> 1485<DD><DL> 1486<DT><B>Parameters:</B><DD><CODE>cacheSize</CODE> - The size of the shared memory buffer pool, that is, the size of the 1487cache. 1488<p> 1489<p> 1490<DT><B>Throws:</B> 1491<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1492</DD> 1493</DL> 1494<HR> 1495 1496<A NAME="getCacheSize()"><!-- --></A><H3> 1497getCacheSize</H3> 1498<PRE> 1499public long <B>getCacheSize</B>()</PRE> 1500<DL> 1501<DD>Return the size of the shared memory buffer pool, that is, the cache. 1502<p> 1503This method may be called at any time during the life of the application. 1504<p> 1505<P> 1506<DD><DL> 1507</DL> 1508</DD> 1509<DD><DL> 1510 1511<DT><B>Returns:</B><DD>The size of the shared memory buffer pool, that is, the cache.</DL> 1512</DD> 1513</DL> 1514<HR> 1515 1516<A NAME="setCreateDir(java.io.File)"><!-- --></A><H3> 1517setCreateDir</H3> 1518<PRE> 1519public void <B>setCreateDir</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> createDir)</PRE> 1520<DL> 1521<DD>Specify which directory a database should be created in or looked for. 1522<p> 1523<P> 1524<DD><DL> 1525</DL> 1526</DD> 1527<DD><DL> 1528<DT><B>Parameters:</B><DD><CODE>createDir</CODE> - The directory will be used to create or locate the database file specified in 1529the openDatabase method call. The directory must be one of the directories 1530in the environment list specified by EnvironmentConfig.addDataDirectory. 1531<p> 1532<p> 1533<DT><B>Throws:</B> 1534<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1535</DD> 1536</DL> 1537<HR> 1538 1539<A NAME="getCreateDir()"><!-- --></A><H3> 1540getCreateDir</H3> 1541<PRE> 1542public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getCreateDir</B>()</PRE> 1543<DL> 1544<DD>Return the directory a database will/has been created in or looked for. 1545<p> 1546This method may be called at any time during the life of the application. 1547<p> 1548<P> 1549<DD><DL> 1550</DL> 1551</DD> 1552<DD><DL> 1553 1554<DT><B>Returns:</B><DD>The directory a database will/has been created in or looked for.</DL> 1555</DD> 1556</DL> 1557<HR> 1558 1559<A NAME="setCacheCount(int)"><!-- --></A><H3> 1560setCacheCount</H3> 1561<PRE> 1562public void <B>setCacheCount</B>(int cacheCount)</PRE> 1563<DL> 1564<DD>Set the number of shared memory buffer pools, that is, the number of 1565caches. 1566<p> 1567It is possible to specify caches larger than 4GB and/or large enough 1568they cannot be allocated contiguously on some architectures. For 1569example, some releases of Solaris limit the amount of memory that may 1570be allocated contiguously by a process. This method allows applications 1571to break the cache broken up into a number of equally sized, separate 1572pieces of memory. 1573<p> 1574<p> 1575Because databases opened within database environments use the cache 1576specified to the environment, it is an error to attempt to configure 1577multiple caches in a database created within an environment. 1578<p> 1579This method may not be called after the database is opened. 1580<p> 1581This method may be called at any time during the life of the application. 1582<p> 1583<P> 1584<DD><DL> 1585</DL> 1586</DD> 1587<DD><DL> 1588<DT><B>Parameters:</B><DD><CODE>cacheCount</CODE> - The number of shared memory buffer pools, that is, the number of caches. 1589<p> 1590<p> 1591<DT><B>Throws:</B> 1592<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1593</DD> 1594</DL> 1595<HR> 1596 1597<A NAME="getCacheCount()"><!-- --></A><H3> 1598getCacheCount</H3> 1599<PRE> 1600public int <B>getCacheCount</B>()</PRE> 1601<DL> 1602<DD>Return the number of shared memory buffer pools, that is, the number 1603 of caches. 1604<p> 1605This method may be called at any time during the life of the application. 1606<p> 1607<P> 1608<DD><DL> 1609</DL> 1610</DD> 1611<DD><DL> 1612 1613<DT><B>Returns:</B><DD>The number of shared memory buffer pools, that is, the number 1614 of caches.</DL> 1615</DD> 1616</DL> 1617<HR> 1618 1619<A NAME="setChecksum(boolean)"><!-- --></A><H3> 1620setChecksum</H3> 1621<PRE> 1622public void <B>setChecksum</B>(boolean checksum)</PRE> 1623<DL> 1624<DD>Configure the database environment to do checksum verification of 1625 pages read into the cache from the backing filestore. 1626 <p> 1627 Berkeley DB uses the SHA1 Secure Hash Algorithm if encryption is 1628 also configured for this database, and a general hash algorithm if 1629 it is not. 1630 <p> 1631 Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle 1632(and any other library handles opened within the scope of that handle). 1633 <p> 1634 If the database already exists when the database is opened, any database 1635configuration specified by this method 1636will be ignored. 1637 If creating additional databases in a file, the checksum behavior 1638 specified must be consistent with the existing databases in the file or 1639 an error will be returned. 1640 <p> 1641<P> 1642<DD><DL> 1643</DL> 1644</DD> 1645<DD><DL> 1646<DT><B>Parameters:</B><DD><CODE>checksum</CODE> - If true, configure the database environment to do checksum verification 1647 of pages read into the cache from the backing filestore. 1648 A value of false is illegal to this method, that is, once set, the 1649configuration cannot be cleared.</DL> 1650</DD> 1651</DL> 1652<HR> 1653 1654<A NAME="getChecksum()"><!-- --></A><H3> 1655getChecksum</H3> 1656<PRE> 1657public boolean <B>getChecksum</B>()</PRE> 1658<DL> 1659<DD>Return true if the database environment is configured to do checksum 1660 verification of pages read into the cache from the backing 1661 filestore. 1662<p> 1663This method may be called at any time during the life of the application. 1664<p> 1665<P> 1666<DD><DL> 1667</DL> 1668</DD> 1669<DD><DL> 1670 1671<DT><B>Returns:</B><DD>True if the database environment is configured to do checksum 1672 verification of pages read into the cache from the backing 1673 filestore.</DL> 1674</DD> 1675</DL> 1676<HR> 1677 1678<A NAME="setReadUncommitted(boolean)"><!-- --></A><H3> 1679setReadUncommitted</H3> 1680<PRE> 1681public void <B>setReadUncommitted</B>(boolean readUncommitted)</PRE> 1682<DL> 1683<DD>Configure the database to support read uncommitted. 1684 <p> 1685 Read operations on the database may request the return of modified 1686 but not yet committed data. This flag must be specified on all 1687 <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles used to perform read uncommitted or database 1688 updates, otherwise requests for read uncommitted may not be honored and 1689 the read may block. 1690 <p> 1691<P> 1692<DD><DL> 1693</DL> 1694</DD> 1695<DD><DL> 1696<DT><B>Parameters:</B><DD><CODE>readUncommitted</CODE> - If true, configure the database to support read uncommitted.</DL> 1697</DD> 1698</DL> 1699<HR> 1700 1701<A NAME="getReadUncommitted()"><!-- --></A><H3> 1702getReadUncommitted</H3> 1703<PRE> 1704public boolean <B>getReadUncommitted</B>()</PRE> 1705<DL> 1706<DD>Return true if the database is configured to support read uncommitted. 1707<p> 1708This method may be called at any time during the life of the application. 1709<p> 1710<P> 1711<DD><DL> 1712</DL> 1713</DD> 1714<DD><DL> 1715 1716<DT><B>Returns:</B><DD>True if the database is configured to support read uncommitted.</DL> 1717</DD> 1718</DL> 1719<HR> 1720 1721<A NAME="setDirtyRead(boolean)"><!-- --></A><H3> 1722setDirtyRead</H3> 1723<PRE> 1724public void <B>setDirtyRead</B>(boolean dirtyRead)</PRE> 1725<DL> 1726<DD><B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)"><CODE>setReadUncommitted(boolean)</CODE></A> to conform to ANSI 1727 database isolation terminology.</I> 1728<P> 1729<DD>Configure the database to support read uncommitted. 1730 <p> 1731 Read operations on the database may request the return of modified 1732 but not yet committed data. This flag must be specified on all 1733 <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles used to perform read uncommitted or database 1734 updates, otherwise requests for read uncommitted may not be honored and 1735 the read may block. 1736 <p> 1737<P> 1738<DD><DL> 1739</DL> 1740</DD> 1741<DD><DL> 1742<DT><B>Parameters:</B><DD><CODE>dirtyRead</CODE> - If true, configure the database to support read uncommitted. 1743 <p></DL> 1744</DD> 1745</DL> 1746<HR> 1747 1748<A NAME="getDirtyRead()"><!-- --></A><H3> 1749getDirtyRead</H3> 1750<PRE> 1751public boolean <B>getDirtyRead</B>()</PRE> 1752<DL> 1753<DD><B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()"><CODE>getReadUncommitted()</CODE></A> to conform to ANSI 1754 database isolation terminology.</I> 1755<P> 1756<DD>Return true if the database is configured to support read uncommitted. 1757<p> 1758This method may be called at any time during the life of the application. 1759<p> 1760<P> 1761<DD><DL> 1762</DL> 1763</DD> 1764<DD><DL> 1765 1766<DT><B>Returns:</B><DD>True if the database is configured to support read uncommitted. 1767 <p></DL> 1768</DD> 1769</DL> 1770<HR> 1771 1772<A NAME="setDuplicateComparator(java.util.Comparator)"><!-- --></A><H3> 1773setDuplicateComparator</H3> 1774<PRE> 1775public void <B>setDuplicateComparator</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> duplicateComparator)</PRE> 1776<DL> 1777<DD>Set the duplicate data item comparison callback. The comparison 1778 function is called whenever it is necessary to compare a data item 1779 specified by the application with a data item currently stored in the 1780 database. This comparator is only used if 1781 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setSortedDuplicates(boolean)"><CODE>DatabaseConfig.setSortedDuplicates</CODE></A> is also configured. 1782 <p> 1783 If no comparison function is specified, the data items are compared 1784 lexically, with shorter data items collating before longer data items. 1785 <p> 1786 The <code>compare</code> method is passed the byte arrays representing 1787 data items in the database. If you know how your data is organized in 1788 the byte array, then you can write a comparison routine that directly 1789 examines the contents of the arrays. Otherwise, you have to 1790 reconstruct your original objects, and then perform the comparison. 1791 <p> 1792<P> 1793<DD><DL> 1794</DL> 1795</DD> 1796<DD><DL> 1797<DT><B>Parameters:</B><DD><CODE>duplicateComparator</CODE> - the comparison callback for duplicate data items.</DL> 1798</DD> 1799</DL> 1800<HR> 1801 1802<A NAME="getDuplicateComparator()"><!-- --></A><H3> 1803getDuplicateComparator</H3> 1804<PRE> 1805public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> <B>getDuplicateComparator</B>()</PRE> 1806<DL> 1807<DD><DL> 1808</DL> 1809</DD> 1810<DD><DL> 1811</DL> 1812</DD> 1813</DL> 1814<HR> 1815 1816<A NAME="setEncrypted(java.lang.String)"><!-- --></A><H3> 1817setEncrypted</H3> 1818<PRE> 1819public void <B>setEncrypted</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</PRE> 1820<DL> 1821<DD>Set the password used to perform encryption and decryption. 1822 <p> 1823 Because databases opened within environments use the password 1824 specified to the environment, it is an error to attempt to set a 1825 password in a database created within an environment. 1826 <p> 1827 Berkeley DB uses the Rijndael/AES (also known as the Advanced 1828 Encryption Standard and Federal Information Processing 1829 Standard (FIPS) 197) algorithm for encryption or decryption. 1830<P> 1831<DD><DL> 1832</DL> 1833</DD> 1834<DD><DL> 1835</DL> 1836</DD> 1837</DL> 1838<HR> 1839 1840<A NAME="getEncrypted()"><!-- --></A><H3> 1841getEncrypted</H3> 1842<PRE> 1843public boolean <B>getEncrypted</B>()</PRE> 1844<DL> 1845<DD>Return true if the database has been configured to perform encryption. 1846<p> 1847This method may be called at any time during the life of the application. 1848<p> 1849<P> 1850<DD><DL> 1851</DL> 1852</DD> 1853<DD><DL> 1854 1855<DT><B>Returns:</B><DD>True if the database has been configured to perform encryption.</DL> 1856</DD> 1857</DL> 1858<HR> 1859 1860<A NAME="setErrorHandler(com.sleepycat.db.ErrorHandler)"><!-- --></A><H3> 1861setErrorHandler</H3> 1862<PRE> 1863public void <B>setErrorHandler</B>(<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> errorHandler)</PRE> 1864<DL> 1865<DD>Set the function to be called if an error occurs. 1866<p> 1867When an error occurs in the Berkeley DB library, an exception is thrown. 1868In some cases, however, the error information returned to the 1869application may be insufficient to completely describe the cause of the 1870error, especially during initial application debugging. 1871<p> 1872The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>DatabaseConfig.setErrorHandler</CODE></A> methods are used to enhance the mechanism for reporting 1873error messages to the application. In some cases, when an error occurs, 1874Berkeley DB will invoke the ErrorHandler's object error method. It is 1875up to this method to display the error message in an appropriate manner. 1876<p> 1877Alternatively, applications can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setErrorStream</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><CODE>DatabaseConfig.setErrorStream</CODE></A> to 1878display the additional information via an output stream. Applications 1879should not mix these approaches. 1880<p> 1881This error-logging enhancement does not slow performance or significantly 1882increase application size, and may be run during normal operation as well 1883as during application debugging. 1884<p> 1885For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, 1886calling this method affects the entire environment and is equivalent to 1887calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A>. 1888<p> 1889This method may be called at any time during the life of the application. 1890<p> 1891<P> 1892<DD><DL> 1893</DL> 1894</DD> 1895<DD><DL> 1896<DT><B>Parameters:</B><DD><CODE>errorHandler</CODE> - The function to be called if an error occurs.</DL> 1897</DD> 1898</DL> 1899<HR> 1900 1901<A NAME="getErrorHandler()"><!-- --></A><H3> 1902getErrorHandler</H3> 1903<PRE> 1904public <A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> <B>getErrorHandler</B>()</PRE> 1905<DL> 1906<DD>Return the function to be called if an error occurs. 1907<p> 1908This method may be called at any time during the life of the application. 1909<p> 1910<P> 1911<DD><DL> 1912</DL> 1913</DD> 1914<DD><DL> 1915 1916<DT><B>Returns:</B><DD>The function to be called if an error occurs.</DL> 1917</DD> 1918</DL> 1919<HR> 1920 1921<A NAME="setErrorPrefix(java.lang.String)"><!-- --></A><H3> 1922setErrorPrefix</H3> 1923<PRE> 1924public void <B>setErrorPrefix</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> errorPrefix)</PRE> 1925<DL> 1926<DD>Set the prefix string that appears before error messages. 1927<p> 1928For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, 1929calling this method affects the entire environment and is equivalent to 1930calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><CODE>EnvironmentConfig.setErrorPrefix</CODE></A>. 1931<p> 1932This method may be called at any time during the life of the application. 1933<p> 1934<P> 1935<DD><DL> 1936</DL> 1937</DD> 1938<DD><DL> 1939<DT><B>Parameters:</B><DD><CODE>errorPrefix</CODE> - The prefix string that appears before error messages.</DL> 1940</DD> 1941</DL> 1942<HR> 1943 1944<A NAME="getErrorPrefix()"><!-- --></A><H3> 1945getErrorPrefix</H3> 1946<PRE> 1947public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getErrorPrefix</B>()</PRE> 1948<DL> 1949<DD>Return the prefix string that appears before error messages. 1950<p> 1951This method may be called at any time during the life of the application. 1952<p> 1953<P> 1954<DD><DL> 1955</DL> 1956</DD> 1957<DD><DL> 1958 1959<DT><B>Returns:</B><DD>The prefix string that appears before error messages.</DL> 1960</DD> 1961</DL> 1962<HR> 1963 1964<A NAME="setErrorStream(java.io.OutputStream)"><!-- --></A><H3> 1965setErrorStream</H3> 1966<PRE> 1967public void <B>setErrorStream</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> errorStream)</PRE> 1968<DL> 1969<DD>Set an OutputStream for displaying error messages. 1970<p> 1971When an error occurs in the Berkeley DB library, an exception is thrown. 1972In some cases, however, the error information returned to the 1973application may be insufficient to completely describe the cause of the 1974error, especially during initial application debugging. 1975<p> 1976The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setErrorStream</CODE></A> and 1977<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><CODE>DatabaseConfig.setErrorStream</CODE></A> methods are used to enhance 1978the mechanism for reporting error messages to the application by setting 1979a OutputStream to be used for displaying additional Berkeley DB error 1980messages. In some cases, when an error occurs, Berkeley DB will output 1981an additional error message to the specified stream. 1982<p> 1983The error message will consist of the prefix string and a colon 1984("<b>:</b>") (if a prefix string was previously specified using 1985<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><CODE>EnvironmentConfig.setErrorPrefix</CODE></A> or <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)"><CODE>DatabaseConfig.setErrorPrefix</CODE></A>), an error string, and a trailing newline character. 1986<p> 1987Setting errorStream to null unconfigures the interface. 1988<p> 1989Alternatively, applications can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>DatabaseConfig.setErrorHandler</CODE></A> to capture 1990the additional error information in a way that does not use output 1991streams. Applications should not mix these approaches. 1992<p> 1993This error-logging enhancement does not slow performance or significantly 1994increase application size, and may be run during normal operation as well 1995as during application debugging. 1996<p> 1997This method may be called at any time during the life of the application. 1998<p> 1999<P> 2000<DD><DL> 2001</DL> 2002</DD> 2003<DD><DL> 2004<DT><B>Parameters:</B><DD><CODE>errorStream</CODE> - The application-specified OutputStream for error messages.</DL> 2005</DD> 2006</DL> 2007<HR> 2008 2009<A NAME="getErrorStream()"><!-- --></A><H3> 2010getErrorStream</H3> 2011<PRE> 2012public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> <B>getErrorStream</B>()</PRE> 2013<DL> 2014<DD>Return the an OutputStream for displaying error messages. 2015<p> 2016This method may be called at any time during the life of the application. 2017<p> 2018<P> 2019<DD><DL> 2020</DL> 2021</DD> 2022<DD><DL> 2023 2024<DT><B>Returns:</B><DD>The an OutputStream for displaying error messages.</DL> 2025</DD> 2026</DL> 2027<HR> 2028 2029<A NAME="setExclusiveCreate(boolean)"><!-- --></A><H3> 2030setExclusiveCreate</H3> 2031<PRE> 2032public void <B>setExclusiveCreate</B>(boolean exclusiveCreate)</PRE> 2033<DL> 2034<DD>Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to fail if 2035 the database already exists. 2036 <p> 2037 The exclusiveCreate mode is only meaningful if specified with the 2038 allowCreate mode. 2039 <p> 2040<P> 2041<DD><DL> 2042</DL> 2043</DD> 2044<DD><DL> 2045<DT><B>Parameters:</B><DD><CODE>exclusiveCreate</CODE> - If true, configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to 2046 fail if the database already exists.</DL> 2047</DD> 2048</DL> 2049<HR> 2050 2051<A NAME="getExclusiveCreate()"><!-- --></A><H3> 2052getExclusiveCreate</H3> 2053<PRE> 2054public boolean <B>getExclusiveCreate</B>()</PRE> 2055<DL> 2056<DD>Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured 2057 to fail if the database already exists. 2058<p> 2059This method may be called at any time during the life of the application. 2060<p> 2061<P> 2062<DD><DL> 2063</DL> 2064</DD> 2065<DD><DL> 2066 2067<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured 2068 to fail if the database already exists.</DL> 2069</DD> 2070</DL> 2071<HR> 2072 2073<A NAME="setFeedbackHandler(com.sleepycat.db.FeedbackHandler)"><!-- --></A><H3> 2074setFeedbackHandler</H3> 2075<PRE> 2076public void <B>setFeedbackHandler</B>(<A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> feedbackHandler)</PRE> 2077<DL> 2078<DD>Set an object whose methods are called to provide feedback. 2079<p> 2080Some operations performed by the Berkeley DB library can take 2081non-trivial amounts of time. This method can be used by applications 2082to monitor progress within these operations. When an operation is 2083likely to take a long time, Berkeley DB will call the object's methods 2084with progress information. 2085<p> 2086It is up to the object's methods to display this information in an 2087appropriate manner. 2088<p> 2089This method configures only operations performed using a single a 2090<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle 2091<p> 2092This method may be called at any time during the life of the application. 2093<p> 2094<P> 2095<DD><DL> 2096</DL> 2097</DD> 2098<DD><DL> 2099<DT><B>Parameters:</B><DD><CODE>feedbackHandler</CODE> - An object whose methods are called to provide feedback.</DL> 2100</DD> 2101</DL> 2102<HR> 2103 2104<A NAME="getFeedbackHandler()"><!-- --></A><H3> 2105getFeedbackHandler</H3> 2106<PRE> 2107public <A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> <B>getFeedbackHandler</B>()</PRE> 2108<DL> 2109<DD>Return the object's methods to be called to provide feedback. 2110<p> 2111This method may be called at any time during the life of the application. 2112<p> 2113<P> 2114<DD><DL> 2115</DL> 2116</DD> 2117<DD><DL> 2118 2119<DT><B>Returns:</B><DD>The object's methods to be called to provide feedback.</DL> 2120</DD> 2121</DL> 2122<HR> 2123 2124<A NAME="setHashFillFactor(int)"><!-- --></A><H3> 2125setHashFillFactor</H3> 2126<PRE> 2127public void <B>setHashFillFactor</B>(int hashFillFactor)</PRE> 2128<DL> 2129<DD>Set the desired density within the hash table. 2130 <p> 2131 If no value is specified, the fill factor will be selected dynamically 2132 as pages are filled. 2133 <p> 2134 The density is an approximation of the number of keys allowed to 2135 accumulate in any one bucket, determining when the hash table grows or 2136 shrinks. If you know the average sizes of the keys and data in your 2137 data set, setting the fill factor can enhance performance. A reasonable 2138 rule computing fill factor is to set it to the following: 2139 <blockquote><pre> 2140 (pagesize - 32) / (average_key_size + average_data_size + 8) 2141 </pre></blockquote> 2142 <p> 2143 This method configures a database, not only operations performed using 2144the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 2145 <p> 2146 This method may not be called after the database is opened. 2147If the database already exists when it is opened, 2148the information specified to this method will be ignored. 2149 <p> 2150<P> 2151<DD><DL> 2152</DL> 2153</DD> 2154<DD><DL> 2155<DT><B>Parameters:</B><DD><CODE>hashFillFactor</CODE> - The desired density within the hash table.</DL> 2156</DD> 2157</DL> 2158<HR> 2159 2160<A NAME="getHashFillFactor()"><!-- --></A><H3> 2161getHashFillFactor</H3> 2162<PRE> 2163public int <B>getHashFillFactor</B>()</PRE> 2164<DL> 2165<DD>Return the hash table density. 2166<p> 2167This method may be called at any time during the life of the application. 2168<p> 2169<P> 2170<DD><DL> 2171</DL> 2172</DD> 2173<DD><DL> 2174 2175<DT><B>Returns:</B><DD>The hash table density.</DL> 2176</DD> 2177</DL> 2178<HR> 2179 2180<A NAME="setHashComparator(java.util.Comparator)"><!-- --></A><H3> 2181setHashComparator</H3> 2182<PRE> 2183public void <B>setHashComparator</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> hashComparator)</PRE> 2184<DL> 2185<DD>Set the Hash key comparison function. The comparison function is called 2186 whenever it is necessary to compare a key specified by the application with 2187 a key currently stored in the database. 2188 <p> 2189 If no comparison function is specified, a byte-by-byte comparison is 2190 performed. 2191 <p> 2192 The <code>compare</code> method is passed the byte arrays representing 2193 keys that are stored in the database. If you know how your data is 2194 organized in the byte array, then you can write a comparison routine that 2195 directly examines the contents of the arrays. Otherwise, you have to 2196 reconstruct your original objects, and then perform the comparison. 2197<P> 2198<DD><DL> 2199</DL> 2200</DD> 2201<DD><DL> 2202</DL> 2203</DD> 2204</DL> 2205<HR> 2206 2207<A NAME="getHashComparator()"><!-- --></A><H3> 2208getHashComparator</H3> 2209<PRE> 2210public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> <B>getHashComparator</B>()</PRE> 2211<DL> 2212<DD>Return the Comparator used to compare keys in a Hash database. 2213<p> 2214This method may be called at any time during the life of the application. 2215<p> 2216<P> 2217<DD><DL> 2218</DL> 2219</DD> 2220<DD><DL> 2221 2222<DT><B>Returns:</B><DD>The Comparator used to compare keys in a Hash database.</DL> 2223</DD> 2224</DL> 2225<HR> 2226 2227<A NAME="setHasher(com.sleepycat.db.Hasher)"><!-- --></A><H3> 2228setHasher</H3> 2229<PRE> 2230public void <B>setHasher</B>(<A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A> hasher)</PRE> 2231<DL> 2232<DD>Set a database-specific hash function. 2233 <p> 2234 If no hash function is specified, a default hash function is used. 2235 Because no hash function performs equally well on all possible data, 2236 the user may find that the built-in hash function performs poorly 2237 with a particular data set. 2238 <p> 2239 This method configures operations performed using the specified 2240<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> object, not all operations performed on the underlying 2241database. 2242 <p> 2243 This method may not be called after the database is opened. 2244If the database already exists when it is opened, 2245the information specified to this method must be the same as that 2246historically used to create the database or corruption can occur. 2247 <p> 2248<P> 2249<DD><DL> 2250</DL> 2251</DD> 2252<DD><DL> 2253<DT><B>Parameters:</B><DD><CODE>hasher</CODE> - A database-specific hash function.</DL> 2254</DD> 2255</DL> 2256<HR> 2257 2258<A NAME="getHasher()"><!-- --></A><H3> 2259getHasher</H3> 2260<PRE> 2261public <A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A> <B>getHasher</B>()</PRE> 2262<DL> 2263<DD>Return the database-specific hash function. 2264<p> 2265This method may be called at any time during the life of the application. 2266<p> 2267<P> 2268<DD><DL> 2269</DL> 2270</DD> 2271<DD><DL> 2272 2273<DT><B>Returns:</B><DD>The database-specific hash function.</DL> 2274</DD> 2275</DL> 2276<HR> 2277 2278<A NAME="setHashNumElements(int)"><!-- --></A><H3> 2279setHashNumElements</H3> 2280<PRE> 2281public void <B>setHashNumElements</B>(int hashNumElements)</PRE> 2282<DL> 2283<DD>Set an estimate of the final size of the hash table. 2284 <p> 2285 In order for the estimate to be used when creating the database, the 2286 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setHashFillFactor(int)"><CODE>DatabaseConfig.setHashFillFactor</CODE></A> method must also be called. 2287 If the estimate or fill factor are not set or are set too low, hash 2288 tables will still expand gracefully as keys are entered, although a 2289 slight performance degradation may be noticed. 2290 <p> 2291 This method configures a database, not only operations performed using 2292the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 2293 <p> 2294 This method may not be called after the database is opened. 2295If the database already exists when it is opened, 2296the information specified to this method will be ignored. 2297 <p> 2298<P> 2299<DD><DL> 2300</DL> 2301</DD> 2302<DD><DL> 2303<DT><B>Parameters:</B><DD><CODE>hashNumElements</CODE> - An estimate of the final size of the hash table.</DL> 2304</DD> 2305</DL> 2306<HR> 2307 2308<A NAME="getHashNumElements()"><!-- --></A><H3> 2309getHashNumElements</H3> 2310<PRE> 2311public int <B>getHashNumElements</B>()</PRE> 2312<DL> 2313<DD>Return the estimate of the final size of the hash table. 2314<p> 2315This method may be called at any time during the life of the application. 2316<p> 2317<P> 2318<DD><DL> 2319</DL> 2320</DD> 2321<DD><DL> 2322 2323<DT><B>Returns:</B><DD>The estimate of the final size of the hash table.</DL> 2324</DD> 2325</DL> 2326<HR> 2327 2328<A NAME="setMessageHandler(com.sleepycat.db.MessageHandler)"><!-- --></A><H3> 2329setMessageHandler</H3> 2330<PRE> 2331public void <B>setMessageHandler</B>(<A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> messageHandler)</PRE> 2332<DL> 2333<DD>Set a function to be called with an informational message. 2334<p> 2335There are interfaces in the Berkeley DB library which either directly 2336output informational messages or statistical information, or configure 2337the library to output such messages when performing other operations, 2338<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><CODE>EnvironmentConfig.setVerboseDeadlock</CODE></A> for example. 2339<p> 2340The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A> and 2341<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>DatabaseConfig.setMessageHandler</CODE></A> methods are used to display 2342these messages for the application. 2343<p> 2344Setting messageHandler to null unconfigures the interface. 2345<p> 2346Alternatively, you can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A> 2347and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><CODE>DatabaseConfig.setMessageStream</CODE></A> to send the additional 2348information directly to an output streams. You should not mix these 2349approaches. 2350<p> 2351For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, 2352calling this method affects the entire environment and is equivalent to 2353calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A>. 2354<p> 2355This method may be called at any time during the life of the application. 2356<p> 2357<P> 2358<DD><DL> 2359</DL> 2360</DD> 2361<DD><DL> 2362<DT><B>Parameters:</B><DD><CODE>messageHandler</CODE> - The application-specified function for informational messages.</DL> 2363</DD> 2364</DL> 2365<HR> 2366 2367<A NAME="getMessageHandler()"><!-- --></A><H3> 2368getMessageHandler</H3> 2369<PRE> 2370public <A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> <B>getMessageHandler</B>()</PRE> 2371<DL> 2372<DD>Return the function to be called with an informational message. 2373<p> 2374This method may be called at any time during the life of the application. 2375<p> 2376<P> 2377<DD><DL> 2378</DL> 2379</DD> 2380<DD><DL> 2381 2382<DT><B>Returns:</B><DD>The function to be called with an informational message.</DL> 2383</DD> 2384</DL> 2385<HR> 2386 2387<A NAME="setMessageStream(java.io.OutputStream)"><!-- --></A><H3> 2388setMessageStream</H3> 2389<PRE> 2390public void <B>setMessageStream</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> messageStream)</PRE> 2391<DL> 2392<DD>Set an OutputStream for displaying informational messages. 2393<p> 2394There are interfaces in the Berkeley DB library which either directly 2395output informational messages or statistical information, or configure 2396the library to output such messages when performing other operations, 2397<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><CODE>EnvironmentConfig.setVerboseDeadlock</CODE></A> for example. 2398<p> 2399The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A> and 2400<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><CODE>DatabaseConfig.setMessageStream</CODE></A> methods are used to display 2401these messages for the application. In this case, the message will 2402include a trailing newline character. 2403<p> 2404Setting messageStream to null unconfigures the interface. 2405<p> 2406Alternatively, you can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A> 2407and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>DatabaseConfig.setMessageHandler</CODE></A> to capture the additional 2408information in a way that does not use output streams. You should not 2409mix these approaches. 2410<p> 2411For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, 2412calling this method affects the entire environment and is equivalent to 2413calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A>. 2414<p> 2415This method may be called at any time during the life of the application. 2416<p> 2417<P> 2418<DD><DL> 2419</DL> 2420</DD> 2421<DD><DL> 2422<DT><B>Parameters:</B><DD><CODE>messageStream</CODE> - The application-specified OutputStream for informational messages.</DL> 2423</DD> 2424</DL> 2425<HR> 2426 2427<A NAME="getMessageStream()"><!-- --></A><H3> 2428getMessageStream</H3> 2429<PRE> 2430public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> <B>getMessageStream</B>()</PRE> 2431<DL> 2432<DD>Return the an OutputStream for displaying informational messages. 2433<p> 2434This method may be called at any time during the life of the application. 2435<p> 2436<P> 2437<DD><DL> 2438</DL> 2439</DD> 2440<DD><DL> 2441 2442<DT><B>Returns:</B><DD>The an OutputStream for displaying informational messages.</DL> 2443</DD> 2444</DL> 2445<HR> 2446 2447<A NAME="setMode(int)"><!-- --></A><H3> 2448setMode</H3> 2449<PRE> 2450public void <B>setMode</B>(int mode)</PRE> 2451<DL> 2452<DD>On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files 2453 created by the database open are created with mode <code>mode</code> 2454 (as described in the <code>chmod</code>(2) manual page) and modified 2455 by the process' umask value at the time of creation (see the 2456 <code>umask</code>(2) manual page). Created files are owned by the 2457 process owner; the group ownership of created files is based on the 2458 system and directory defaults, and is not further specified by Berkeley 2459 DB. System shared memory segments created by the database open are 2460 created with mode <code>mode</code>, unmodified by the process' umask 2461 value. If <code>mode</code> is 0, the database open will use a default 2462 mode of readable and writable by both owner and group. 2463 <p> 2464 On Windows systems, the mode parameter is ignored. 2465 <p> 2466<P> 2467<DD><DL> 2468</DL> 2469</DD> 2470<DD><DL> 2471<DT><B>Parameters:</B><DD><CODE>mode</CODE> - the mode used to create files</DL> 2472</DD> 2473</DL> 2474<HR> 2475 2476<A NAME="getMode()"><!-- --></A><H3> 2477getMode</H3> 2478<PRE> 2479public long <B>getMode</B>()</PRE> 2480<DL> 2481<DD>Return the mode used to create files. 2482<p> 2483This method may be called at any time during the life of the application. 2484<p> 2485<P> 2486<DD><DL> 2487</DL> 2488</DD> 2489<DD><DL> 2490 2491<DT><B>Returns:</B><DD>The mode used to create files.</DL> 2492</DD> 2493</DL> 2494<HR> 2495 2496<A NAME="setMultiversion(boolean)"><!-- --></A><H3> 2497setMultiversion</H3> 2498<PRE> 2499public void <B>setMultiversion</B>(boolean multiversion)</PRE> 2500<DL> 2501<DD>Configured the database with support for multiversion concurrency control. 2502 This will cause updates to the database to follow a copy-on-write 2503 protocol, which is required to support Snapshot Isolation. See 2504 <A HREF="../../../com/sleepycat/db/TransactionConfig.html#setSnapshot(boolean)"><CODE>TransactionConfig.setSnapshot(boolean)</CODE></A>) for more information. 2505 Multiversion access requires that the database be opened 2506 in a transaction and is not supported for queue databases. 2507 <p> 2508<P> 2509<DD><DL> 2510</DL> 2511</DD> 2512<DD><DL> 2513<DT><B>Parameters:</B><DD><CODE>multiversion</CODE> - If true, configure the database with support for multiversion concurrency 2514 control.</DL> 2515</DD> 2516</DL> 2517<HR> 2518 2519<A NAME="getMultiversion()"><!-- --></A><H3> 2520getMultiversion</H3> 2521<PRE> 2522public boolean <B>getMultiversion</B>()</PRE> 2523<DL> 2524<DD>Return true if the database is configured for multiversion concurrency control. 2525<p> 2526This method may be called at any time during the life of the application. 2527<p> 2528<P> 2529<DD><DL> 2530</DL> 2531</DD> 2532<DD><DL> 2533 2534<DT><B>Returns:</B><DD>True if the database is configured for multiversion concurrency control.</DL> 2535</DD> 2536</DL> 2537<HR> 2538 2539<A NAME="setNoMMap(boolean)"><!-- --></A><H3> 2540setNoMMap</H3> 2541<PRE> 2542public void <B>setNoMMap</B>(boolean noMMap)</PRE> 2543<DL> 2544<DD>Configure the library to not map this database into memory. 2545 <p> 2546<P> 2547<DD><DL> 2548</DL> 2549</DD> 2550<DD><DL> 2551<DT><B>Parameters:</B><DD><CODE>noMMap</CODE> - If true, configure the library to not map this database into memory.</DL> 2552</DD> 2553</DL> 2554<HR> 2555 2556<A NAME="getNoMMap()"><!-- --></A><H3> 2557getNoMMap</H3> 2558<PRE> 2559public boolean <B>getNoMMap</B>()</PRE> 2560<DL> 2561<DD>Return true if the library is configured to not map this database into 2562 memory. 2563<p> 2564This method may be called at any time during the life of the application. 2565<p> 2566<P> 2567<DD><DL> 2568</DL> 2569</DD> 2570<DD><DL> 2571 2572<DT><B>Returns:</B><DD>True if the library is configured to not map this database into 2573 memory.</DL> 2574</DD> 2575</DL> 2576<HR> 2577 2578<A NAME="setPageSize(int)"><!-- --></A><H3> 2579setPageSize</H3> 2580<PRE> 2581public void <B>setPageSize</B>(int pageSize)</PRE> 2582<DL> 2583<DD>Set the size of the pages used to hold items in the database, in bytes. 2584 <p> 2585 The minimum page size is 512 bytes, the maximum page size is 64K bytes, 2586 and the page size must be a power-of-two. If the page size is not 2587 explicitly set, one is selected based on the underlying filesystem I/O 2588 block size. The automatically selected size has a lower limit of 512 2589 bytes and an upper limit of 16K bytes. 2590 <p> 2591 This method configures a database, not only operations performed using 2592the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 2593 <p> 2594 This method may not be called after the database is opened. 2595If the database already exists when it is opened, 2596the information specified to this method will be ignored. 2597 If creating additional databases in a file, the page size specified must 2598 be consistent with the existing databases in the file or an error will 2599 be returned. 2600 <p> 2601<P> 2602<DD><DL> 2603</DL> 2604</DD> 2605<DD><DL> 2606<DT><B>Parameters:</B><DD><CODE>pageSize</CODE> - The size of the pages used to hold items in the database, in bytes.</DL> 2607</DD> 2608</DL> 2609<HR> 2610 2611<A NAME="getPageSize()"><!-- --></A><H3> 2612getPageSize</H3> 2613<PRE> 2614public int <B>getPageSize</B>()</PRE> 2615<DL> 2616<DD>Return the size of the pages used to hold items in the database, in bytes. 2617<p> 2618This method may be called at any time during the life of the application. 2619<p> 2620<P> 2621<DD><DL> 2622</DL> 2623</DD> 2624<DD><DL> 2625 2626<DT><B>Returns:</B><DD>The size of the pages used to hold items in the database, in bytes.</DL> 2627</DD> 2628</DL> 2629<HR> 2630 2631<A NAME="setPanicHandler(com.sleepycat.db.PanicHandler)"><!-- --></A><H3> 2632setPanicHandler</H3> 2633<PRE> 2634public void <B>setPanicHandler</B>(<A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> panicHandler)</PRE> 2635<DL> 2636<DD>Set the function to be called if the database environment panics. 2637<p> 2638Errors can occur in the Berkeley DB library where the only solution is 2639to shut down the application and run recovery (for example, if Berkeley 2640DB is unable to allocate heap memory). In such cases, the Berkeley DB 2641methods will throw a <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>. It is often easier 2642to simply exit the application when such errors occur rather than 2643gracefully return up the stack. This method specifies a function to be 2644called when <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A> is about to be thrown from a 2645Berkeley DB method. 2646<p> 2647For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, 2648calling this method affects the entire environment and is equivalent to 2649calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)"><CODE>EnvironmentConfig.setPanicHandler</CODE></A>. 2650<p> 2651This method may be called at any time during the life of the application. 2652<p> 2653<P> 2654<DD><DL> 2655</DL> 2656</DD> 2657<DD><DL> 2658<DT><B>Parameters:</B><DD><CODE>panicHandler</CODE> - The function to be called if the database environment panics.</DL> 2659</DD> 2660</DL> 2661<HR> 2662 2663<A NAME="getPanicHandler()"><!-- --></A><H3> 2664getPanicHandler</H3> 2665<PRE> 2666public <A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> <B>getPanicHandler</B>()</PRE> 2667<DL> 2668<DD>Return the function to be called if the database environment panics. 2669<p> 2670This method may be called at any time during the life of the application. 2671<p> 2672<P> 2673<DD><DL> 2674</DL> 2675</DD> 2676<DD><DL> 2677 2678<DT><B>Returns:</B><DD>The function to be called if the database environment panics.</DL> 2679</DD> 2680</DL> 2681<HR> 2682 2683<A NAME="setPartitionByCallback(int, com.sleepycat.db.PartitionHandler)"><!-- --></A><H3> 2684setPartitionByCallback</H3> 2685<PRE> 2686public void <B>setPartitionByCallback</B>(int parts, 2687 <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A> partitionHandler)</PRE> 2688<DL> 2689<DD>Enable or disable database partitioning, and set the callback that will 2690be used for the partitioning. 2691<p> 2692This method may only be called before opening a database. 2693<p> 2694<P> 2695<DD><DL> 2696</DL> 2697</DD> 2698<DD><DL> 2699<DT><B>Parameters:</B><DD><CODE>parts</CODE> - The number of partitions that will be created. 2700<p><DD><CODE>partitionHandler</CODE> - The function to be called to determine which partition a key resides in.</DL> 2701</DD> 2702</DL> 2703<HR> 2704 2705<A NAME="setPartitionByRange(int, com.sleepycat.db.MultipleDataEntry)"><!-- --></A><H3> 2706setPartitionByRange</H3> 2707<PRE> 2708public void <B>setPartitionByRange</B>(int parts, 2709 <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</A> keys)</PRE> 2710<DL> 2711<DD>Enable or disable database partitioning, and set key ranges that will be 2712 used for the partitioning. 2713<p> 2714This method may only be called before opening a database. 2715<p> 2716<P> 2717<DD><DL> 2718</DL> 2719</DD> 2720<DD><DL> 2721<DT><B>Parameters:</B><DD><CODE>parts</CODE> - The number of partitions that will be created. 2722<p><DD><CODE>keys</CODE> - A MultipleDatabaseEntry that contains the boundary keys for partitioning.</DL> 2723</DD> 2724</DL> 2725<HR> 2726 2727<A NAME="getPartitionHandler()"><!-- --></A><H3> 2728getPartitionHandler</H3> 2729<PRE> 2730public <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A> <B>getPartitionHandler</B>()</PRE> 2731<DL> 2732<DD>Return the function to be called to determine which partition a key resides in. 2733<p> 2734This method may be called at any time during the life of the application. 2735<p> 2736<P> 2737<DD><DL> 2738</DL> 2739</DD> 2740<DD><DL> 2741 2742<DT><B>Returns:</B><DD>The function to be called to determine which partition a key resides in.</DL> 2743</DD> 2744</DL> 2745<HR> 2746 2747<A NAME="getPartitionParts()"><!-- --></A><H3> 2748getPartitionParts</H3> 2749<PRE> 2750public int <B>getPartitionParts</B>()</PRE> 2751<DL> 2752<DD>Return the number of partitions the database is configured for. 2753<p> 2754This method may be called at any time during the life of the application. 2755<p> 2756<P> 2757<DD><DL> 2758</DL> 2759</DD> 2760<DD><DL> 2761 2762<DT><B>Returns:</B><DD>The number of partitions the database is configured for.</DL> 2763</DD> 2764</DL> 2765<HR> 2766 2767<A NAME="getPartitionKeys()"><!-- --></A><H3> 2768getPartitionKeys</H3> 2769<PRE> 2770public <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> <B>getPartitionKeys</B>()</PRE> 2771<DL> 2772<DD>Return the array of keys the database is configured to partition with. 2773<p> 2774This method may be called at any time during the life of the application. 2775<p> 2776<P> 2777<DD><DL> 2778</DL> 2779</DD> 2780<DD><DL> 2781 2782<DT><B>Returns:</B><DD>The array of keys the database is configured to partition with.</DL> 2783</DD> 2784</DL> 2785<HR> 2786 2787<A NAME="setPartitionDirs(java.io.File[])"><!-- --></A><H3> 2788setPartitionDirs</H3> 2789<PRE> 2790public void <B>setPartitionDirs</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] dirs)</PRE> 2791<DL> 2792<DD>Specify the array of directories the database extents should be created in or 2793looked for. If the number of directories is less than the number of partitions, 2794the directories will be used in a round robin fasion. 2795<p> 2796This method may only be called before the database is opened. 2797<p> 2798<P> 2799<DD><DL> 2800</DL> 2801</DD> 2802<DD><DL> 2803<DT><B>Parameters:</B><DD><CODE>dirs</CODE> - The array of directories the database extents should be created in or looked 2804for.</DL> 2805</DD> 2806</DL> 2807<HR> 2808 2809<A NAME="getPartitionDirs()"><!-- --></A><H3> 2810getPartitionDirs</H3> 2811<PRE> 2812public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] <B>getPartitionDirs</B>()</PRE> 2813<DL> 2814<DD>Return the array of directories the database extents should be created in or 2815looked for. If the number of directories is less than the number of partitions, 2816the directories will be used in a round robin fasion. 2817<p> 2818This method may be called at any time during the life of the application. 2819<p> 2820<P> 2821<DD><DL> 2822</DL> 2823</DD> 2824<DD><DL> 2825 2826<DT><B>Returns:</B><DD>The array of directories the database extents should be created in or looked 2827for.</DL> 2828</DD> 2829</DL> 2830<HR> 2831 2832<A NAME="setPriority(com.sleepycat.db.CacheFilePriority)"><!-- --></A><H3> 2833setPriority</H3> 2834<PRE> 2835public void <B>setPriority</B>(<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> priority)</PRE> 2836<DL> 2837<DD>Set the cache priority for pages referenced by the DB handle. 2838 <p> 2839 The priority of a page biases the replacement algorithm to be more or less 2840 likely to discard a page when space is needed in the buffer pool. The bias 2841 is temporary, and pages will eventually be discarded if they are not 2842 referenced again. The priority setting is only advisory, and does not 2843 guarantee pages will be treated in a specific way. 2844 <p> 2845<P> 2846<DD><DL> 2847</DL> 2848</DD> 2849<DD><DL> 2850<DT><B>Parameters:</B><DD><CODE>priority</CODE> - The desired cache priority.</DL> 2851</DD> 2852</DL> 2853<HR> 2854 2855<A NAME="getPriority()"><!-- --></A><H3> 2856getPriority</H3> 2857<PRE> 2858public <A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> <B>getPriority</B>()</PRE> 2859<DL> 2860<DD>Return the the cache priority for pages referenced by this handle. 2861<p> 2862This method may be called at any time during the life of the application. 2863<p> 2864<P> 2865<DD><DL> 2866</DL> 2867</DD> 2868<DD><DL> 2869 2870<DT><B>Returns:</B><DD>The the cache priority for pages referenced by this handle.</DL> 2871</DD> 2872</DL> 2873<HR> 2874 2875<A NAME="setQueueExtentSize(int)"><!-- --></A><H3> 2876setQueueExtentSize</H3> 2877<PRE> 2878public void <B>setQueueExtentSize</B>(int queueExtentSize)</PRE> 2879<DL> 2880<DD>Set the size of the extents used to hold pages in a Queue database, 2881 specified as a number of pages. 2882 <p> 2883 Each extent is created as a separate physical file. If no extent 2884 size is set, the default behavior is to create only a single 2885 underlying database file. 2886 <p> 2887 This method configures a database, not only operations performed using 2888the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 2889 <p> 2890 This method may not be called after the database is opened. 2891If the database already exists when it is opened, 2892the information specified to this method will be ignored. 2893 <p> 2894<P> 2895<DD><DL> 2896</DL> 2897</DD> 2898<DD><DL> 2899<DT><B>Parameters:</B><DD><CODE>queueExtentSize</CODE> - The number of pages in a Queue database extent.</DL> 2900</DD> 2901</DL> 2902<HR> 2903 2904<A NAME="getQueueExtentSize()"><!-- --></A><H3> 2905getQueueExtentSize</H3> 2906<PRE> 2907public int <B>getQueueExtentSize</B>()</PRE> 2908<DL> 2909<DD>Return the size of the extents used to hold pages in a Queue database, 2910 specified as a number of pages. 2911<p> 2912This method may be called at any time during the life of the application. 2913<p> 2914<P> 2915<DD><DL> 2916</DL> 2917</DD> 2918<DD><DL> 2919 2920<DT><B>Returns:</B><DD>The size of the extents used to hold pages in a Queue database, 2921 specified as a number of pages.</DL> 2922</DD> 2923</DL> 2924<HR> 2925 2926<A NAME="setQueueInOrder(boolean)"><!-- --></A><H3> 2927setQueueInOrder</H3> 2928<PRE> 2929public void <B>setQueueInOrder</B>(boolean queueInOrder)</PRE> 2930<DL> 2931<DD>Configure <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> to return key/data pairs in 2932 order, always returning the key/data item from the head of the 2933 queue. 2934 <p> 2935 The default behavior of queue databases is optimized for multiple 2936 readers, and does not guarantee that record will be retrieved in the 2937 order they are added to the queue. Specifically, if a writing 2938 thread adds multiple records to an empty queue, reading threads may 2939 skip some of the initial records when the next call to retrieve a 2940 key/data pair returns. 2941 <p> 2942 This flag configures the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method to verify 2943 that the record being returned is in fact the head of the queue. 2944 This will increase contention and reduce concurrency when there are 2945 many reading threads. 2946 <p> 2947 Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle 2948(and any other library handles opened within the scope of that handle). 2949 <p> 2950<P> 2951<DD><DL> 2952</DL> 2953</DD> 2954<DD><DL> 2955<DT><B>Parameters:</B><DD><CODE>queueInOrder</CODE> - If true, configure the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method to return 2956 key/data pairs in order, always returning the key/data item from the 2957 head of the queue. 2958 A value of false is illegal to this method, that is, once set, the 2959configuration cannot be cleared.</DL> 2960</DD> 2961</DL> 2962<HR> 2963 2964<A NAME="getQueueInOrder()"><!-- --></A><H3> 2965getQueueInOrder</H3> 2966<PRE> 2967public boolean <B>getQueueInOrder</B>()</PRE> 2968<DL> 2969<DD>Return true if the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method is configured to return 2970 key/data pairs in order, always returning the key/data item from the 2971 head of the queue. 2972<p> 2973This method may be called at any time during the life of the application. 2974<p> 2975<P> 2976<DD><DL> 2977</DL> 2978</DD> 2979<DD><DL> 2980 2981<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method is configured to return 2982 key/data pairs in order, always returning the key/data item from the 2983 head of the queue.</DL> 2984</DD> 2985</DL> 2986<HR> 2987 2988<A NAME="setReadOnly(boolean)"><!-- --></A><H3> 2989setReadOnly</H3> 2990<PRE> 2991public void <B>setReadOnly</B>(boolean readOnly)</PRE> 2992<DL> 2993<DD>Configure the database in read-only mode. 2994 <p> 2995 Any attempt to modify items in the database will fail, regardless 2996 of the actual permissions of any underlying files. 2997 <p> 2998<P> 2999<DD><DL> 3000</DL> 3001</DD> 3002<DD><DL> 3003<DT><B>Parameters:</B><DD><CODE>readOnly</CODE> - If true, configure the database in read-only mode.</DL> 3004</DD> 3005</DL> 3006<HR> 3007 3008<A NAME="getReadOnly()"><!-- --></A><H3> 3009getReadOnly</H3> 3010<PRE> 3011public boolean <B>getReadOnly</B>()</PRE> 3012<DL> 3013<DD>Return true if the database is configured in read-only mode. 3014<p> 3015This method may be called at any time during the life of the application. 3016<p> 3017<P> 3018<DD><DL> 3019</DL> 3020</DD> 3021<DD><DL> 3022 3023<DT><B>Returns:</B><DD>True if the database is configured in read-only mode.</DL> 3024</DD> 3025</DL> 3026<HR> 3027 3028<A NAME="setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)"><!-- --></A><H3> 3029setRecordNumberAppender</H3> 3030<PRE> 3031public void <B>setRecordNumberAppender</B>(<A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A> recnoAppender)</PRE> 3032<DL> 3033<DD>Configure <A HREF="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>Database.append</CODE></A> to call the function after the 3034 record number has been selected but before the data has been stored 3035 into the database. 3036 <p> 3037 This method configures operations performed using the specified 3038<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> object, not all operations performed on the underlying 3039database. 3040 <p> 3041 This method may not be called after the database is opened. 3042 <p> 3043<P> 3044<DD><DL> 3045</DL> 3046</DD> 3047<DD><DL> 3048<DT><B>Parameters:</B><DD><CODE>recnoAppender</CODE> - The function to call after the record number has been selected but 3049 before the data has been stored into the database.</DL> 3050</DD> 3051</DL> 3052<HR> 3053 3054<A NAME="getRecordNumberAppender()"><!-- --></A><H3> 3055getRecordNumberAppender</H3> 3056<PRE> 3057public <A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A> <B>getRecordNumberAppender</B>()</PRE> 3058<DL> 3059<DD>Return the function to call after the record number has been 3060 selected but before the data has been stored into the database. 3061<p> 3062This method may be called at any time during the life of the application. 3063<p> 3064<P> 3065<DD><DL> 3066</DL> 3067</DD> 3068<DD><DL> 3069 3070<DT><B>Returns:</B><DD>The function to call after the record number has been 3071 selected but before the data has been stored into the database.</DL> 3072</DD> 3073</DL> 3074<HR> 3075 3076<A NAME="setRecordDelimiter(int)"><!-- --></A><H3> 3077setRecordDelimiter</H3> 3078<PRE> 3079public void <B>setRecordDelimiter</B>(int recordDelimiter)</PRE> 3080<DL> 3081<DD>Set the delimiting byte used to mark the end of a record in the backing 3082 source file for the Recno access method. 3083 <p> 3084 This byte is used for variable length records if a backing source 3085 file is specified. If a backing source file is specified and no 3086 delimiting byte was specified, newline characters (that is, ASCII 3087 0x0a) are interpreted as end-of-record markers. 3088 <p> 3089 This method configures a database, not only operations performed using 3090the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 3091 <p> 3092 This method may not be called after the database is opened. 3093If the database already exists when it is opened, 3094the information specified to this method will be ignored. 3095 <p> 3096<P> 3097<DD><DL> 3098</DL> 3099</DD> 3100<DD><DL> 3101<DT><B>Parameters:</B><DD><CODE>recordDelimiter</CODE> - The delimiting byte used to mark the end of a record in the backing 3102 source file for the Recno access method.</DL> 3103</DD> 3104</DL> 3105<HR> 3106 3107<A NAME="getRecordDelimiter()"><!-- --></A><H3> 3108getRecordDelimiter</H3> 3109<PRE> 3110public int <B>getRecordDelimiter</B>()</PRE> 3111<DL> 3112<DD>Return the delimiting byte used to mark the end of a record in the 3113 backing source file for the Recno access method. 3114<p> 3115This method may be called at any time during the life of the application. 3116<p> 3117<P> 3118<DD><DL> 3119</DL> 3120</DD> 3121<DD><DL> 3122 3123<DT><B>Returns:</B><DD>The delimiting byte used to mark the end of a record in the 3124 backing source file for the Recno access method.</DL> 3125</DD> 3126</DL> 3127<HR> 3128 3129<A NAME="setRecordLength(int)"><!-- --></A><H3> 3130setRecordLength</H3> 3131<PRE> 3132public void <B>setRecordLength</B>(int recordLength)</PRE> 3133<DL> 3134<DD>Specify the database record length, in bytes. 3135 <p> 3136 For the Queue access method, specify the record length. For the 3137 Queue access method, the record length must be enough smaller than 3138 the database's page size that at least one record plus the database 3139 page's metadata information can fit on each database page. 3140 <p> 3141 For the Recno access method, specify the records are fixed-length, 3142 not byte-delimited, and the record length. 3143 <p> 3144 Any records added to the database that are less than the specified 3145 length are automatically padded (see 3146 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordPad(int)"><CODE>DatabaseConfig.setRecordPad</CODE></A> for more information). 3147 <p> 3148 Any attempt to insert records into the database that are greater 3149 than the specified length will cause the call to fail. 3150 <p> 3151 This method configures a database, not only operations performed using 3152the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 3153 <p> 3154 This method may not be called after the database is opened. 3155If the database already exists when it is opened, 3156the information specified to this method will be ignored. 3157 <p> 3158<P> 3159<DD><DL> 3160</DL> 3161</DD> 3162<DD><DL> 3163<DT><B>Parameters:</B><DD><CODE>recordLength</CODE> - The database record length, in bytes.</DL> 3164</DD> 3165</DL> 3166<HR> 3167 3168<A NAME="getRecordLength()"><!-- --></A><H3> 3169getRecordLength</H3> 3170<PRE> 3171public int <B>getRecordLength</B>()</PRE> 3172<DL> 3173<DD>Return the database record length, in bytes. 3174<p> 3175This method may be called at any time during the life of the application. 3176<p> 3177<P> 3178<DD><DL> 3179</DL> 3180</DD> 3181<DD><DL> 3182 3183<DT><B>Returns:</B><DD>The database record length, in bytes.</DL> 3184</DD> 3185</DL> 3186<HR> 3187 3188<A NAME="setBtreeRecordNumbers(boolean)"><!-- --></A><H3> 3189setBtreeRecordNumbers</H3> 3190<PRE> 3191public void <B>setBtreeRecordNumbers</B>(boolean btreeRecordNumbers)</PRE> 3192<DL> 3193<DD>Configure the Btree to support retrieval by record number. 3194 <p> 3195 Logical record numbers in Btree databases are mutable in the face of 3196 record insertion or deletion. 3197 <p> 3198 Maintaining record counts within a Btree introduces a serious point 3199 of contention, namely the page locations where the record counts are 3200 stored. In addition, the entire database must be locked during both 3201 insertions and deletions, effectively single-threading the database 3202 for those operations. Configuring a Btree for retrieval by record 3203 number can result in serious performance degradation for some 3204 applications and data sets. 3205 <p> 3206 Retrieval by record number may not be configured for a Btree that also 3207 supports duplicate data items. 3208 <p> 3209 Calling this method affects the database, including all threads of 3210control accessing the database. 3211 <p> 3212 If the database already exists when the database is opened, any database 3213configuration specified by this method 3214must be the same as the existing database or an error 3215will be returned. 3216 <p> 3217<P> 3218<DD><DL> 3219</DL> 3220</DD> 3221<DD><DL> 3222<DT><B>Parameters:</B><DD><CODE>btreeRecordNumbers</CODE> - If true, configure the Btree to support retrieval by record number. 3223 A value of false is illegal to this method, that is, once set, the 3224configuration cannot be cleared.</DL> 3225</DD> 3226</DL> 3227<HR> 3228 3229<A NAME="getBtreeRecordNumbers()"><!-- --></A><H3> 3230getBtreeRecordNumbers</H3> 3231<PRE> 3232public boolean <B>getBtreeRecordNumbers</B>()</PRE> 3233<DL> 3234<DD>Return true if the Btree is configured to support retrieval by record number. 3235<p> 3236This method may be called at any time during the life of the application. 3237<p> 3238<P> 3239<DD><DL> 3240</DL> 3241</DD> 3242<DD><DL> 3243 3244<DT><B>Returns:</B><DD>True if the Btree is configured to support retrieval by record number.</DL> 3245</DD> 3246</DL> 3247<HR> 3248 3249<A NAME="setRecordPad(int)"><!-- --></A><H3> 3250setRecordPad</H3> 3251<PRE> 3252public void <B>setRecordPad</B>(int recordPad)</PRE> 3253<DL> 3254<DD>Set the padding character for short, fixed-length records for the Queue 3255 and Recno access methods. 3256 <p> 3257 If no pad character is specified, "space" characters (that is, ASCII 3258 0x20) are used for padding. 3259 <p> 3260 This method configures a database, not only operations performed using 3261the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. 3262 <p> 3263 This method may not be called after the database is opened. 3264If the database already exists when it is opened, 3265the information specified to this method will be ignored. 3266 <p> 3267<P> 3268<DD><DL> 3269</DL> 3270</DD> 3271<DD><DL> 3272<DT><B>Parameters:</B><DD><CODE>recordPad</CODE> - The padding character for short, fixed-length records for the Queue 3273 and Recno access methods.</DL> 3274</DD> 3275</DL> 3276<HR> 3277 3278<A NAME="getRecordPad()"><!-- --></A><H3> 3279getRecordPad</H3> 3280<PRE> 3281public int <B>getRecordPad</B>()</PRE> 3282<DL> 3283<DD>Return the padding character for short, fixed-length records for the 3284 Queue and Recno access methods. 3285<p> 3286This method may be called at any time during the life of the application. 3287<p> 3288<P> 3289<DD><DL> 3290</DL> 3291</DD> 3292<DD><DL> 3293 3294<DT><B>Returns:</B><DD>The padding character for short, fixed-length records for the 3295 Queue and Recno access methods.</DL> 3296</DD> 3297</DL> 3298<HR> 3299 3300<A NAME="setRecordSource(java.io.File)"><!-- --></A><H3> 3301setRecordSource</H3> 3302<PRE> 3303public void <B>setRecordSource</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> recordSource)</PRE> 3304<DL> 3305<DD>Set the underlying source file for the Recno access method. 3306 <p> 3307 The purpose of the source file is to provide fast access and 3308 modification to databases that are normally stored as flat text 3309 files. 3310 <p> 3311 The recordSource parameter specifies an underlying flat text 3312 database file that is read to initialize a transient record number 3313 index. In the case of variable length records, the records are 3314 separated, as specified by the 3315 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)"><CODE>DatabaseConfig.setRecordDelimiter</CODE></A> method. For example, 3316 standard UNIX byte stream files can be interpreted as a sequence of 3317 variable length records separated by newline characters (that is, ASCII 3318 0x0a). 3319 <p> 3320 In addition, when cached data would normally be written back to the 3321 underlying database file (for example, the <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)"><CODE>Database.close</CODE></A> 3322 or <A HREF="../../../com/sleepycat/db/Database.html#sync()"><CODE>Database.sync</CODE></A> methods are called), the in-memory copy 3323 of the database will be written back to the source file. 3324 <p> 3325 By default, the backing source file is read lazily; that is, records 3326 are not read from the file until they are requested by the application. 3327 <b> 3328 If multiple processes (not threads) are accessing a Recno database 3329 concurrently, and are either inserting or deleting records, the backing 3330 source file must be read in its entirety before more than a single 3331 process accesses the database, and only that process should specify 3332 the backing source file as part of opening the database. See the 3333 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setSnapshot(boolean)"><CODE>DatabaseConfig.setSnapshot</CODE></A> method for more information. 3334 </b> 3335 <p> 3336 <b> 3337 Reading and writing the backing source file cannot be 3338 transaction-protected because it involves filesystem operations that 3339 are not part of the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> transaction methodology. For 3340 this reason, if a temporary database is used to hold the records, 3341 it is possible to lose the contents of the source file, for example, 3342 if the system crashes at the right instant. If a file is used to 3343 hold the database, normal database recovery on that file can be used 3344 to prevent information loss, although it is still possible that the 3345 contents of the source file will be lost if the system crashes. 3346 </b> 3347 <p> 3348 The source file must already exist (but may be zero-length) when 3349 the database is opened. 3350 <p> 3351 It is not an error to specify a read-only source file when creating 3352 a database, nor is it an error to modify the resulting database. 3353 However, any attempt to write the changes to the backing source file 3354 using either the <A HREF="../../../com/sleepycat/db/Database.html#sync()"><CODE>Database.sync</CODE></A> or <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)"><CODE>Database.close</CODE></A> 3355 methods will fail, of course. Specify the noSync argument to the 3356 <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)"><CODE>Database.close</CODE></A> method to stop it from attempting to write 3357 the changes to the backing file; instead, they will be silently 3358 discarded. 3359 <p> 3360 For all of the previous reasons, the source file is generally used 3361 to specify databases that are read-only for Berkeley DB 3362 applications; and that are either generated on the fly by software 3363 tools or modified using a different mechanism -- for example, a text 3364 editor. 3365 <p> 3366 This method configures operations performed using the specified 3367<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> object, not all operations performed on the underlying 3368database. 3369 <p> 3370 This method may not be called after the database is opened. 3371If the database already exists when it is opened, 3372the information specified to this method must be the same as that 3373historically used to create the database or corruption can occur. 3374 <p> 3375<P> 3376<DD><DL> 3377</DL> 3378</DD> 3379<DD><DL> 3380<DT><B>Parameters:</B><DD><CODE>recordSource</CODE> - The name of an underlying flat text database file that is read to 3381 initialize a transient record number index. In the case of variable 3382 length records, the records are separated, as specified by the 3383 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)"><CODE>DatabaseConfig.setRecordDelimiter</CODE></A> method. For example, 3384 standard UNIX byte stream files can be interpreted as a sequence of 3385 variable length records separated by newline characters (that is, ASCII 3386 0x0a).</DL> 3387</DD> 3388</DL> 3389<HR> 3390 3391<A NAME="getRecordSource()"><!-- --></A><H3> 3392getRecordSource</H3> 3393<PRE> 3394public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getRecordSource</B>()</PRE> 3395<DL> 3396<DD>Return the name of an underlying flat text database file that is 3397 read to initialize a transient record number index. 3398<p> 3399This method may be called at any time during the life of the application. 3400<p> 3401<P> 3402<DD><DL> 3403</DL> 3404</DD> 3405<DD><DL> 3406 3407<DT><B>Returns:</B><DD>The name of an underlying flat text database file that is 3408 read to initialize a transient record number index.</DL> 3409</DD> 3410</DL> 3411<HR> 3412 3413<A NAME="setRenumbering(boolean)"><!-- --></A><H3> 3414setRenumbering</H3> 3415<PRE> 3416public void <B>setRenumbering</B>(boolean renumbering)</PRE> 3417<DL> 3418<DD>Configure the logical record numbers to be mutable, and change as 3419 records are added to and deleted from the database. 3420 <p> 3421 For example, the deletion of record number 4 causes records numbered 3422 5 and greater to be renumbered downward by one. If a cursor was 3423 positioned to record number 4 before the deletion, it will refer to 3424 the new record number 4, if any such record exists, after the 3425 deletion. If a cursor was positioned after record number 4 before 3426 the deletion, it will be shifted downward one logical record, 3427 continuing to refer to the same record as it did before. 3428 <p> 3429 Creating new records will cause the creation of multiple records if 3430 the record number is more than one greater than the largest record 3431 currently in the database. For example, creating record 28, when 3432 record 25 was previously the last record in the database, will 3433 create records 26 and 27 as well as 28. Attempts to retrieve 3434 records that were created in this manner will result in an error 3435 return of <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A>. 3436 <p> 3437 If a created record is not at the end of the database, all records 3438 following the new record will be automatically renumbered upward by one. 3439 For example, the creation of a new record numbered 8 causes records 3440 numbered 8 and greater to be renumbered upward by one. If a cursor was 3441 positioned to record number 8 or greater before the insertion, it will 3442 be shifted upward one logical record, continuing to refer to the same 3443 record as it did before. 3444 <p> 3445 For these reasons, concurrent access to a Recno database configured 3446 with mutable record numbers may be largely meaningless, although it 3447 is supported. 3448 <p> 3449 Calling this method affects the database, including all threads of 3450control accessing the database. 3451 <p> 3452 If the database already exists when the database is opened, any database 3453configuration specified by this method 3454must be the same as the existing database or an error 3455will be returned. 3456 <p> 3457<P> 3458<DD><DL> 3459</DL> 3460</DD> 3461<DD><DL> 3462<DT><B>Parameters:</B><DD><CODE>renumbering</CODE> - If true, configure the logical record numbers to be mutable, and 3463 change as records are added to and deleted from the database. 3464 A value of false is illegal to this method, that is, once set, the 3465configuration cannot be cleared.</DL> 3466</DD> 3467</DL> 3468<HR> 3469 3470<A NAME="getRenumbering()"><!-- --></A><H3> 3471getRenumbering</H3> 3472<PRE> 3473public boolean <B>getRenumbering</B>()</PRE> 3474<DL> 3475<DD>Return true if the logical record numbers are mutable, and change as 3476 records are added to and deleted from the database. 3477<p> 3478This method may be called at any time during the life of the application. 3479<p> 3480<P> 3481<DD><DL> 3482</DL> 3483</DD> 3484<DD><DL> 3485 3486<DT><B>Returns:</B><DD>True if the logical record numbers are mutable, and change as 3487 records are added to and deleted from the database.</DL> 3488</DD> 3489</DL> 3490<HR> 3491 3492<A NAME="setReverseSplitOff(boolean)"><!-- --></A><H3> 3493setReverseSplitOff</H3> 3494<PRE> 3495public void <B>setReverseSplitOff</B>(boolean reverseSplitOff)</PRE> 3496<DL> 3497<DD>Configure the Btree to not do reverse splits. 3498 <p> 3499 As pages are emptied in a database, the Btree implementation 3500 attempts to coalesce empty pages into higher-level pages in order 3501 to keep the database as small as possible and minimize search time. 3502 This can hurt performance in applications with cyclical data 3503 demands; that is, applications where the database grows and shrinks 3504 repeatedly. For example, because Berkeley DB does page-level locking, 3505 the maximum level of concurrency in a database of two pages is far 3506 smaller than that in a database of 100 pages, so a database that has 3507 shrunk to a minimal size can cause severe deadlocking when a new 3508 cycle of data insertion begins. 3509 <p> 3510 Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle 3511(and any other library handles opened within the scope of that handle). 3512 <p> 3513<P> 3514<DD><DL> 3515</DL> 3516</DD> 3517<DD><DL> 3518<DT><B>Parameters:</B><DD><CODE>reverseSplitOff</CODE> - If true, configure the Btree to not do reverse splits. 3519 A value of false is illegal to this method, that is, once set, the 3520configuration cannot be cleared.</DL> 3521</DD> 3522</DL> 3523<HR> 3524 3525<A NAME="getReverseSplitOff()"><!-- --></A><H3> 3526getReverseSplitOff</H3> 3527<PRE> 3528public boolean <B>getReverseSplitOff</B>()</PRE> 3529<DL> 3530<DD>Return true if the Btree has been configured to not do reverse splits. 3531<p> 3532This method may be called at any time during the life of the application. 3533<p> 3534<P> 3535<DD><DL> 3536</DL> 3537</DD> 3538<DD><DL> 3539 3540<DT><B>Returns:</B><DD>True if the Btree has been configured to not do reverse splits.</DL> 3541</DD> 3542</DL> 3543<HR> 3544 3545<A NAME="setSortedDuplicates(boolean)"><!-- --></A><H3> 3546setSortedDuplicates</H3> 3547<PRE> 3548public void <B>setSortedDuplicates</B>(boolean sortedDuplicates)</PRE> 3549<DL> 3550<DD>Configure the database to support sorted, duplicate data items. 3551 <p> 3552 Insertion when the key of the key/data pair being inserted already 3553 exists in the database will be successful. The ordering of 3554 duplicates in the database is determined by the duplicate comparison 3555 function. 3556 <p> 3557 If the application does not specify a duplicate data item comparison 3558 function, a default lexical comparison will be used. 3559 <p> 3560 If a primary database is to be associated with one or more secondary 3561 databases, it may not be configured for duplicates. 3562 <p> 3563 A Btree that supports duplicate data items cannot also be configured 3564 for retrieval by record number. 3565 <p> 3566 Calling this method affects the database, including all threads of 3567control accessing the database. 3568 <p> 3569 If the database already exists when the database is opened, any database 3570configuration specified by this method 3571must be the same as the existing database or an error 3572will be returned. 3573 <p> 3574<P> 3575<DD><DL> 3576</DL> 3577</DD> 3578<DD><DL> 3579<DT><B>Parameters:</B><DD><CODE>sortedDuplicates</CODE> - If true, configure the database to support duplicate data items. 3580 A value of false is illegal to this method, that is, once set, the 3581configuration cannot be cleared.</DL> 3582</DD> 3583</DL> 3584<HR> 3585 3586<A NAME="getSortedDuplicates()"><!-- --></A><H3> 3587getSortedDuplicates</H3> 3588<PRE> 3589public boolean <B>getSortedDuplicates</B>()</PRE> 3590<DL> 3591<DD>Return true if the database is configured to support sorted duplicate data 3592 items. 3593<p> 3594This method may be called at any time during the life of the application. 3595<p> 3596<P> 3597<DD><DL> 3598</DL> 3599</DD> 3600<DD><DL> 3601 3602<DT><B>Returns:</B><DD>True if the database is configured to support sorted duplicate data 3603 items.</DL> 3604</DD> 3605</DL> 3606<HR> 3607 3608<A NAME="setUnsortedDuplicates(boolean)"><!-- --></A><H3> 3609setUnsortedDuplicates</H3> 3610<PRE> 3611public void <B>setUnsortedDuplicates</B>(boolean unsortedDuplicates)</PRE> 3612<DL> 3613<DD>Configure the database to support unsorted duplicate data items. 3614 <p> 3615 Insertion when the key of the key/data pair being inserted already 3616 exists in the database will be successful. The ordering of 3617 duplicates in the database is determined by the order of insertion, 3618 unless the ordering is otherwise specified by use of a database 3619 cursor operation. 3620 <p> 3621 If a primary database is to be associated with one or more secondary 3622 databases, it may not be configured for duplicates. 3623 <p> 3624 Sorted duplicates are preferred to unsorted duplicates for 3625 performance reasons. Unsorted duplicates should only be used by 3626 applications wanting to order duplicate data items manually. 3627 <p> 3628 Calling this method affects the database, including all threads of 3629control accessing the database. 3630 <p> 3631 If the database already exists when the database is opened, any database 3632configuration specified by this method 3633must be the same as the existing database or an error 3634will be returned. 3635 <p> 3636<P> 3637<DD><DL> 3638</DL> 3639</DD> 3640<DD><DL> 3641<DT><B>Parameters:</B><DD><CODE>unsortedDuplicates</CODE> - If true, configure the database to support unsorted duplicate data items. 3642 A value of false is illegal to this method, that is, once set, the 3643configuration cannot be cleared.</DL> 3644</DD> 3645</DL> 3646<HR> 3647 3648<A NAME="getUnsortedDuplicates()"><!-- --></A><H3> 3649getUnsortedDuplicates</H3> 3650<PRE> 3651public boolean <B>getUnsortedDuplicates</B>()</PRE> 3652<DL> 3653<DD>Return true if the database is configured to support duplicate data items. 3654<p> 3655This method may be called at any time during the life of the application. 3656<p> 3657<P> 3658<DD><DL> 3659</DL> 3660</DD> 3661<DD><DL> 3662 3663<DT><B>Returns:</B><DD>True if the database is configured to support duplicate data items.</DL> 3664</DD> 3665</DL> 3666<HR> 3667 3668<A NAME="setSnapshot(boolean)"><!-- --></A><H3> 3669setSnapshot</H3> 3670<PRE> 3671public void <B>setSnapshot</B>(boolean snapshot)</PRE> 3672<DL> 3673<DD>Specify that any specified backing source file be read in its entirety 3674 when the database is opened. 3675 <p> 3676 If this flag is not specified, the backing source file may be read 3677 lazily. 3678 <p> 3679 Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle 3680(and any other library handles opened within the scope of that handle). 3681 <p> 3682<P> 3683<DD><DL> 3684</DL> 3685</DD> 3686<DD><DL> 3687<DT><B>Parameters:</B><DD><CODE>snapshot</CODE> - If true, any specified backing source file will be read in its entirety 3688 when the database is opened. 3689 A value of false is illegal to this method, that is, once set, the 3690configuration cannot be cleared.</DL> 3691</DD> 3692</DL> 3693<HR> 3694 3695<A NAME="getSnapshot()"><!-- --></A><H3> 3696getSnapshot</H3> 3697<PRE> 3698public boolean <B>getSnapshot</B>()</PRE> 3699<DL> 3700<DD>Return true if the any specified backing source file will be read in its 3701 entirety when the database is opened. 3702<p> 3703This method may be called at any time during the life of the application. 3704<p> 3705<P> 3706<DD><DL> 3707</DL> 3708</DD> 3709<DD><DL> 3710 3711<DT><B>Returns:</B><DD>True if the any specified backing source file will be read in its 3712 entirety when the database is opened.</DL> 3713</DD> 3714</DL> 3715<HR> 3716 3717<A NAME="getTransactional()"><!-- --></A><H3> 3718getTransactional</H3> 3719<PRE> 3720public boolean <B>getTransactional</B>()</PRE> 3721<DL> 3722<DD>Return true if the database open is enclosed within a transaction. 3723<p> 3724This method may be called at any time during the life of the application. 3725<p> 3726<P> 3727<DD><DL> 3728</DL> 3729</DD> 3730<DD><DL> 3731 3732<DT><B>Returns:</B><DD>True if the database open is enclosed within a transaction.</DL> 3733</DD> 3734</DL> 3735<HR> 3736 3737<A NAME="setTransactional(boolean)"><!-- --></A><H3> 3738setTransactional</H3> 3739<PRE> 3740public void <B>setTransactional</B>(boolean transactional)</PRE> 3741<DL> 3742<DD>Enclose the database open within a transaction. 3743 <p> 3744 If the call succeeds, the open operation will be recoverable. If 3745 the call fails, no database will have been created. 3746 <p> 3747 All future operations on this database, which are not explicitly 3748 enclosed in a transaction by the application, will be enclosed in 3749 in a transaction within the library. 3750 <p> 3751<P> 3752<DD><DL> 3753</DL> 3754</DD> 3755<DD><DL> 3756<DT><B>Parameters:</B><DD><CODE>transactional</CODE> - If true, enclose the database open within a transaction.</DL> 3757</DD> 3758</DL> 3759<HR> 3760 3761<A NAME="setTransactionNotDurable(boolean)"><!-- --></A><H3> 3762setTransactionNotDurable</H3> 3763<PRE> 3764public void <B>setTransactionNotDurable</B>(boolean transactionNotDurable)</PRE> 3765<DL> 3766<DD>Configure the database environment to not write log records for this 3767 database. 3768 <p> 3769 This means that updates of this database exhibit the ACI (atomicity, 3770 consistency, and isolation) properties, but not D (durability); that 3771 is, database integrity will be maintained, but if the application 3772 or system fails, integrity will not persist. The database file must 3773 be verified and/or restored from backup after a failure. In order 3774 to ensure integrity after application shut down, the database 3775 must be flushed to disk before the database handles are closed, 3776 or all 3777 database changes must be flushed from the database environment cache 3778 using <A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><CODE>Environment.checkpoint</CODE></A>. 3779 <p> 3780 All database handles for a single physical file must call this method, 3781 including database handles for different databases in a physical file. 3782 <p> 3783 Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle 3784(and any other library handles opened within the scope of that handle). 3785 <p> 3786<P> 3787<DD><DL> 3788</DL> 3789</DD> 3790<DD><DL> 3791<DT><B>Parameters:</B><DD><CODE>transactionNotDurable</CODE> - If true, configure the database environment to not write log records 3792 for this database. 3793 A value of false is illegal to this method, that is, once set, the 3794configuration cannot be cleared.</DL> 3795</DD> 3796</DL> 3797<HR> 3798 3799<A NAME="getTransactionNotDurable()"><!-- --></A><H3> 3800getTransactionNotDurable</H3> 3801<PRE> 3802public boolean <B>getTransactionNotDurable</B>()</PRE> 3803<DL> 3804<DD>Return true if the database environment is configured to not write log 3805 records for this database. 3806<p> 3807This method may be called at any time during the life of the application. 3808<p> 3809<P> 3810<DD><DL> 3811</DL> 3812</DD> 3813<DD><DL> 3814 3815<DT><B>Returns:</B><DD>True if the database environment is configured to not write log 3816 records for this database.</DL> 3817</DD> 3818</DL> 3819<HR> 3820 3821<A NAME="setTruncate(boolean)"><!-- --></A><H3> 3822setTruncate</H3> 3823<PRE> 3824public void <B>setTruncate</B>(boolean truncate)</PRE> 3825<DL> 3826<DD>Configure the database to be physically truncated by truncating the 3827 underlying file, discarding all previous databases it might have 3828 held. 3829 <p> 3830 Underlying filesystem primitives are used to implement this 3831 configuration. For this reason, it is applicable only to a physical 3832 file and cannot be used to discard databases within a file. 3833 <p> 3834 This configuration option cannot be lock or transaction-protected, and 3835 it is an error to specify it in a locking or transaction-protected 3836 database environment. 3837 <p> 3838<P> 3839<DD><DL> 3840</DL> 3841</DD> 3842<DD><DL> 3843<DT><B>Parameters:</B><DD><CODE>truncate</CODE> - If true, configure the database to be physically truncated by truncating 3844 the underlying file, discarding all previous databases it might have 3845 held.</DL> 3846</DD> 3847</DL> 3848<HR> 3849 3850<A NAME="getTruncate()"><!-- --></A><H3> 3851getTruncate</H3> 3852<PRE> 3853public boolean <B>getTruncate</B>()</PRE> 3854<DL> 3855<DD>Return true if the database has been configured to be physically truncated 3856 by truncating the underlying file, discarding all previous databases 3857 it might have held. 3858<p> 3859This method may be called at any time during the life of the application. 3860<p> 3861<P> 3862<DD><DL> 3863</DL> 3864</DD> 3865<DD><DL> 3866 3867<DT><B>Returns:</B><DD>True if the database has been configured to be physically truncated 3868 by truncating the underlying file, discarding all previous databases 3869 it might have held.</DL> 3870</DD> 3871</DL> 3872<HR> 3873 3874<A NAME="setType(com.sleepycat.db.DatabaseType)"><!-- --></A><H3> 3875setType</H3> 3876<PRE> 3877public void <B>setType</B>(<A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A> type)</PRE> 3878<DL> 3879<DD>Configure the type of the database. 3880 <p> 3881 If they type is DB_UNKNOWN, the database must already exist. 3882 <p> 3883<P> 3884<DD><DL> 3885</DL> 3886</DD> 3887<DD><DL> 3888<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of the database.</DL> 3889</DD> 3890</DL> 3891<HR> 3892 3893<A NAME="getType()"><!-- --></A><H3> 3894getType</H3> 3895<PRE> 3896public <A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A> <B>getType</B>()</PRE> 3897<DL> 3898<DD>Return the type of the database. 3899 <p> 3900 This method may be used to determine the type of the database after 3901 opening it. 3902 <p> 3903 This method may not be called before the 3904database has been opened. 3905 <p> 3906<P> 3907<DD><DL> 3908</DL> 3909</DD> 3910<DD><DL> 3911 3912<DT><B>Returns:</B><DD>The type of the database.</DL> 3913</DD> 3914</DL> 3915<!-- ========= END OF CLASS DATA ========= --> 3916<HR> 3917 3918 3919<!-- ======= START OF BOTTOM NAVBAR ====== --> 3920<A NAME="navbar_bottom"><!-- --></A> 3921<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 3922<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 3923<TR> 3924<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 3925<A NAME="navbar_bottom_firstrow"><!-- --></A> 3926<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 3927 <TR ALIGN="center" VALIGN="top"> 3928 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 3929 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 3930 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 3931 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DatabaseConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 3932 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 3933 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 3934 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 3935 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 3936 </TR> 3937</TABLE> 3938</TD> 3939<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 3940<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 3941</TD> 3942</TR> 3943 3944<TR> 3945<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 3946 <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 3947 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 3948<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 3949 <A HREF="../../../index.html?com/sleepycat/db/DatabaseConfig.html" target="_top"><B>FRAMES</B></A> 3950 <A HREF="DatabaseConfig.html" target="_top"><B>NO FRAMES</B></A> 3951 <SCRIPT type="text/javascript"> 3952 <!-- 3953 if(window==top) { 3954 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 3955 } 3956 //--> 3957</SCRIPT> 3958<NOSCRIPT> 3959 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 3960</NOSCRIPT> 3961 3962 3963</FONT></TD> 3964</TR> 3965<TR> 3966<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 3967 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 3968<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 3969DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 3970</TR> 3971</TABLE> 3972<A NAME="skip-navbar_bottom"></A> 3973<!-- ======== END OF BOTTOM NAVBAR ======= --> 3974 3975<HR> 3976<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 3977</BODY> 3978</HTML> 3979
