1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:46 EDT 2010 --> 6<TITLE> 7Environment (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="date" CONTENT="2010-04-12"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 if (location.href.indexOf('is-external=true') == -1) { 18 parent.document.title="Environment (Oracle - Berkeley DB Java API)"; 19 } 20} 21</SCRIPT> 22<NOSCRIPT> 23</NOSCRIPT> 24 25</HEAD> 26 27<BODY BGCOLOR="white" onload="windowTitle();"> 28<HR> 29 30 31<!-- ========= START OF TOP NAVBAR ======= --> 32<A NAME="navbar_top"><!-- --></A> 33<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 35<TR> 36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 37<A NAME="navbar_top_firstrow"><!-- --></A> 38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 39 <TR ALIGN="center" VALIGN="top"> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Environment.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 59 <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../index.html?com/sleepycat/db/Environment.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.sleepycat.db</FONT> 92<BR> 93Class Environment</H2> 94<PRE> 95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.Environment</B> 97</PRE> 98<HR> 99<DL> 100<DT><PRE>public class <B>Environment</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> 101</PRE> 102 103<P> 104A database environment. Environments include support for some or 105all of caching, locking, logging and transactions. 106<p> 107To open an existing environment with default attributes the application 108may use a default environment configuration object or null: 109<p> 110<blockquote><pre> 111 // Open an environment handle with default attributes. 112 Environment env = new Environment(home, new EnvironmentConfig()); 113</pre></blockquote> 114<p> 115or 116<p> 117<blockquote><pre> 118 Environment env = new Environment(home, null); 119</pre></blockquote> 120<p> 121Note that many Environment objects may access a single environment. 122<p> 123To create an environment or customize attributes, the application should 124customize the configuration class. For example: 125<p> 126<blockquote><pre> 127 EnvironmentConfig envConfig = new EnvironmentConfig(); 128 envConfig.setTransactional(true); 129 envConfig.setAllowCreate(true); 130 envConfig.setCacheSize(1000000); 131 <p> 132 Environment newlyCreatedEnv = new Environment(home, envConfig); 133</pre></blockquote> 134<p> 135Environment handles are free-threaded unless <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setThreaded(boolean)"><CODE>EnvironmentConfig.setThreaded</CODE></A> is called to disable this before the environment is opened. 136<p> 137An <em>environment handle</em> is an Environment instance. More than 138one Environment instance may be created for the same physical directory, 139which is the same as saying that more than one Environment handle may 140be open at one time for a given environment. 141<p> 142The Environment handle should not be closed while any other handle 143remains open that is using it as a reference (for example, 144<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> or <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A>. Once <A HREF="../../../com/sleepycat/db/Environment.html#close()"><CODE>Environment.close</CODE></A> 145is called, this object may not be accessed again, regardless of 146whether or not it throws an exception. 147<P> 148 149<P> 150<HR> 151 152<P> 153 154<!-- ======== CONSTRUCTOR SUMMARY ======== --> 155 156<A NAME="constructor_summary"><!-- --></A> 157<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 158<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 159<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 160<B>Constructor Summary</B></FONT></TH> 161</TR> 162<TR BGCOLOR="white" CLASS="TableRowColor"> 163<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)">Environment</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, 164 <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE> 165 166<BR> 167 Create a database environment handle.</TD> 168</TR> 169</TABLE> 170 171<!-- ========== METHOD SUMMARY =========== --> 172 173<A NAME="method_summary"><!-- --></A> 174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 175<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 176<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 177<B>Method Summary</B></FONT></TH> 178</TR> 179<TR BGCOLOR="white" CLASS="TableRowColor"> 180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 181<CODE> <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A></CODE></FONT></TD> 182<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#beginCDSGroup()">beginCDSGroup</A></B>()</CODE> 183 184<BR> 185 Allocate a locker ID in an environment configured for Berkeley DB 186 Concurrent Data Store applications.</TD> 187</TR> 188<TR BGCOLOR="white" CLASS="TableRowColor"> 189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 190<CODE> <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A></CODE></FONT></TD> 191<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)">beginTransaction</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> parent, 192 <A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</A> config)</CODE> 193 194<BR> 195 Create a new transaction in the database environment.</TD> 196</TR> 197<TR BGCOLOR="white" CLASS="TableRowColor"> 198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 199<CODE> void</CODE></FONT></TD> 200<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)">checkpoint</A></B>(<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A> config)</CODE> 201 202<BR> 203 Synchronously checkpoint the database environment.</TD> 204</TR> 205<TR BGCOLOR="white" CLASS="TableRowColor"> 206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 207<CODE> void</CODE></FONT></TD> 208<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#close()">close</A></B>()</CODE> 209 210<BR> 211 Close the database environment, freeing any allocated resources and 212 closing any underlying subsystems.</TD> 213</TR> 214<TR BGCOLOR="white" CLASS="TableRowColor"> 215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 216<CODE> int</CODE></FONT></TD> 217<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#createLockerID()">createLockerID</A></B>()</CODE> 218 219<BR> 220 Allocate a locker ID.</TD> 221</TR> 222<TR BGCOLOR="white" CLASS="TableRowColor"> 223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 224<CODE> int</CODE></FONT></TD> 225<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#detectDeadlocks(com.sleepycat.db.LockDetectMode)">detectDeadlocks</A></B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> mode)</CODE> 226 227<BR> 228 Run one iteration of the deadlock detector.</TD> 229</TR> 230<TR BGCOLOR="white" CLASS="TableRowColor"> 231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 232<CODE> void</CODE></FONT></TD> 233<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#electReplicationMaster(int, int)">electReplicationMaster</A></B>(int nsites, 234 int nvotes)</CODE> 235 236<BR> 237 Hold an election for the master of a replication group.</TD> 238</TR> 239<TR BGCOLOR="white" CLASS="TableRowColor"> 240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 241<CODE> void</CODE></FONT></TD> 242<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#flushReplication()">flushReplication</A></B>()</CODE> 243 244<BR> 245 Internal method: re-push the last log record to all clients, in case they've 246 lost messages and don't know it.</TD> 247</TR> 248<TR BGCOLOR="white" CLASS="TableRowColor"> 249<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 250<CODE> void</CODE></FONT></TD> 251<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#freeLockerID(int)">freeLockerID</A></B>(int id)</CODE> 252 253<BR> 254 Free a locker ID.</TD> 255</TR> 256<TR BGCOLOR="white" CLASS="TableRowColor"> 257<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 258<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[]</CODE></FONT></TD> 259<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getArchiveDatabases()">getArchiveDatabases</A></B>()</CODE> 260 261<BR> 262 </TD> 263</TR> 264<TR BGCOLOR="white" CLASS="TableRowColor"> 265<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 266<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[]</CODE></FONT></TD> 267<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getArchiveLogFiles(boolean)">getArchiveLogFiles</A></B>(boolean includeInUse)</CODE> 268 269<BR> 270 </TD> 271</TR> 272<TR BGCOLOR="white" CLASS="TableRowColor"> 273<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 274<CODE> <A HREF="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</A>[]</CODE></FONT></TD> 275<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getCacheFileStats(com.sleepycat.db.StatsConfig)">getCacheFileStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 276 277<BR> 278 </TD> 279</TR> 280<TR BGCOLOR="white" CLASS="TableRowColor"> 281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 282<CODE> <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</A></CODE></FONT></TD> 283<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getCacheStats(com.sleepycat.db.StatsConfig)">getCacheStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 284 285<BR> 286 </TD> 287</TR> 288<TR BGCOLOR="white" CLASS="TableRowColor"> 289<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 290<CODE> <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A></CODE></FONT></TD> 291<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getConfig()">getConfig</A></B>()</CODE> 292 293<BR> 294 Return this object's configuration.</TD> 295</TR> 296<TR BGCOLOR="white" CLASS="TableRowColor"> 297<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 298<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> 299<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getHome()">getHome</A></B>()</CODE> 300 301<BR> 302 </TD> 303</TR> 304<TR BGCOLOR="white" CLASS="TableRowColor"> 305<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 306<CODE> <A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A></CODE></FONT></TD> 307<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)">getLock</A></B>(int locker, 308 boolean noWait, 309 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> object, 310 <A HREF="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</A> mode)</CODE> 311 312<BR> 313 Acquire a lock from the lock table.</TD> 314</TR> 315<TR BGCOLOR="white" CLASS="TableRowColor"> 316<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 317<CODE> <A HREF="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</A></CODE></FONT></TD> 318<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLockStats(com.sleepycat.db.StatsConfig)">getLockStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 319 320<BR> 321 Return the database environment's locking statistics.</TD> 322</TR> 323<TR BGCOLOR="white" CLASS="TableRowColor"> 324<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 325<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 326<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLogFileName(com.sleepycat.db.LogSequenceNumber)">getLogFileName</A></B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn)</CODE> 327 328<BR> 329 Return the name of the log file that contains the log record 330 specified by a LogSequenceNumber object.</TD> 331</TR> 332<TR BGCOLOR="white" CLASS="TableRowColor"> 333<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 334<CODE> <A HREF="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</A></CODE></FONT></TD> 335<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getLogStats(com.sleepycat.db.StatsConfig)">getLogStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 336 337<BR> 338 Return the database environment's logging statistics.</TD> 339</TR> 340<TR BGCOLOR="white" CLASS="TableRowColor"> 341<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 342<CODE> <A HREF="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</A></CODE></FONT></TD> 343<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getMutexStats(com.sleepycat.db.StatsConfig)">getMutexStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 344 345<BR> 346 Return the database environment's mutex statistics.</TD> 347</TR> 348<TR BGCOLOR="white" CLASS="TableRowColor"> 349<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 350<CODE> boolean</CODE></FONT></TD> 351<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationConfig(com.sleepycat.db.ReplicationConfig)">getReplicationConfig</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config)</CODE> 352 353<BR> 354 Get the configuration of the replication subsystem.</TD> 355</TR> 356<TR BGCOLOR="white" CLASS="TableRowColor"> 357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 358<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</A>[]</CODE></FONT></TD> 359<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerSiteList()">getReplicationManagerSiteList</A></B>()</CODE> 360 361<BR> 362 Return an array of all sites known to the replication manager.</TD> 363</TR> 364<TR BGCOLOR="white" CLASS="TableRowColor"> 365<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 366<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</A></CODE></FONT></TD> 367<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerStats(com.sleepycat.db.StatsConfig)">getReplicationManagerStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 368 369<BR> 370 Return the database environment's replication manager statistics.</TD> 371</TR> 372<TR BGCOLOR="white" CLASS="TableRowColor"> 373<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 374<CODE> <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</A></CODE></FONT></TD> 375<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationStats(com.sleepycat.db.StatsConfig)">getReplicationStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 376 377<BR> 378 Return the database environment's replication statistics.</TD> 379</TR> 380<TR BGCOLOR="white" CLASS="TableRowColor"> 381<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 382<CODE> int</CODE></FONT></TD> 383<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)">getReplicationTimeout</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type)</CODE> 384 385<BR> 386 Gets the timeout applied to the specified timeout type.</TD> 387</TR> 388<TR BGCOLOR="white" CLASS="TableRowColor"> 389<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 390<CODE> <A HREF="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</A></CODE></FONT></TD> 391<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getTransactionStats(com.sleepycat.db.StatsConfig)">getTransactionStats</A></B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config)</CODE> 392 393<BR> 394 Return the database environment's transactional statistics.</TD> 395</TR> 396<TR BGCOLOR="white" CLASS="TableRowColor"> 397<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 398<CODE>static int</CODE></FONT></TD> 399<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionMajor()">getVersionMajor</A></B>()</CODE> 400 401<BR> 402 Return the release major number.</TD> 403</TR> 404<TR BGCOLOR="white" CLASS="TableRowColor"> 405<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 406<CODE>static int</CODE></FONT></TD> 407<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionMinor()">getVersionMinor</A></B>()</CODE> 408 409<BR> 410 Return the release minor number.</TD> 411</TR> 412<TR BGCOLOR="white" CLASS="TableRowColor"> 413<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 414<CODE>static int</CODE></FONT></TD> 415<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionPatch()">getVersionPatch</A></B>()</CODE> 416 417<BR> 418 Return the release patch number.</TD> 419</TR> 420<TR BGCOLOR="white" CLASS="TableRowColor"> 421<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 422<CODE>static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 423<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionString()">getVersionString</A></B>()</CODE> 424 425<BR> 426 Return the release version information, suitable for display.</TD> 427</TR> 428<TR BGCOLOR="white" CLASS="TableRowColor"> 429<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 430<CODE> void</CODE></FONT></TD> 431<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])">lockVector</A></B>(int locker, 432 boolean noWait, 433 <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</A>[] list)</CODE> 434 435<BR> 436 Atomically obtain and release one or more locks from the lock table.</TD> 437</TR> 438<TR BGCOLOR="white" CLASS="TableRowColor"> 439<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 440<CODE> void</CODE></FONT></TD> 441<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#logFlush(com.sleepycat.db.LogSequenceNumber)">logFlush</A></B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn)</CODE> 442 443<BR> 444 Flush log records to stable storage.</TD> 445</TR> 446<TR BGCOLOR="white" CLASS="TableRowColor"> 447<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 448<CODE> void</CODE></FONT></TD> 449<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#logPrint(com.sleepycat.db.Transaction, java.lang.String)">logPrint</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 450 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message)</CODE> 451 452<BR> 453 Append an informational message to the Berkeley DB database environment log files.</TD> 454</TR> 455<TR BGCOLOR="white" CLASS="TableRowColor"> 456<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 457<CODE> <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A></CODE></FONT></TD> 458<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#logPut(com.sleepycat.db.DatabaseEntry, boolean)">logPut</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 459 boolean flush)</CODE> 460 461<BR> 462 Append a record to the log.</TD> 463</TR> 464<TR BGCOLOR="white" CLASS="TableRowColor"> 465<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 466<CODE> <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD> 467<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)">openDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 468 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 469 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, 470 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> config)</CODE> 471 472<BR> 473 Open a database.</TD> 474</TR> 475<TR BGCOLOR="white" CLASS="TableRowColor"> 476<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 477<CODE> <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</A></CODE></FONT></TD> 478<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openLogCursor()">openLogCursor</A></B>()</CODE> 479 480<BR> 481 Return a log cursor.</TD> 482</TR> 483<TR BGCOLOR="white" CLASS="TableRowColor"> 484<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 485<CODE> <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A></CODE></FONT></TD> 486<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)">openSecondaryDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 487 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 488 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, 489 <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase, 490 <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config)</CODE> 491 492<BR> 493 Open a database.</TD> 494</TR> 495<TR BGCOLOR="white" CLASS="TableRowColor"> 496<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 497<CODE> void</CODE></FONT></TD> 498<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#panic(boolean)">panic</A></B>(boolean onoff)</CODE> 499 500<BR> 501 Set the panic state for the database environment.</TD> 502</TR> 503<TR BGCOLOR="white" CLASS="TableRowColor"> 504<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 505<CODE> <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</A></CODE></FONT></TD> 506<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)">processReplicationMessage</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> control, 507 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> rec, 508 int envid)</CODE> 509 510<BR> 511 Process an incoming replication message sent by a member of the 512 replication group to the local database environment.</TD> 513</TR> 514<TR BGCOLOR="white" CLASS="TableRowColor"> 515<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 516<CODE> void</CODE></FONT></TD> 517<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#putLock(com.sleepycat.db.Lock)">putLock</A></B>(<A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> lock)</CODE> 518 519<BR> 520 Release a lock.</TD> 521</TR> 522<TR BGCOLOR="white" CLASS="TableRowColor"> 523<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 524<CODE> <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</A>[]</CODE></FONT></TD> 525<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#recover(int, boolean)">recover</A></B>(int count, 526 boolean continued)</CODE> 527 528<BR> 529 </TD> 530</TR> 531<TR BGCOLOR="white" CLASS="TableRowColor"> 532<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 533<CODE>static void</CODE></FONT></TD> 534<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)">remove</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, 535 boolean force, 536 <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE> 537 538<BR> 539 Destroy a database environment.</TD> 540</TR> 541<TR BGCOLOR="white" CLASS="TableRowColor"> 542<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 543<CODE> void</CODE></FONT></TD> 544<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#removeDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String)">removeDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 545 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 546 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName)</CODE> 547 548<BR> 549 550Remove a database.</TD> 551</TR> 552<TR BGCOLOR="white" CLASS="TableRowColor"> 553<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 554<CODE> void</CODE></FONT></TD> 555<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#removeOldLogFiles()">removeOldLogFiles</A></B>()</CODE> 556 557<BR> 558 Remove log files that are no longer needed.</TD> 559</TR> 560<TR BGCOLOR="white" CLASS="TableRowColor"> 561<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 562<CODE> void</CODE></FONT></TD> 563<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#renameDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, java.lang.String)">renameDatabase</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 564 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 565 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, 566 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> newName)</CODE> 567 568<BR> 569 570Rename a database.</TD> 571</TR> 572<TR BGCOLOR="white" CLASS="TableRowColor"> 573<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 574<CODE> void</CODE></FONT></TD> 575<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)">replicationManagerStart</A></B>(int nthreads, 576 <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</A> policy)</CODE> 577 578<BR> 579 Starts the replication manager.</TD> 580</TR> 581<TR BGCOLOR="white" CLASS="TableRowColor"> 582<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 583<CODE> void</CODE></FONT></TD> 584<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#resetFileID(java.lang.String, boolean)">resetFileID</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, 585 boolean encrypted)</CODE> 586 587<BR> 588 Allows database files to be copied, and then the copy used in the same 589 database environment as the original.</TD> 590</TR> 591<TR BGCOLOR="white" CLASS="TableRowColor"> 592<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 593<CODE> void</CODE></FONT></TD> 594<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#resetLogSequenceNumber(java.lang.String, boolean)">resetLogSequenceNumber</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, 595 boolean encrypted)</CODE> 596 597<BR> 598 Allows database files to be moved from one transactional database 599 environment to another.</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/Environment.html#setConfig(com.sleepycat.db.EnvironmentConfig)">setConfig</A></B>(<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE> 605 606<BR> 607 Change the settings in an existing environment handle.</TD> 608</TR> 609<TR BGCOLOR="white" CLASS="TableRowColor"> 610<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 611<CODE> void</CODE></FONT></TD> 612<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)">setReplicationConfig</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config, 613 boolean onoff)</CODE> 614 615<BR> 616 Configure the replication subsystem.</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/Environment.html#setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)">setReplicationTimeout</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type, 622 int replicationTimeout)</CODE> 623 624<BR> 625 Sets the timeout applied to the specified timeout type.</TD> 626</TR> 627<TR BGCOLOR="white" CLASS="TableRowColor"> 628<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 629<CODE> void</CODE></FONT></TD> 630<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)">startReplication</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> cdata, 631 boolean master)</CODE> 632 633<BR> 634 Configure the database environment as a client or master in a group 635 of replicated database environments.</TD> 636</TR> 637<TR BGCOLOR="white" CLASS="TableRowColor"> 638<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 639<CODE> void</CODE></FONT></TD> 640<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#syncCache(com.sleepycat.db.LogSequenceNumber)">syncCache</A></B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> logSequenceNumber)</CODE> 641 642<BR> 643 Ensure that all modified pages in the cache are flushed to their backing files.</TD> 644</TR> 645<TR BGCOLOR="white" CLASS="TableRowColor"> 646<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 647<CODE> void</CODE></FONT></TD> 648<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#syncReplication()">syncReplication</A></B>()</CODE> 649 650<BR> 651 Forces synchronization to begin for this client.</TD> 652</TR> 653<TR BGCOLOR="white" CLASS="TableRowColor"> 654<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 655<CODE> int</CODE></FONT></TD> 656<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#trickleCacheWrite(int)">trickleCacheWrite</A></B>(int percent)</CODE> 657 658<BR> 659 Ensure that a specified percent of the pages in the shared memory 660 pool are clean, by writing dirty pages to their backing files.</TD> 661</TR> 662</TABLE> 663 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 664<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 665<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 666<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 667</TR> 668<TR BGCOLOR="white" CLASS="TableRowColor"> 669<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 670</TR> 671</TABLE> 672 673<P> 674 675<!-- ========= CONSTRUCTOR DETAIL ======== --> 676 677<A NAME="constructor_detail"><!-- --></A> 678<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 679<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 680<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 681<B>Constructor Detail</B></FONT></TH> 682</TR> 683</TABLE> 684 685<A NAME="Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3> 686Environment</H3> 687<PRE> 688public <B>Environment</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, 689 <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config) 690 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 691 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> 692<DL> 693<DD>Create a database environment handle. 694 <p> 695<P> 696<DL> 697<DT><B>Parameters:</B><DD><CODE>home</CODE> - The database environment's home directory. 698 The environment variable <code>DB_HOME</code> may be used as 699 the path of the database home. 700 For more information on <code>envHome</code> and filename 701 resolution in general, see 702 <a href="../../../../programmer_reference/env_naming.html" target="_top">File Naming</a>. 703 <p><DD><CODE>config</CODE> - The database environment attributes. If null, default attributes are used. 704 <p> 705 <p> 706<DT><B>Throws:</B> 707<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 708 <p> 709 <p> 710<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 711<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> 712</DL> 713 714<!-- ============ METHOD DETAIL ========== --> 715 716<A NAME="method_detail"><!-- --></A> 717<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 718<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 719<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 720<B>Method Detail</B></FONT></TH> 721</TR> 722</TABLE> 723 724<A NAME="close()"><!-- --></A><H3> 725close</H3> 726<PRE> 727public void <B>close</B>() 728 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 729<DL> 730<DD>Close the database environment, freeing any allocated resources and 731 closing any underlying subsystems. 732 <p> 733 The <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle should not be closed while any other 734 handle that refers to it is not yet closed; for example, database 735 environment handles must not be closed while database handles remain 736 open, or transactions in the environment have not yet been committed 737 or aborted. Specifically, this includes <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>, 738 <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A>, <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A>, and <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db"><CODE>LogCursor</CODE></A> 739 handles. 740 <p> 741 Where the environment was initialized with a locking subsystem, 742 closing the environment does not release any locks still held by the 743 closing process, providing functionality for long-lived locks. 744 <p> 745 Where the environment was initialized with a transaction subsystem, 746 closing the environment aborts any unresolved transactions. 747 Applications should not depend on this behavior for transactions 748 involving databases; all such transactions should be explicitly 749 resolved. The problem with depending on this semantic is that 750 aborting an unresolved transaction involving database operations 751 requires a database handle. Because the database handles should 752 have been closed before closing the environment, it will not be 753 possible to abort the transaction, and recovery will have to be run 754 on the database environment before further operations are done. 755 <p> 756 Where log cursors were created, closing the environment does not 757 imply closing those cursors. 758 <p> 759 In multithreaded applications, only a single thread may call this 760 method. 761 <p> 762 After this method has been called, regardless of its return, the 763 <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle may not be accessed again. 764 <p> 765 <p> 766<P> 767<DD><DL> 768 769<DT><B>Throws:</B> 770<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 771</DD> 772</DL> 773<HR> 774 775<A NAME="remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3> 776remove</H3> 777<PRE> 778public static void <B>remove</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> home, 779 boolean force, 780 <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config) 781 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 782 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> 783<DL> 784<DD>Destroy a database environment. 785 <p> 786 If the environment is not in use, the environment regions, including 787 any backing files, are removed. Any log or database files and the 788 environment directory itself are not removed. 789 <p> 790 If there are processes currently using the database environment, 791 this method will fail without further action (unless the force 792 argument is true, in which case the environment will be removed, 793 regardless of any processes still using it). 794 <p> 795 The result of attempting to forcibly destroy the environment when 796 it is in use is unspecified. Processes using an environment often 797 maintain open file descriptors for shared regions within it. On 798 UNIX systems, the environment removal will usually succeed, and 799 processes that have already joined the region will continue to run 800 in that region without change. However, processes attempting to 801 join the environment will either fail or create new regions. On 802 other systems in which the unlink system call will fail if any 803 process has an open file descriptor for the file (for example 804 Windows/NT), the region removal will fail. 805 <p> 806 Calling this method should not be necessary for most applications 807 because the environment is cleaned up as part of normal 808 database recovery procedures. However, applications may want to call 809 this method as part of application shut down to free up system 810 resources. For example, if system shared memory was used to back 811 the database environment, it may be useful to call this method in 812 order to release system shared memory segments that have been 813 allocated. Or, on architectures in which mutexes require allocation 814 of underlying system resources, it may be useful to call 815 this method in order to release those resources. Alternatively, if 816 recovery is not required because no database state is maintained 817 across failures, and no system resources need to be released, it is 818 possible to clean up an environment by simply removing all the 819 Berkeley DB files in the database environment's directories. 820 <p> 821 In multithreaded applications, only a single thread may call this 822 method. 823 <p> 824 After this method has been called, regardless of its return, the 825 <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle may not be 826 accessed again. 827 <p> 828<P> 829<DD><DL> 830<DT><B>Parameters:</B><DD><CODE>home</CODE> - The database environment to be removed. 831 On Windows platforms, this argument will be interpreted as a UTF-8 832 string, which is equivalent to ASCII for Latin characters. 833 <p><DD><CODE>force</CODE> - The environment is removed, regardless of any processes that may 834 still using it, and no locks are acquired during this process. 835 (Generally, the force argument is specified only when applications 836 were unable to shut down cleanly, and there is a risk that an 837 application may have died holding a Berkeley DB mutex or lock. 838 <p> 839 <p> 840<DT><B>Throws:</B> 841<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 842<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> 843</DD> 844</DL> 845<HR> 846 847<A NAME="setConfig(com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3> 848setConfig</H3> 849<PRE> 850public void <B>setConfig</B>(<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config) 851 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 852<DL> 853<DD>Change the settings in an existing environment handle. 854 <p> 855<P> 856<DD><DL> 857<DT><B>Parameters:</B><DD><CODE>config</CODE> - The database environment attributes. If null, default attributes are used. 858 <p> 859 <p> 860<DT><B>Throws:</B> 861<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 862<p> 863<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 864</DD> 865</DL> 866<HR> 867 868<A NAME="getConfig()"><!-- --></A><H3> 869getConfig</H3> 870<PRE> 871public <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> <B>getConfig</B>() 872 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 873<DL> 874<DD>Return this object's configuration. 875 <p> 876<P> 877<DD><DL> 878 879<DT><B>Returns:</B><DD>This object's configuration. 880 <p> 881 <p> 882<DT><B>Throws:</B> 883<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 884</DD> 885</DL> 886<HR> 887 888<A NAME="openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><!-- --></A><H3> 889openDatabase</H3> 890<PRE> 891public <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> <B>openDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 892 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 893 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, 894 <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> config) 895 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 896 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> 897<DL> 898<DD>Open a database. 899<p> 900The database is represented by the file and database parameters. 901<p> 902The currently supported database file formats (or <em>access 903methods</em>) are Btree, Hash, Queue, and Recno. The Btree format is a 904representation of a sorted, balanced tree structure. The Hash format 905is an extensible, dynamic hashing scheme. The Queue format supports 906fast access to fixed-length records accessed sequentially or by logical 907record number. The Recno format supports fixed- or variable-length 908records, accessed sequentially or by logical record number, and 909optionally backed by a flat text file. 910<p> 911Storage and retrieval are based on key/data pairs; see <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> 912for more information. 913<p> 914Opening a database is a relatively expensive operation, and maintaining 915a set of open databases will normally be preferable to repeatedly 916opening and closing the database for each new query. 917<p> 918In-memory databases never intended to be preserved on disk may be 919created by setting both the fileName and databaseName parameters to 920null. Note that in-memory databases can only ever be shared by sharing 921the single database handle that created them, in circumstances where 922doing so is safe. The environment variable <code>TMPDIR</code> may 923be used as a directory in which to create temporary backing files. 924<p> 925<P> 926<DD><DL> 927<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null 928may be specified to use auto-commit. For a non-transactional database, null 929must be specified. 930Note that transactionally protected operations on a Database handle 931require that the Database handle itself be transactionally protected 932during its open, either with a non-null transaction handle, or by calling 933<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><CODE>DatabaseConfig.setTransactional</CODE></A> on the configuration object. 934<p><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database. 935On Windows platforms, this argument will be interpreted as a UTF-8 936string, which is equivalent to ASCII for Latin characters. 937<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple 938databases in a single file. Although no databaseName parameter needs 939to be specified, it is an error to attempt to open a second database in 940a physical file that was not initially created using a databaseName 941parameter. Further, the databaseName parameter is not supported by the 942Queue format. 943<p><DD><CODE>config</CODE> - The database open attributes. If null, default attributes are used. 944<DT><B>Throws:</B> 945<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> 946<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> 947</DD> 948</DL> 949<HR> 950 951<A NAME="openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"><!-- --></A><H3> 952openSecondaryDatabase</H3> 953<PRE> 954public <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A> <B>openSecondaryDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 955 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 956 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, 957 <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase, 958 <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config) 959 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 960 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> 961<DL> 962<DD>Open a database. 963<p> 964The database is represented by the file and database parameters. 965<p> 966The currently supported database file formats (or <em>access 967methods</em>) are Btree, Hash, Queue, and Recno. The Btree format is a 968representation of a sorted, balanced tree structure. The Hash format 969is an extensible, dynamic hashing scheme. The Queue format supports 970fast access to fixed-length records accessed sequentially or by logical 971record number. The Recno format supports fixed- or variable-length 972records, accessed sequentially or by logical record number, and 973optionally backed by a flat text file. 974<p> 975Storage and retrieval are based on key/data pairs; see <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> 976for more information. 977<p> 978Opening a database is a relatively expensive operation, and maintaining 979a set of open databases will normally be preferable to repeatedly 980opening and closing the database for each new query. 981<p> 982In-memory databases never intended to be preserved on disk may be 983created by setting both the fileName and databaseName parameters to 984null. Note that in-memory databases can only ever be shared by sharing 985the single database handle that created them, in circumstances where 986doing so is safe. The environment variable <code>TMPDIR</code> may 987be used as a directory in which to create temporary backing files. 988<p> 989<P> 990<DD><DL> 991<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null 992may be specified to use auto-commit. For a non-transactional database, null 993must be specified. 994Note that transactionally protected operations on a Database handle 995require that the Database handle itself be transactionally protected 996during its open, either with a non-null transaction handle, or by calling 997<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><CODE>DatabaseConfig.setTransactional</CODE></A> on the configuration object. 998<p><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database. 999On Windows platforms, this argument will be interpreted as a UTF-8 1000string, which is equivalent to ASCII for Latin characters. 1001<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple 1002databases in a single file. Although no databaseName parameter needs 1003to be specified, it is an error to attempt to open a second database in 1004a physical file that was not initially created using a databaseName 1005parameter. Further, the databaseName parameter is not supported by the 1006Queue format. 1007<p><DD><CODE>primaryDatabase</CODE> - a database handle for the primary database that is to be indexed. 1008<p><DD><CODE>config</CODE> - The secondary database open attributes. If null, default attributes are used. 1009<DT><B>Throws:</B> 1010<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> 1011<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> 1012</DD> 1013</DL> 1014<HR> 1015 1016<A NAME="removeDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String)"><!-- --></A><H3> 1017removeDatabase</H3> 1018<PRE> 1019public void <B>removeDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 1020 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 1021 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName) 1022 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 1023 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> 1024<DL> 1025<DD><p> 1026Remove a database. 1027<p> 1028If no database is specified, the underlying file specified is removed. 1029<p> 1030Applications should never remove databases with open <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> 1031handles, or in the case of removing a file, when any database in the 1032file has an open handle. For example, some architectures do not permit 1033the removal of files with open system handles. On these architectures, 1034attempts to remove databases currently in use by any thread of control 1035in the system may fail. 1036<p> 1037The 1038environment variable DB_HOME may be used as the path of the database 1039environment home. 1040<p> 1041This method is affected by any database directory specified with 1042<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>EnvironmentConfig.addDataDir</CODE></A>, or by setting the "set_data_dir" 1043string in the database environment's DB_CONFIG file. 1044<p> 1045The <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle may not be accessed 1046again after this method is called, regardless of this method's success 1047or failure. 1048<p> 1049<P> 1050<DD><DL> 1051<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null 1052may be specified to use auto-commit. For a non-transactional database, null 1053must be specified. 1054<p><DD><CODE>fileName</CODE> - The physical file which contains the database to be removed. 1055On Windows platforms, this argument will be interpreted as a UTF-8 1056string, which is equivalent to ASCII for Latin characters. 1057<p><DD><CODE>databaseName</CODE> - The database to be removed. 1058<p> 1059<p> 1060<DT><B>Throws:</B> 1061<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 1062deadlock. 1063<p> 1064<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 1065<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> 1066</DD> 1067</DL> 1068<HR> 1069 1070<A NAME="renameDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> 1071renameDatabase</H3> 1072<PRE> 1073public void <B>renameDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 1074 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, 1075 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, 1076 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> newName) 1077 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, 1078 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> 1079<DL> 1080<DD><p> 1081Rename a database. 1082<p> 1083If no database name is specified, the underlying file specified is 1084renamed, incidentally renaming all of the databases it contains. 1085<p> 1086Applications should never rename databases that are currently in use. 1087If an underlying file is being renamed and logging is currently enabled 1088in the database environment, no database in the file may be open when 1089this method is called. In particular, some architectures do not permit 1090renaming files with open handles. On these architectures, attempts to 1091rename databases that are currently in use by any thread of control in 1092the system may fail. 1093<p> 1094The 1095environment variable DB_HOME may be used as the path of the database 1096environment home. 1097<p> 1098This method is affected by any database directory specified with 1099<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>EnvironmentConfig.addDataDir</CODE></A>, or by setting the "set_data_dir" 1100string in the database environment's DB_CONFIG file. 1101<p> 1102The <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle may not be accessed 1103again after this method is called, regardless of this method's success 1104or failure. 1105<p> 1106<P> 1107<DD><DL> 1108<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null 1109may be specified to use auto-commit. For a non-transactional database, null 1110must be specified. 1111<p><DD><CODE>fileName</CODE> - The physical file which contains the database to be renamed. 1112On Windows platforms, this argument will be interpreted as a UTF-8 1113string, which is equivalent to ASCII for Latin characters. 1114<p><DD><CODE>databaseName</CODE> - The database to be renamed. 1115<p><DD><CODE>newName</CODE> - The new name of the database or file. 1116<p> 1117<p> 1118<DT><B>Throws:</B> 1119<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a 1120deadlock. 1121<p> 1122<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. 1123<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> 1124</DD> 1125</DL> 1126<HR> 1127 1128<A NAME="getHome()"><!-- --></A><H3> 1129getHome</H3> 1130<PRE> 1131public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getHome</B>() 1132 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1133<DL> 1134<DD><DL> 1135 1136<DT><B>Throws:</B> 1137<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1138</DD> 1139</DL> 1140<HR> 1141 1142<A NAME="trickleCacheWrite(int)"><!-- --></A><H3> 1143trickleCacheWrite</H3> 1144<PRE> 1145public int <B>trickleCacheWrite</B>(int percent) 1146 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1147<DL> 1148<DD>Ensure that a specified percent of the pages in the shared memory 1149 pool are clean, by writing dirty pages to their backing files. 1150 <p> 1151 The purpose of this method is to enable a memory pool manager to ensure 1152 that a page is always available for reading in new information 1153 without having to wait for a write. 1154 <p> 1155<P> 1156<DD><DL> 1157<DT><B>Parameters:</B><DD><CODE>percent</CODE> - The percent of the pages in the cache that should be clean. 1158 <p> 1159<DT><B>Returns:</B><DD>The number of pages that were written to reach the specified 1160 percentage. 1161 <p> 1162 <p> 1163<DT><B>Throws:</B> 1164<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1165</DD> 1166</DL> 1167<HR> 1168 1169<A NAME="detectDeadlocks(com.sleepycat.db.LockDetectMode)"><!-- --></A><H3> 1170detectDeadlocks</H3> 1171<PRE> 1172public int <B>detectDeadlocks</B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> mode) 1173 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1174<DL> 1175<DD>Run one iteration of the deadlock detector. 1176 <p> 1177 The deadlock detector traverses the lock table and marks one of the 1178 participating lock requesters for rejection in each deadlock it finds. 1179 <p> 1180<P> 1181<DD><DL> 1182<DT><B>Parameters:</B><DD><CODE>mode</CODE> - Which lock request(s) to reject. 1183 <p> 1184<DT><B>Returns:</B><DD>The number of lock requests that were rejected. 1185 <p> 1186 <p> 1187<DT><B>Throws:</B> 1188<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1189</DD> 1190</DL> 1191<HR> 1192 1193<A NAME="getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)"><!-- --></A><H3> 1194getLock</H3> 1195<PRE> 1196public <A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> <B>getLock</B>(int locker, 1197 boolean noWait, 1198 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> object, 1199 <A HREF="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</A> mode) 1200 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1201<DL> 1202<DD>Acquire a lock from the lock table. 1203 <p> 1204<P> 1205<DD><DL> 1206<DT><B>Parameters:</B><DD><CODE>locker</CODE> - An unsigned 32-bit integer quantity representing the entity 1207 requesting the lock. 1208 <p><DD><CODE>mode</CODE> - The lock mode. 1209 <p><DD><CODE>noWait</CODE> - If a lock cannot be granted because the requested lock conflicts 1210 with an existing lock, throw a <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> 1211 immediately instead of waiting for the lock to become available. 1212 <p><DD><CODE>object</CODE> - An untyped byte string that specifies the object to be locked. 1213 Applications using the locking subsystem directly while also doing 1214 locking via the Berkeley DB access methods must take care not to 1215 inadvertently lock objects that happen to be equal to the unique 1216 file IDs used to lock files. 1217 <p> 1218 <p> 1219<DT><B>Throws:</B> 1220<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1221</DD> 1222</DL> 1223<HR> 1224 1225<A NAME="putLock(com.sleepycat.db.Lock)"><!-- --></A><H3> 1226putLock</H3> 1227<PRE> 1228public void <B>putLock</B>(<A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> lock) 1229 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1230<DL> 1231<DD>Release a lock. 1232 <p> 1233<P> 1234<DD><DL> 1235<DT><B>Parameters:</B><DD><CODE>lock</CODE> - The lock to be released. 1236 <p> 1237 <p> 1238<DT><B>Throws:</B> 1239<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1240</DD> 1241</DL> 1242<HR> 1243 1244<A NAME="createLockerID()"><!-- --></A><H3> 1245createLockerID</H3> 1246<PRE> 1247public int <B>createLockerID</B>() 1248 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1249<DL> 1250<DD>Allocate a locker ID. 1251 <p> 1252 The locker ID is guaranteed to be unique for the database environment. 1253 <p> 1254 Call <A HREF="../../../com/sleepycat/db/Environment.html#freeLockerID(int)"><CODE>Environment.freeLockerID</CODE></A> to return the locker ID to 1255 the environment when it is no longer needed. 1256 <p> 1257<P> 1258<DD><DL> 1259 1260<DT><B>Returns:</B><DD>A locker ID. 1261<DT><B>Throws:</B> 1262<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1263</DD> 1264</DL> 1265<HR> 1266 1267<A NAME="freeLockerID(int)"><!-- --></A><H3> 1268freeLockerID</H3> 1269<PRE> 1270public void <B>freeLockerID</B>(int id) 1271 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1272<DL> 1273<DD>Free a locker ID. 1274 <p> 1275<P> 1276<DD><DL> 1277<DT><B>Parameters:</B><DD><CODE>id</CODE> - The locker id to be freed. 1278 <p> 1279 <p> 1280<DT><B>Throws:</B> 1281<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1282</DD> 1283</DL> 1284<HR> 1285 1286<A NAME="lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><!-- --></A><H3> 1287lockVector</H3> 1288<PRE> 1289public void <B>lockVector</B>(int locker, 1290 boolean noWait, 1291 <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</A>[] list) 1292 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1293<DL> 1294<DD>Atomically obtain and release one or more locks from the lock table. 1295 This method is intended to support acquisition or trading of 1296 multiple locks under one lock table semaphore, as is needed for lock 1297 coupling or in multigranularity locking for lock escalation. 1298 <p> 1299 If any of the requested locks cannot be acquired, or any of the locks to 1300 be released cannot be released, the operations before the failing 1301 operation are guaranteed to have completed successfully, and 1302 the method throws an exception. 1303 <p> 1304<P> 1305<DD><DL> 1306<DT><B>Parameters:</B><DD><CODE>noWait</CODE> - If a lock cannot be granted because the requested lock conflicts 1307 with an existing lock, throw a <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> 1308 immediately instead of waiting for the lock to become available. 1309 The index of the request that was not granted will be returned by 1310 <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html#getIndex()"><CODE>LockNotGrantedException.getIndex</CODE></A>. 1311 <p><DD><CODE>locker</CODE> - An unsigned 32-bit integer quantity representing the entity 1312 requesting the lock. 1313 <p><DD><CODE>list</CODE> - An array of <A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db"><CODE>LockRequest</CODE></A> objects, listing the requested lock 1314 operations. 1315 <p> 1316 <p> 1317<DT><B>Throws:</B> 1318<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1319</DD> 1320</DL> 1321<HR> 1322 1323<A NAME="openLogCursor()"><!-- --></A><H3> 1324openLogCursor</H3> 1325<PRE> 1326public <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</A> <B>openLogCursor</B>() 1327 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1328<DL> 1329<DD>Return a log cursor. 1330 <p> 1331<P> 1332<DD><DL> 1333 1334<DT><B>Returns:</B><DD>A log cursor. 1335 <p> 1336 <p> 1337<DT><B>Throws:</B> 1338<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1339</DD> 1340</DL> 1341<HR> 1342 1343<A NAME="getLogFileName(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3> 1344getLogFileName</H3> 1345<PRE> 1346public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLogFileName</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn) 1347 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1348<DL> 1349<DD>Return the name of the log file that contains the log record 1350 specified by a LogSequenceNumber object. 1351 <p> 1352 This mapping of LogSequenceNumber objects to files is needed for 1353 database administration. For example, a transaction manager 1354 typically records the earliest LogSequenceNumber object needed for 1355 restart, and the database administrator may want to archive log 1356 files to tape when they contain only log records before the earliest 1357 one needed for restart. 1358 <p> 1359<P> 1360<DD><DL> 1361<DT><B>Parameters:</B><DD><CODE>lsn</CODE> - The LogSequenceNumber object for which a filename is wanted. 1362 <p> 1363<DT><B>Returns:</B><DD>The name of the log file that contains the log record specified by a 1364 LogSequenceNumber object. 1365 <p> 1366 <p> 1367<DT><B>Throws:</B> 1368<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. 1369<p> 1370<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1371</DD> 1372</DL> 1373<HR> 1374 1375<A NAME="startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3> 1376startReplication</H3> 1377<PRE> 1378public void <B>startReplication</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> cdata, 1379 boolean master) 1380 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1381<DL> 1382<DD>Configure the database environment as a client or master in a group 1383 of replicated database environments. Replication master 1384 environments are the only database environments where replicated 1385 databases may be modified. Replication client environments are 1386 read-only as long as they are clients. Replication client 1387 environments may be upgraded to be replication master environments 1388 in the case that the current master fails or there is no master 1389 present. 1390 <p> 1391 The enclosing database environment must already have been configured 1392 to send replication messages by calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationTransport(int, com.sleepycat.db.ReplicationTransport)"><CODE>EnvironmentConfig.setReplicationTransport</CODE></A>. 1393 <p> 1394<P> 1395<DD><DL> 1396<DT><B>Parameters:</B><DD><CODE>cdata</CODE> - An opaque data item that is sent over the communication infrastructure 1397 when the client or master comes online. If no such information is 1398 useful, cdata should be null. 1399 <p><DD><CODE>master</CODE> - Configure the environment as a replication master. If false, the 1400 environment will be configured as as a replication client. 1401 <p> 1402 <p> 1403<DT><B>Throws:</B> 1404<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1405</DD> 1406</DL> 1407<HR> 1408 1409<A NAME="electReplicationMaster(int, int)"><!-- --></A><H3> 1410electReplicationMaster</H3> 1411<PRE> 1412public void <B>electReplicationMaster</B>(int nsites, 1413 int nvotes) 1414 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1415<DL> 1416<DD>Hold an election for the master of a replication group. 1417 <p> 1418 If the election is successful, the new master's ID may be the ID of the 1419 previous master, or the ID of the current environment. The application 1420 is responsible for adjusting its usage of the other environments in the 1421 replication group, including directing all database updates to the newly 1422 selected master, in accordance with the results of this election. 1423 <p> 1424 The thread of control that calls this method must not be the thread 1425 of control that processes incoming messages; processing the incoming 1426 messages is necessary to successfully complete an election. 1427 <p> 1428<P> 1429<DD><DL> 1430<DT><B>Parameters:</B><DD><CODE>nsites</CODE> - The number of environments that the application believes are in the 1431 replication group. This number is used by Berkeley DB to avoid 1432 having two masters active simultaneously, even in the case of a 1433 network partition. During an election, a new master cannot be 1434 elected unless more than half of nsites agree on the new master. 1435 Thus, in the face of a network partition, the side of the partition 1436 with more than half the environments will elect a new master and 1437 continue, while the environments communicating with fewer than half 1438 the other environments will fail to find a new master. 1439 <p><DD><CODE>nvotes</CODE> - The number of votes required by the application to successfully 1440 elect a new master. It must be a positive integer, no greater than 1441 nsites, or 0 if the election should use a simple majority of the 1442 nsites value as the requirement. A warning is given if half or 1443 fewer votes are required to win an election as that can potentially 1444 lead to multiple masters in the face of a network partition. 1445 <p> 1446 <p> 1447<DT><B>Throws:</B> 1448<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1449</DD> 1450</DL> 1451<HR> 1452 1453<A NAME="flushReplication()"><!-- --></A><H3> 1454flushReplication</H3> 1455<PRE> 1456public void <B>flushReplication</B>() 1457 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1458<DL> 1459<DD>Internal method: re-push the last log record to all clients, in case they've 1460 lost messages and don't know it. 1461 <p> 1462 This method may not be called before the database environment is opened. 1463 <p> 1464 <p> 1465<P> 1466<DD><DL> 1467 1468<DT><B>Throws:</B> 1469<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1470</DD> 1471</DL> 1472<HR> 1473 1474<A NAME="processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><!-- --></A><H3> 1475processReplicationMessage</H3> 1476<PRE> 1477public <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</A> <B>processReplicationMessage</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> control, 1478 <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> rec, 1479 int envid) 1480 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1481<DL> 1482<DD>Process an incoming replication message sent by a member of the 1483 replication group to the local database environment. 1484 <p> 1485 For implementation reasons, all incoming replication messages must 1486 be processed using the same <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. It is not 1487 required that a single thread of control process all messages, only 1488 that all threads of control processing messages use the same handle. 1489 <p> 1490<P> 1491<DD><DL> 1492<DT><B>Parameters:</B><DD><CODE>control</CODE> - A copy of the control parameter specified by Berkeley DB on the 1493 sending environment. 1494 <p><DD><CODE>envid</CODE> - The local identifier that corresponds to the environment that sent 1495 the message to be processed. 1496 <p><DD><CODE>rec</CODE> - A copy of the rec parameter specified by Berkeley DB on the sending 1497 environment. 1498 <p> 1499<DT><B>Returns:</B><DD>A <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db"><CODE>ReplicationStatus</CODE></A> object. 1500<DT><B>Throws:</B> 1501<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1502</DD> 1503</DL> 1504<HR> 1505 1506<A NAME="setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><!-- --></A><H3> 1507setReplicationConfig</H3> 1508<PRE> 1509public void <B>setReplicationConfig</B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config, 1510 boolean onoff) 1511 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1512<DL> 1513<DD>Configure the replication subsystem. 1514 <p> 1515 The database environment's replication subsystem may also be set using the environment's 1516DB_CONFIG file. The syntax of the entry in that file is a single line 1517with the string "rep_set_config", one or more whitespace characters, and the method configuration parameter as a string; for example, 1518 "rep_set_config REP_CONF_NOWAIT". 1519Because the DB_CONFIG file is read when the database environment is 1520opened, it will silently overrule configuration done before that time. 1521 <p> 1522 This method configures a database environment, including all threads 1523of control accessing the database environment, not only the operations 1524performed using a specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. 1525 <p> 1526 This method may be called at any time during the life of the application. 1527 <p> 1528<P> 1529<DD><DL> 1530<DT><B>Parameters:</B><DD><CODE>config</CODE> - A replication feature to be configured.<DD><CODE>onoff</CODE> - If true, the feature is enabled, otherwise it is disabled. 1531<DT><B>Throws:</B> 1532<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1533</DD> 1534</DL> 1535<HR> 1536 1537<A NAME="getReplicationConfig(com.sleepycat.db.ReplicationConfig)"><!-- --></A><H3> 1538getReplicationConfig</H3> 1539<PRE> 1540public boolean <B>getReplicationConfig</B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config) 1541 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1542<DL> 1543<DD>Get the configuration of the replication subsystem. 1544 This method may be called at any time during the life of the application. 1545<P> 1546<DD><DL> 1547 1548<DT><B>Returns:</B><DD>Whether the specified feature is enabled or disabled. 1549<DT><B>Throws:</B> 1550<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1551</DD> 1552</DL> 1553<HR> 1554 1555<A NAME="setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)"><!-- --></A><H3> 1556setReplicationTimeout</H3> 1557<PRE> 1558public void <B>setReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type, 1559 int replicationTimeout) 1560 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1561<DL> 1562<DD>Sets the timeout applied to the specified timeout type. 1563 This method may be called at any time during the life of the application. 1564<P> 1565<DD><DL> 1566<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of timeout to set. 1567 <p><DD><CODE>replicationTimeout</CODE> - The time in microseconds of the desired timeout. 1568<DT><B>Throws:</B> 1569<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1570</DD> 1571</DL> 1572<HR> 1573 1574<A NAME="getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)"><!-- --></A><H3> 1575getReplicationTimeout</H3> 1576<PRE> 1577public int <B>getReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type) 1578 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1579<DL> 1580<DD>Gets the timeout applied to the specified timeout type. 1581<P> 1582<DD><DL> 1583<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of timeout to retrieve. 1584 <p> 1585<DT><B>Returns:</B><DD>The timeout applied to the specified timout type, in microseconds. 1586 <p> 1587 <p> 1588<DT><B>Throws:</B> 1589<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1590</DD> 1591</DL> 1592<HR> 1593 1594<A NAME="syncReplication()"><!-- --></A><H3> 1595syncReplication</H3> 1596<PRE> 1597public void <B>syncReplication</B>() 1598 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1599<DL> 1600<DD>Forces synchronization to begin for this client. This method is the other 1601 half of setting <A HREF="../../../com/sleepycat/db/ReplicationConfig.html#DELAYCLIENT"><CODE>ReplicationConfig.DELAYCLIENT</CODE></A> with 1602 <A HREF="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><CODE>setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</CODE></A>. 1603 <p> 1604 When a new master is elected and the application has configured delayed 1605 synchronization, the application must choose when to perform 1606 synchronization by using this method. Otherwise the client will remain 1607 unsynchronized and will ignore all new incoming log messages. 1608 <p> 1609 This method may not be called before the database environment is opened. 1610 <p> 1611 <p> 1612<P> 1613<DD><DL> 1614 1615<DT><B>Throws:</B> 1616<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1617</DD> 1618</DL> 1619<HR> 1620 1621<A NAME="replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)"><!-- --></A><H3> 1622replicationManagerStart</H3> 1623<PRE> 1624public void <B>replicationManagerStart</B>(int nthreads, 1625 <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</A> policy) 1626 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1627<DL> 1628<DD>Starts the replication manager. 1629 <p> 1630 The replication manager is implemented inside the Berkeley DB library, 1631 it is designed to manage a replication group. This includes network 1632 transport, all replication message processing and acknowledgment, and 1633 group elections. 1634 <p> 1635 For more information on building replication manager applications, 1636 please see the "Replication Manager Getting Started Guide" included in 1637 the Berkeley DB documentation. 1638 <p> 1639 This method may not be called before the database environment is opened. 1640<P> 1641<DD><DL> 1642<DT><B>Parameters:</B><DD><CODE>nthreads</CODE> - Specify the number of threads of control created and dedicated to 1643 processing replication messages. In addition to these message processing 1644 threads, the replication manager creates and manages a few of its own 1645 threads of control. 1646 <p><DD><CODE>policy</CODE> - The policy defines the startup characteristics of a replication group. 1647 See <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db"><CODE>ReplicationManagerStartPolicy</CODE></A> for more information. 1648<DT><B>Throws:</B> 1649<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1650</DD> 1651</DL> 1652<HR> 1653 1654<A NAME="getReplicationManagerSiteList()"><!-- --></A><H3> 1655getReplicationManagerSiteList</H3> 1656<PRE> 1657public <A HREF="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</A>[] <B>getReplicationManagerSiteList</B>() 1658 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1659<DL> 1660<DD>Return an array of all sites known to the replication manager. 1661<P> 1662<DD><DL> 1663 1664<DT><B>Throws:</B> 1665<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1666</DD> 1667</DL> 1668<HR> 1669 1670<A NAME="getCacheStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1671getCacheStats</H3> 1672<PRE> 1673public <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</A> <B>getCacheStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1674 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1675<DL> 1676<DD><DL> 1677 1678<DT><B>Throws:</B> 1679<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1680</DD> 1681</DL> 1682<HR> 1683 1684<A NAME="getCacheFileStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1685getCacheFileStats</H3> 1686<PRE> 1687public <A HREF="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</A>[] <B>getCacheFileStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1688 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1689<DL> 1690<DD><DL> 1691 1692<DT><B>Throws:</B> 1693<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1694</DD> 1695</DL> 1696<HR> 1697 1698<A NAME="getLogStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1699getLogStats</H3> 1700<PRE> 1701public <A HREF="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</A> <B>getLogStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1702 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1703<DL> 1704<DD>Return the database environment's logging statistics. 1705 <p> 1706<P> 1707<DD><DL> 1708<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. 1709 <p> 1710<DT><B>Returns:</B><DD>The database environment's logging statistics. 1711 <p> 1712 <p> 1713<DT><B>Throws:</B> 1714<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1715</DD> 1716</DL> 1717<HR> 1718 1719<A NAME="getReplicationStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1720getReplicationStats</H3> 1721<PRE> 1722public <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</A> <B>getReplicationStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1723 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1724<DL> 1725<DD>Return the database environment's replication statistics. 1726 <p> 1727<P> 1728<DD><DL> 1729<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. 1730 <p> 1731<DT><B>Returns:</B><DD>The database environment's replication statistics. 1732 <p> 1733 <p> 1734<DT><B>Throws:</B> 1735<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1736</DD> 1737</DL> 1738<HR> 1739 1740<A NAME="getReplicationManagerStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1741getReplicationManagerStats</H3> 1742<PRE> 1743public <A HREF="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</A> <B>getReplicationManagerStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1744 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1745<DL> 1746<DD>Return the database environment's replication manager statistics. 1747 <p> 1748<P> 1749<DD><DL> 1750<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. 1751 <p> 1752<DT><B>Returns:</B><DD>The database environment's replication manager statistics. 1753 <p> 1754 <p> 1755<DT><B>Throws:</B> 1756<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1757</DD> 1758</DL> 1759<HR> 1760 1761<A NAME="getLockStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1762getLockStats</H3> 1763<PRE> 1764public <A HREF="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</A> <B>getLockStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1765 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1766<DL> 1767<DD>Return the database environment's locking statistics. 1768 <p> 1769<P> 1770<DD><DL> 1771<DT><B>Parameters:</B><DD><CODE>config</CODE> - The locking statistics attributes. If null, default attributes are used. 1772 <p> 1773<DT><B>Returns:</B><DD>The database environment's locking statistics. 1774 <p> 1775 <p> 1776<DT><B>Throws:</B> 1777<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1778</DD> 1779</DL> 1780<HR> 1781 1782<A NAME="getMutexStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1783getMutexStats</H3> 1784<PRE> 1785public <A HREF="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</A> <B>getMutexStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1786 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1787<DL> 1788<DD>Return the database environment's mutex statistics. 1789 <p> 1790<P> 1791<DD><DL> 1792<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used. 1793 <p> 1794<DT><B>Returns:</B><DD>The database environment's mutex statistics. 1795 <p> 1796 <p> 1797<DT><B>Throws:</B> 1798<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1799</DD> 1800</DL> 1801<HR> 1802 1803<A NAME="getTransactionStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3> 1804getTransactionStats</H3> 1805<PRE> 1806public <A HREF="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</A> <B>getTransactionStats</B>(<A HREF="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</A> config) 1807 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1808<DL> 1809<DD>Return the database environment's transactional statistics. 1810 <p> 1811<P> 1812<DD><DL> 1813<DT><B>Parameters:</B><DD><CODE>config</CODE> - The transactional statistics attributes. If null, default attributes are used. 1814 <p> 1815<DT><B>Returns:</B><DD>The database environment's transactional statistics. 1816 <p> 1817 <p> 1818<DT><B>Throws:</B> 1819<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1820</DD> 1821</DL> 1822<HR> 1823 1824<A NAME="beginCDSGroup()"><!-- --></A><H3> 1825beginCDSGroup</H3> 1826<PRE> 1827public <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> <B>beginCDSGroup</B>() 1828 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1829<DL> 1830<DD>Allocate a locker ID in an environment configured for Berkeley DB 1831 Concurrent Data Store applications. Returns a <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> object 1832 that uniquely identifies the locker ID. Calling the <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit()</CODE></A> method will discard the allocated locker ID. 1833 <p> 1834 See 1835 <a href="../../../../programmer_reference/cam.html#cam_intro" target="_top">Berkeley DB Concurrent Data Store applications</a> 1836 for more information about when this is required. 1837 <p> 1838<P> 1839<DD><DL> 1840 1841<DT><B>Returns:</B><DD>A transaction handle that wraps a CDS locker ID. 1842<DT><B>Throws:</B> 1843<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 1844</DD> 1845</DL> 1846<HR> 1847 1848<A NAME="beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><!-- --></A><H3> 1849beginTransaction</H3> 1850<PRE> 1851public <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> <B>beginTransaction</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> parent, 1852 <A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</A> config) 1853 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1854<DL> 1855<DD>Create a new transaction in the database environment. 1856 <p> 1857 Transactions may only span threads if they do so serially; that is, 1858 each transaction must be active in only a single thread of control 1859 at a time. 1860 <p> 1861 This restriction holds for parents of nested transactions as well; 1862 no two children may be concurrently active in more than one thread 1863 of control at any one time. 1864 <p> 1865 Cursors may not span transactions; that is, each cursor must be opened 1866 and closed within a single transaction. 1867 <p> 1868 A parent transaction may not issue any Berkeley DB operations -- 1869 except for <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A>, 1870 <A HREF="../../../com/sleepycat/db/Transaction.html#abort()"><CODE>Transaction.abort</CODE></A> and <A HREF="../../../com/sleepycat/db/Transaction.html#commit()"><CODE>Transaction.commit</CODE></A> -- 1871 while it has active child transactions (child transactions that have 1872 not yet been committed or aborted). 1873 <p> 1874<P> 1875<DD><DL> 1876<DT><B>Parameters:</B><DD><CODE>parent</CODE> - If the parent parameter is non-null, the new transaction will be a 1877 nested transaction, with the transaction indicated by parent as its 1878 parent. Transactions may be nested to any level. In the presence 1879 of distributed transactions and two-phase commit, only the parental 1880 transaction, that is a transaction without a parent specified, 1881 should be passed as an parameter to <A HREF="../../../com/sleepycat/db/Transaction.html#prepare(byte[])"><CODE>Transaction.prepare</CODE></A>. 1882 <p><DD><CODE>config</CODE> - The transaction attributes. If null, default attributes are used. 1883 <p> 1884<DT><B>Returns:</B><DD>The newly created transaction's handle. 1885 <p> 1886<DT><B>Throws:</B> 1887<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1888</DD> 1889</DL> 1890<HR> 1891 1892<A NAME="checkpoint(com.sleepycat.db.CheckpointConfig)"><!-- --></A><H3> 1893checkpoint</H3> 1894<PRE> 1895public void <B>checkpoint</B>(<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A> config) 1896 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1897<DL> 1898<DD>Synchronously checkpoint the database environment. 1899 <p> 1900 <p> 1901<P> 1902<DD><DL> 1903<DT><B>Parameters:</B><DD><CODE>config</CODE> - The checkpoint attributes. If null, default attributes are used. 1904 <p> 1905<DT><B>Throws:</B> 1906<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1907</DD> 1908</DL> 1909<HR> 1910 1911<A NAME="logFlush(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3> 1912logFlush</H3> 1913<PRE> 1914public void <B>logFlush</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn) 1915 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1916<DL> 1917<DD>Flush log records to stable storage. 1918 <p> 1919<P> 1920<DD><DL> 1921<DT><B>Parameters:</B><DD><CODE>lsn</CODE> - All log records with LogSequenceNumber values less than or equal to 1922 the lsn parameter are written to stable storage. If lsn is null, 1923 all records in the log are flushed. 1924 <p> 1925 <p> 1926<DT><B>Throws:</B> 1927<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1928</DD> 1929</DL> 1930<HR> 1931 1932<A NAME="logPut(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3> 1933logPut</H3> 1934<PRE> 1935public <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> <B>logPut</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, 1936 boolean flush) 1937 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1938<DL> 1939<DD>Append a record to the log. 1940 <p> 1941<P> 1942<DD><DL> 1943<DT><B>Parameters:</B><DD><CODE>data</CODE> - The record to append to the log. 1944 <p> 1945 The caller is responsible for providing any necessary structure to 1946 data. (For example, in a write-ahead logging protocol, the 1947 application must understand what part of data is an operation code, 1948 what part is redo information, and what part is undo information. 1949 In addition, most transaction managers will store in data the 1950 LogSequenceNumber of the previous log record for the same 1951 transaction, to support chaining back through the transaction's log 1952 records during undo.) 1953 <p><DD><CODE>flush</CODE> - The log is forced to disk after this record is written, guaranteeing 1954 that all records with LogSequenceNumber values less than or equal 1955 to the one being "put" are on disk before this method returns. 1956 <p> 1957<DT><B>Returns:</B><DD>The LogSequenceNumber of the put record. 1958 <p> 1959 <p> 1960<DT><B>Throws:</B> 1961<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1962</DD> 1963</DL> 1964<HR> 1965 1966<A NAME="logPrint(com.sleepycat.db.Transaction, java.lang.String)"><!-- --></A><H3> 1967logPrint</H3> 1968<PRE> 1969public void <B>logPrint</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, 1970 <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> message) 1971 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1972<DL> 1973<DD>Append an informational message to the Berkeley DB database environment log files. 1974 <p> 1975 This method allows applications to include information in 1976 the database environment log files, for later review using the 1977 <a href="../../../../api_reference/C/db_printlog.html" target="_top">db_printlog</a> 1978 utility. This method is intended for debugging and performance tuning. 1979 <p> 1980<P> 1981<DD><DL> 1982<DT><B>Parameters:</B><DD><CODE>txn</CODE> - If the logged message refers to an application-specified transaction, 1983 the <code>txn</code> parameter is a transaction handle, otherwise 1984 <code>null</code>. 1985 <p> 1986 <p> 1987<DT><B>Throws:</B> 1988<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 1989</DD> 1990</DL> 1991<HR> 1992 1993<A NAME="getArchiveLogFiles(boolean)"><!-- --></A><H3> 1994getArchiveLogFiles</H3> 1995<PRE> 1996public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] <B>getArchiveLogFiles</B>(boolean includeInUse) 1997 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 1998<DL> 1999<DD><DL> 2000 2001<DT><B>Throws:</B> 2002<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 2003</DD> 2004</DL> 2005<HR> 2006 2007<A NAME="getArchiveDatabases()"><!-- --></A><H3> 2008getArchiveDatabases</H3> 2009<PRE> 2010public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] <B>getArchiveDatabases</B>() 2011 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2012<DL> 2013<DD><DL> 2014 2015<DT><B>Throws:</B> 2016<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 2017</DD> 2018</DL> 2019<HR> 2020 2021<A NAME="removeOldLogFiles()"><!-- --></A><H3> 2022removeOldLogFiles</H3> 2023<PRE> 2024public void <B>removeOldLogFiles</B>() 2025 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2026<DL> 2027<DD>Remove log files that are no longer needed. 2028 <p> 2029 Automatic log file removal is likely to make catastrophic recovery 2030 impossible. 2031 <p> 2032 <p> 2033<P> 2034<DD><DL> 2035 2036<DT><B>Throws:</B> 2037<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 2038</DD> 2039</DL> 2040<HR> 2041 2042<A NAME="recover(int, boolean)"><!-- --></A><H3> 2043recover</H3> 2044<PRE> 2045public <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</A>[] <B>recover</B>(int count, 2046 boolean continued) 2047 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2048<DL> 2049<DD><DL> 2050 2051<DT><B>Throws:</B> 2052<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 2053</DD> 2054</DL> 2055<HR> 2056 2057<A NAME="resetFileID(java.lang.String, boolean)"><!-- --></A><H3> 2058resetFileID</H3> 2059<PRE> 2060public void <B>resetFileID</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, 2061 boolean encrypted) 2062 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2063<DL> 2064<DD>Allows database files to be copied, and then the copy used in the same 2065 database environment as the original. 2066 <p> 2067 All databases contain an ID string used to identify the database in the 2068 database environment cache. If a physical database file is copied, and 2069 used in the same environment as another file with the same ID strings, 2070 corruption can occur. This method creates new ID strings for all of 2071 the databases in the physical file. 2072 <p> 2073 This method modifies the physical file, in-place. 2074 Applications should not reset IDs in files that are currently in use. 2075 <p> 2076 This method may be called at any time during the life of the application. 2077 <p> 2078<P> 2079<DD><DL> 2080<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The name of the physical file in which the LSNs are to be cleared.<DD><CODE>encrypted</CODE> - Whether the file contains encrypted databases. 2081 <p> 2082<DT><B>Throws:</B> 2083<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 2084</DD> 2085</DL> 2086<HR> 2087 2088<A NAME="resetLogSequenceNumber(java.lang.String, boolean)"><!-- --></A><H3> 2089resetLogSequenceNumber</H3> 2090<PRE> 2091public void <B>resetLogSequenceNumber</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> filename, 2092 boolean encrypted) 2093 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2094<DL> 2095<DD>Allows database files to be moved from one transactional database 2096 environment to another. 2097 <p> 2098 Database pages in transactional database environments contain references 2099 to the environment's log files (that is, log sequence numbers, or LSNs). 2100 Copying or moving a database file from one database environment to 2101 another, and then modifying it, can result in data corruption if the 2102 LSNs are not first cleared. 2103 <p> 2104 Note that LSNs should be reset before moving or copying the database 2105 file into a new database environment, rather than moving or copying the 2106 database file and then resetting the LSNs. Berkeley DB has consistency checks 2107 that may be triggered if an application calls this method 2108 on a database in a new environment when the database LSNs still reflect 2109 the old environment. 2110 <p> 2111 This method modifies the physical file, in-place. 2112 Applications should not reset LSNs in files that are currently in use. 2113 <p> 2114 This method may be called at any time during the life of the application. 2115 <p> 2116<P> 2117<DD><DL> 2118<DT><B>Parameters:</B><DD><CODE>filename</CODE> - The name of the physical file in which the LSNs are to be cleared.<DD><CODE>encrypted</CODE> - Whether the file contains encrypted databases. 2119 <p> 2120<DT><B>Throws:</B> 2121<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> 2122</DD> 2123</DL> 2124<HR> 2125 2126<A NAME="panic(boolean)"><!-- --></A><H3> 2127panic</H3> 2128<PRE> 2129public void <B>panic</B>(boolean onoff) 2130 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2131<DL> 2132<DD>Set the panic state for the database environment. 2133 Database environments in a panic state normally refuse all attempts to 2134 call library functions, throwing a <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>. 2135 <p> 2136 This method configures a database environment, including all threads 2137of control accessing the database environment, not only the operations 2138performed using a specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. 2139 <p> 2140 This method may be called at any time during the life of the application. 2141 <p> 2142<P> 2143<DD><DL> 2144<DT><B>Parameters:</B><DD><CODE>onoff</CODE> - If true, set the panic state for the database environment. 2145<DT><B>Throws:</B> 2146<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 2147</DD> 2148</DL> 2149<HR> 2150 2151<A NAME="getVersionString()"><!-- --></A><H3> 2152getVersionString</H3> 2153<PRE> 2154public static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getVersionString</B>()</PRE> 2155<DL> 2156<DD>Return the release version information, suitable for display. 2157<p> 2158This method may be called at any time during the life of the application. 2159<p> 2160<P> 2161<DD><DL> 2162 2163<DT><B>Returns:</B><DD>The release version information, suitable for display.</DL> 2164</DD> 2165</DL> 2166<HR> 2167 2168<A NAME="getVersionMajor()"><!-- --></A><H3> 2169getVersionMajor</H3> 2170<PRE> 2171public static int <B>getVersionMajor</B>()</PRE> 2172<DL> 2173<DD>Return the release major number. 2174<p> 2175This method may be called at any time during the life of the application. 2176<p> 2177<P> 2178<DD><DL> 2179 2180<DT><B>Returns:</B><DD>The release major number.</DL> 2181</DD> 2182</DL> 2183<HR> 2184 2185<A NAME="syncCache(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3> 2186syncCache</H3> 2187<PRE> 2188public void <B>syncCache</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> logSequenceNumber) 2189 throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> 2190<DL> 2191<DD>Ensure that all modified pages in the cache are flushed to their backing files. 2192<p> 2193Pages in the cache that cannot be immediately written back to disk (for example 2194pages that are currently in use by another thread of control) are waited for 2195and written to disk as soon as it is possible to do so. 2196<p> 2197<P> 2198<DD><DL> 2199<DT><B>Parameters:</B><DD><CODE>logSequenceNumber</CODE> - The purpose of the logSequenceNumber parameter is to enable a transaction 2200manager to ensure, as part of a checkpoint, that all pages modified by a 2201certain time have been written to disk. 2202<p> 2203All modified pages with a log sequence number less than the logSequenceNumber 2204parameter are written to disk. If logSequenceNumber is null, all modified 2205pages in the cache are written to disk. 2206<DT><B>Throws:</B> 2207<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL> 2208</DD> 2209</DL> 2210<HR> 2211 2212<A NAME="getVersionMinor()"><!-- --></A><H3> 2213getVersionMinor</H3> 2214<PRE> 2215public static int <B>getVersionMinor</B>()</PRE> 2216<DL> 2217<DD>Return the release minor number. 2218<p> 2219This method may be called at any time during the life of the application. 2220<p> 2221<P> 2222<DD><DL> 2223 2224<DT><B>Returns:</B><DD>The release minor number.</DL> 2225</DD> 2226</DL> 2227<HR> 2228 2229<A NAME="getVersionPatch()"><!-- --></A><H3> 2230getVersionPatch</H3> 2231<PRE> 2232public static int <B>getVersionPatch</B>()</PRE> 2233<DL> 2234<DD>Return the release patch number. 2235<p> 2236This method may be called at any time during the life of the application. 2237<p> 2238<P> 2239<DD><DL> 2240 2241<DT><B>Returns:</B><DD>The release patch number.</DL> 2242</DD> 2243</DL> 2244<!-- ========= END OF CLASS DATA ========= --> 2245<HR> 2246 2247 2248<!-- ======= START OF BOTTOM NAVBAR ====== --> 2249<A NAME="navbar_bottom"><!-- --></A> 2250<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 2251<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 2252<TR> 2253<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 2254<A NAME="navbar_bottom_firstrow"><!-- --></A> 2255<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 2256 <TR ALIGN="center" VALIGN="top"> 2257 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 2258 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 2259 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 2260 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Environment.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 2261 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 2262 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 2263 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 2264 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 2265 </TR> 2266</TABLE> 2267</TD> 2268<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 2269<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM> 2270</TD> 2271</TR> 2272 2273<TR> 2274<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 2275 <A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 2276 <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 2277<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 2278 <A HREF="../../../index.html?com/sleepycat/db/Environment.html" target="_top"><B>FRAMES</B></A> 2279 <A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A> 2280 <SCRIPT type="text/javascript"> 2281 <!-- 2282 if(window==top) { 2283 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 2284 } 2285 //--> 2286</SCRIPT> 2287<NOSCRIPT> 2288 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 2289</NOSCRIPT> 2290 2291 2292</FONT></TD> 2293</TR> 2294<TR> 2295<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 2296 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 2297<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 2298DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 2299</TR> 2300</TABLE> 2301<A NAME="skip-navbar_bottom"></A> 2302<!-- ======== END OF BOTTOM NAVBAR ======= --> 2303 2304<HR> 2305<font size=1>Copyright (c) 1996-2009 Oracle. All rights reserved.</font> 2306</BODY> 2307</HTML> 2308
