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