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