<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_0) on Wed Dec 30 04:50:31 EST 2009 -->
<TITLE>
Environment
</TITLE>
<META NAME="date" CONTENT="2009-12-30">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Environment";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/Environment.html" target="_top"><B>FRAMES</B></A>
<A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.db</FONT>
<BR>
Class Environment</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.Environment</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>Environment</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
A database environment. Environments include support for some or
all of caching, locking, logging and transactions.
<p>
To open an existing environment with default attributes the application
may use a default environment configuration object or null:
<p>
<blockquote><pre>
// Open an environment handle with default attributes.
Environment env = new Environment(home, new EnvironmentConfig());
</pre></blockquote>
<p>
or
<p>
<blockquote><pre>
Environment env = new Environment(home, null);
</pre></blockquote>
<p>
Note that many Environment objects may access a single environment.
<p>
To create an environment or customize attributes, the application should
customize the configuration class. For example:
<p>
<blockquote><pre>
EnvironmentConfig envConfig = new EnvironmentConfig();
envConfig.setTransactional(true);
envConfig.setAllowCreate(true);
envConfig.setCacheSize(1000000);
<p>
Environment newlyCreatedEnv = new Environment(home, envConfig);
</pre></blockquote>
<p>
Environment 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.
<p>
An <em>environment handle</em> is an Environment instance. More than
one Environment instance may be created for the same physical directory,
which is the same as saying that more than one Environment handle may
be open at one time for a given environment.
<p>
The Environment handle should not be closed while any other handle
remains open that is using it as a reference (for example,
<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>
is called, this object may not be accessed again, regardless of
whether or not it throws an exception.
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)">Environment</A></B>(java.io.File home,
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE>
<BR>
Create a database environment handle.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#beginCDSGroup()">beginCDSGroup</A></B>()</CODE>
<BR>
Allocate a locker ID in an environment configured for Berkeley DB
Concurrent Data Store applications.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A></CODE></FONT></TD>
<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,
<A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</A> config)</CODE>
<BR>
Create a new transaction in the database environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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>
<BR>
Synchronously checkpoint the database environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#close()">close</A></B>()</CODE>
<BR>
Close the database environment, freeing any allocated resources and
closing any underlying subsystems.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#createLockerID()">createLockerID</A></B>()</CODE>
<BR>
Allocate a locker ID.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<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>
<BR>
Run one iteration of the deadlock detector.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#electReplicationMaster(int, int)">electReplicationMaster</A></B>(int nsites,
int nvotes)</CODE>
<BR>
Hold an election for the master of a replication group.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#flushReplication()">flushReplication</A></B>()</CODE>
<BR>
Internal method: re-push the last log record to all clients, in case they've
lost messages and don't know it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#freeLockerID(int)">freeLockerID</A></B>(int id)</CODE>
<BR>
Free a locker ID.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.io.File[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getArchiveDatabases()">getArchiveDatabases</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.io.File[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getArchiveLogFiles(boolean)">getArchiveLogFiles</A></B>(boolean includeInUse)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</A>[]</CODE></FONT></TD>
<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>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db">CacheStats</A></CODE></FONT></TD>
<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>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getConfig()">getConfig</A></B>()</CODE>
<BR>
Return this object's configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.io.File</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getHome()">getHome</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A></CODE></FONT></TD>
<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,
boolean noWait,
<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> object,
<A HREF="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</A> mode)</CODE>
<BR>
Acquire a lock from the lock table.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/LockStats.html" title="class in com.sleepycat.db">LockStats</A></CODE></FONT></TD>
<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>
<BR>
Return the database environment's locking statistics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<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>
<BR>
Return the name of the log file that contains the log record
specified by a LogSequenceNumber object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/LogStats.html" title="class in com.sleepycat.db">LogStats</A></CODE></FONT></TD>
<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>
<BR>
Return the database environment's logging statistics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/MutexStats.html" title="class in com.sleepycat.db">MutexStats</A></CODE></FONT></TD>
<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>
<BR>
Return the database environment's mutex statistics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<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>
<BR>
Get the configuration of the replication subsystem.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getReplicationManagerSiteList()">getReplicationManagerSiteList</A></B>()</CODE>
<BR>
Return an array of all sites known to the replication manager.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</A></CODE></FONT></TD>
<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>
<BR>
Return the database environment's replication manager statistics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</A></CODE></FONT></TD>
<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>
<BR>
Return the database environment's replication statistics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<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>
<BR>
Get the network timeout applied to the specified timeout type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</A></CODE></FONT></TD>
<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>
<BR>
Return the database environment's transactional statistics.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionMajor()">getVersionMajor</A></B>()</CODE>
<BR>
Return the release major number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionMinor()">getVersionMinor</A></B>()</CODE>
<BR>
Return the release minor number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionPatch()">getVersionPatch</A></B>()</CODE>
<BR>
Return the release patch number.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#getVersionString()">getVersionString</A></B>()</CODE>
<BR>
Return the release version information, suitable for display.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])">lockVector</A></B>(int locker,
boolean noWait,
<A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</A>[] list)</CODE>
<BR>
Atomically obtain and release one or more locks from the lock table.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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>
<BR>
Flush log records to stable storage.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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,
java.lang.String message)</CODE>
<BR>
Append an informational message to the Berkeley DB database environment log files.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A></CODE></FONT></TD>
<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,
boolean flush)</CODE>
<BR>
Append a record to the log.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD>
<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,
java.lang.String fileName,
java.lang.String databaseName,
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> config)</CODE>
<BR>
Open a database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#openLogCursor()">openLogCursor</A></B>()</CODE>
<BR>
Return a log cursor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</A></CODE></FONT></TD>
<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,
java.lang.String fileName,
java.lang.String databaseName,
<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase,
<A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config)</CODE>
<BR>
Open a database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#panic(boolean)">panic</A></B>(boolean onoff)</CODE>
<BR>
Set the panic state for the database environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</A></CODE></FONT></TD>
<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,
<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> rec,
int envid)</CODE>
<BR>
Process an incoming replication message sent by a member of the
replication group to the local database environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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>
<BR>
Release a lock.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#recover(int, boolean)">recover</A></B>(int count,
boolean continued)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)">remove</A></B>(java.io.File home,
boolean force,
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)</CODE>
<BR>
Destroy a database environment.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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,
java.lang.String fileName,
java.lang.String databaseName)</CODE>
<BR>
Remove a database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#removeOldLogFiles()">removeOldLogFiles</A></B>()</CODE>
<BR>
Remove log files that are no longer needed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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,
java.lang.String fileName,
java.lang.String databaseName,
java.lang.String newName)</CODE>
<BR>
Rename a database.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)">replicationManagerStart</A></B>(int nthreads,
<A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</A> policy)</CODE>
<BR>
Starts the replication manager.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#resetFileID(java.lang.String, boolean)">resetFileID</A></B>(java.lang.String filename,
boolean encrypted)</CODE>
<BR>
Allows database files to be copied, and then the copy used in the same
database environment as the original.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#resetLogSequenceNumber(java.lang.String, boolean)">resetLogSequenceNumber</A></B>(java.lang.String filename,
boolean encrypted)</CODE>
<BR>
Allows database files to be moved from one transactional database
environment to another.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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>
<BR>
Change the settings in an existing environment handle.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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,
boolean onoff)</CODE>
<BR>
Configure the replication subsystem.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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,
int replicationTimeout)</CODE>
<BR>
Set the network timeout applied to the specified timeout type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<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,
boolean master)</CODE>
<BR>
Configure the database environment as a client or master in a group
of replicated database environments.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#syncReplication()">syncReplication</A></B>()</CODE>
<BR>
Forces synchronization to begin for this client.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/Environment.html#trickleCacheWrite(int)">trickleCacheWrite</A></B>(int percent)</CODE>
<BR>
Ensure that a specified percent of the pages in the shared memory
pool are clean, by writing dirty pages to their backing files.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Environment(java.io.File, com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3>
Environment</H3>
<PRE>
public <B>Environment</B>(java.io.File home,
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>,
java.io.FileNotFoundException</PRE>
<DL>
<DD>Create a database environment handle.
<p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>home</CODE> - The database environment's home directory.
The environment variable <code>DB_HOME</code> may be used as
the path of the database home.
For more information on <code>envHome</code> and filename
resolution in general, see
<a href="../../../../ref/env/naming.html" target="_top">File Naming</a>.
<p><DD><CODE>config</CODE> - The database environment attributes. If null, default attributes are used.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an invalid parameter was specified.
<p>
<p>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
public void <B>close</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Close the database environment, freeing any allocated resources and
closing any underlying subsystems.
<p>
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
handle that refers to it is not yet closed; for example, database
environment handles must not be closed while database handles remain
open, or transactions in the environment have not yet been committed
or aborted. Specifically, this includes <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>,
<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>
handles.
<p>
Where the environment was initialized with a locking subsystem,
closing the environment does not release any locks still held by the
closing process, providing functionality for long-lived locks.
<p>
Where the environment was initialized with a transaction subsystem,
closing the environment aborts any unresolved transactions.
Applications should not depend on this behavior for transactions
involving databases; all such transactions should be explicitly
resolved. The problem with depending on this semantic is that
aborting an unresolved transaction involving database operations
requires a database handle. Because the database handles should
have been closed before closing the environment, it will not be
possible to abort the transaction, and recovery will have to be run
on the database environment before further operations are done.
<p>
Where log cursors were created, closing the environment does not
imply closing those cursors.
<p>
In multithreaded applications, only a single thread may call this
method.
<p>
After this method has been called, regardless of its return, the
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle may not be accessed again.
<p>
<p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="remove(java.io.File, boolean, com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3>
remove</H3>
<PRE>
public static void <B>remove</B>(java.io.File home,
boolean force,
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>,
java.io.FileNotFoundException</PRE>
<DL>
<DD>Destroy a database environment.
<p>
If the environment is not in use, the environment regions, including
any backing files, are removed. Any log or database files and the
environment directory itself are not removed.
<p>
If there are processes currently using the database environment,
this method will fail without further action (unless the force
argument is true, in which case the environment will be removed,
regardless of any processes still using it).
<p>
The result of attempting to forcibly destroy the environment when
it is in use is unspecified. Processes using an environment often
maintain open file descriptors for shared regions within it. On
UNIX systems, the environment removal will usually succeed, and
processes that have already joined the region will continue to run
in that region without change. However, processes attempting to
join the environment will either fail or create new regions. On
other systems in which the unlink system call will fail if any
process has an open file descriptor for the file (for example
Windows/NT), the region removal will fail.
<p>
Calling this method should not be necessary for most applications
because the environment is cleaned up as part of normal
database recovery procedures. However, applications may want to call
this method as part of application shut down to free up system
resources. For example, if system shared memory was used to back
the database environment, it may be useful to call this method in
order to release system shared memory segments that have been
allocated. Or, on architectures in which mutexes require allocation
of underlying system resources, it may be useful to call
this method in order to release those resources. Alternatively, if
recovery is not required because no database state is maintained
across failures, and no system resources need to be released, it is
possible to clean up an environment by simply removing all the
Berkeley DB files in the database environment's directories.
<p>
In multithreaded applications, only a single thread may call this
method.
<p>
After this method has been called, regardless of its return, the
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle may not be
accessed again.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>home</CODE> - The database environment to be removed.
On Windows platforms, this argument will be interpreted as a UTF-8
string, which is equivalent to ASCII for Latin characters.
<p><DD><CODE>force</CODE> - The environment is removed, regardless of any processes that may
still using it, and no locks are acquired during this process.
(Generally, the force argument is specified only when applications
were unable to shut down cleanly, and there is a risk that an
application may have died holding a Berkeley DB mutex or lock.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setConfig(com.sleepycat.db.EnvironmentConfig)"><!-- --></A><H3>
setConfig</H3>
<PRE>
public void <B>setConfig</B>(<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Change the settings in an existing environment handle.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The database environment attributes. If null, default attributes are used.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an invalid parameter was specified.
<p>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getConfig()"><!-- --></A><H3>
getConfig</H3>
<PRE>
public <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> <B>getConfig</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return this object's configuration.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>This object's configuration.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><!-- --></A><H3>
openDatabase</H3>
<PRE>
public <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,
java.lang.String fileName,
java.lang.String databaseName,
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>,
java.io.FileNotFoundException</PRE>
<DL>
<DD>Open a database.
<p>
The database is represented by the file and database parameters.
<p>
The currently supported database file formats (or <em>access
methods</em>) are Btree, Hash, Queue, and Recno. The Btree format is a
representation of a sorted, balanced tree structure. The Hash format
is an extensible, dynamic hashing scheme. The Queue format supports
fast access to fixed-length records accessed sequentially or by logical
record number. The Recno format supports fixed- or variable-length
records, accessed sequentially or by logical record number, and
optionally backed by a flat text file.
<p>
Storage 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>
for more information.
<p>
Opening a database is a relatively expensive operation, and maintaining
a set of open databases will normally be preferable to repeatedly
opening and closing the database for each new query.
<p>
In-memory databases never intended to be preserved on disk may be
created by setting both the fileName and databaseName parameters to
null. Note that in-memory databases can only ever be shared by sharing
the single database handle that created them, in circumstances where
doing so is safe. The environment variable <code>TMPDIR</code> may
be used as a directory in which to create temporary backing files.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null
may be specified to use auto-commit. For a non-transactional database, null
must be specified.
Note that transactionally protected operations on a Database handle
require that the Database handle itself be transactionally protected
during its open, either with a non-null transaction handle, or by calling
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><CODE>DatabaseConfig.setTransactional</CODE></A> on the configuration object.
<p><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database.
On Windows platforms, this argument will be interpreted as a UTF-8
string, which is equivalent to ASCII for Latin characters.
<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple
databases in a single file. Although no databaseName parameter needs
to be specified, it is an error to attempt to open a second database in
a physical file that was not initially created using a databaseName
parameter. Further, the databaseName parameter is not supported by the
Queue format.
<p><DD><CODE>config</CODE> - The database open attributes. If null, default attributes are used.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"><!-- --></A><H3>
openSecondaryDatabase</H3>
<PRE>
public <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,
java.lang.String fileName,
java.lang.String databaseName,
<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase,
<A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>,
java.io.FileNotFoundException</PRE>
<DL>
<DD>Open a database.
<p>
The database is represented by the file and database parameters.
<p>
The currently supported database file formats (or <em>access
methods</em>) are Btree, Hash, Queue, and Recno. The Btree format is a
representation of a sorted, balanced tree structure. The Hash format
is an extensible, dynamic hashing scheme. The Queue format supports
fast access to fixed-length records accessed sequentially or by logical
record number. The Recno format supports fixed- or variable-length
records, accessed sequentially or by logical record number, and
optionally backed by a flat text file.
<p>
Storage 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>
for more information.
<p>
Opening a database is a relatively expensive operation, and maintaining
a set of open databases will normally be preferable to repeatedly
opening and closing the database for each new query.
<p>
In-memory databases never intended to be preserved on disk may be
created by setting both the fileName and databaseName parameters to
null. Note that in-memory databases can only ever be shared by sharing
the single database handle that created them, in circumstances where
doing so is safe. The environment variable <code>TMPDIR</code> may
be used as a directory in which to create temporary backing files.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null
may be specified to use auto-commit. For a non-transactional database, null
must be specified.
Note that transactionally protected operations on a Database handle
require that the Database handle itself be transactionally protected
during its open, either with a non-null transaction handle, or by calling
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)"><CODE>DatabaseConfig.setTransactional</CODE></A> on the configuration object.
<p><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database.
On Windows platforms, this argument will be interpreted as a UTF-8
string, which is equivalent to ASCII for Latin characters.
<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple
databases in a single file. Although no databaseName parameter needs
to be specified, it is an error to attempt to open a second database in
a physical file that was not initially created using a databaseName
parameter. Further, the databaseName parameter is not supported by the
Queue format.
<p><DD><CODE>primaryDatabase</CODE> - a database handle for the primary database that is to be indexed.
<p><DD><CODE>config</CODE> - The secondary database open attributes. If null, default attributes are used.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE>
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="removeDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String)"><!-- --></A><H3>
removeDatabase</H3>
<PRE>
public void <B>removeDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn,
java.lang.String fileName,
java.lang.String databaseName)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>,
java.io.FileNotFoundException</PRE>
<DL>
<DD><p>
Remove a database.
<p>
If no database is specified, the underlying file specified is removed.
<p>
Applications should never remove databases with open <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A>
handles, or in the case of removing a file, when any database in the
file has an open handle. For example, some architectures do not permit
the removal of files with open system handles. On these architectures,
attempts to remove databases currently in use by any thread of control
in the system may fail.
<p>
The
environment variable DB_HOME may be used as the path of the database
environment home.
<p>
This method is affected by any database directory specified with
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>EnvironmentConfig.addDataDir</CODE></A>, or by setting the "set_data_dir"
string in the database environment's DB_CONFIG file.
<p>
The <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle may not be accessed
again after this method is called, regardless of this method's success
or failure.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null
may be specified to use auto-commit. For a non-transactional database, null
must be specified.
<p><DD><CODE>fileName</CODE> - The physical file which contains the database to be removed.
On Windows platforms, this argument will be interpreted as a UTF-8
string, which is equivalent to ASCII for Latin characters.
<p><DD><CODE>databaseName</CODE> - The database to be removed.
<p>
<p>
<DT><B>Throws:</B>
<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
deadlock.
<p>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="renameDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
renameDatabase</H3>
<PRE>
public void <B>renameDatabase</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn,
java.lang.String fileName,
java.lang.String databaseName,
java.lang.String newName)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>,
java.io.FileNotFoundException</PRE>
<DL>
<DD><p>
Rename a database.
<p>
If no database name is specified, the underlying file specified is
renamed, incidentally renaming all of the databases it contains.
<p>
Applications should never rename databases that are currently in use.
If an underlying file is being renamed and logging is currently enabled
in the database environment, no database in the file may be open when
this method is called. In particular, some architectures do not permit
renaming files with open handles. On these architectures, attempts to
rename databases that are currently in use by any thread of control in
the system may fail.
<p>
The
environment variable DB_HOME may be used as the path of the database
environment home.
<p>
This method is affected by any database directory specified with
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>EnvironmentConfig.addDataDir</CODE></A>, or by setting the "set_data_dir"
string in the database environment's DB_CONFIG file.
<p>
The <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle may not be accessed
again after this method is called, regardless of this method's success
or failure.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified, or null
may be specified to use auto-commit. For a non-transactional database, null
must be specified.
<p><DD><CODE>fileName</CODE> - The physical file which contains the database to be renamed.
On Windows platforms, this argument will be interpreted as a UTF-8
string, which is equivalent to ASCII for Latin characters.
<p><DD><CODE>databaseName</CODE> - The database to be renamed.
<p><DD><CODE>newName</CODE> - The new name of the database or file.
<p>
<p>
<DT><B>Throws:</B>
<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
deadlock.
<p>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.
<DD><CODE>java.io.FileNotFoundException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getHome()"><!-- --></A><H3>
getHome</H3>
<PRE>
public java.io.File <B>getHome</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="trickleCacheWrite(int)"><!-- --></A><H3>
trickleCacheWrite</H3>
<PRE>
public int <B>trickleCacheWrite</B>(int percent)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Ensure that a specified percent of the pages in the shared memory
pool are clean, by writing dirty pages to their backing files.
<p>
The purpose of this method is to enable a memory pool manager to ensure
that a page is always available for reading in new information
without having to wait for a write.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>percent</CODE> - The percent of the pages in the cache that should be clean.
<p>
<DT><B>Returns:</B><DD>The number of pages that were written to reach the specified
percentage.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="detectDeadlocks(com.sleepycat.db.LockDetectMode)"><!-- --></A><H3>
detectDeadlocks</H3>
<PRE>
public int <B>detectDeadlocks</B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> mode)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Run one iteration of the deadlock detector.
<p>
The deadlock detector traverses the lock table and marks one of the
participating lock requesters for rejection in each deadlock it finds.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mode</CODE> - Which lock request(s) to reject.
<p>
<DT><B>Returns:</B><DD>The number of lock requests that were rejected.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getLock(int, boolean, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockRequestMode)"><!-- --></A><H3>
getLock</H3>
<PRE>
public <A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> <B>getLock</B>(int locker,
boolean noWait,
<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> object,
<A HREF="../../../com/sleepycat/db/LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</A> mode)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Acquire a lock from the lock table.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locker</CODE> - An unsigned 32-bit integer quantity representing the entity
requesting the lock.
<p><DD><CODE>mode</CODE> - The lock mode.
<p><DD><CODE>noWait</CODE> - If a lock cannot be granted because the requested lock conflicts
with an existing lock, throw a <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A>
immediately instead of waiting for the lock to become available.
<p><DD><CODE>object</CODE> - An untyped byte string that specifies the object to be locked.
Applications using the locking subsystem directly while also doing
locking via the Berkeley DB access methods must take care not to
inadvertently lock objects that happen to be equal to the unique
file IDs used to lock files.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="putLock(com.sleepycat.db.Lock)"><!-- --></A><H3>
putLock</H3>
<PRE>
public void <B>putLock</B>(<A HREF="../../../com/sleepycat/db/Lock.html" title="class in com.sleepycat.db">Lock</A> lock)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Release a lock.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lock</CODE> - The lock to be released.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="createLockerID()"><!-- --></A><H3>
createLockerID</H3>
<PRE>
public int <B>createLockerID</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Allocate a locker ID.
<p>
The locker ID is guaranteed to be unique for the database environment.
<p>
Call <A HREF="../../../com/sleepycat/db/Environment.html#freeLockerID(int)"><CODE>Environment.freeLockerID</CODE></A> to return the locker ID to
the environment when it is no longer needed.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A locker ID.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="freeLockerID(int)"><!-- --></A><H3>
freeLockerID</H3>
<PRE>
public void <B>freeLockerID</B>(int id)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Free a locker ID.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The locker id to be freed.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><!-- --></A><H3>
lockVector</H3>
<PRE>
public void <B>lockVector</B>(int locker,
boolean noWait,
<A HREF="../../../com/sleepycat/db/LockRequest.html" title="class in com.sleepycat.db">LockRequest</A>[] list)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Atomically obtain and release one or more locks from the lock table.
This method is intended to support acquisition or trading of
multiple locks under one lock table semaphore, as is needed for lock
coupling or in multigranularity locking for lock escalation.
<p>
If any of the requested locks cannot be acquired, or any of the locks to
be released cannot be released, the operations before the failing
operation are guaranteed to have completed successfully, and
the method throws an exception.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>noWait</CODE> - If a lock cannot be granted because the requested lock conflicts
with an existing lock, throw a <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A>
immediately instead of waiting for the lock to become available.
The index of the request that was not granted will be returned by
<A HREF="../../../com/sleepycat/db/LockNotGrantedException.html#getIndex()"><CODE>LockNotGrantedException.getIndex</CODE></A>.
<p><DD><CODE>locker</CODE> - An unsigned 32-bit integer quantity representing the entity
requesting the lock.
<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
operations.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="openLogCursor()"><!-- --></A><H3>
openLogCursor</H3>
<PRE>
public <A HREF="../../../com/sleepycat/db/LogCursor.html" title="class in com.sleepycat.db">LogCursor</A> <B>openLogCursor</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return a log cursor.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A log cursor.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getLogFileName(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3>
getLogFileName</H3>
<PRE>
public java.lang.String <B>getLogFileName</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the name of the log file that contains the log record
specified by a LogSequenceNumber object.
<p>
This mapping of LogSequenceNumber objects to files is needed for
database administration. For example, a transaction manager
typically records the earliest LogSequenceNumber object needed for
restart, and the database administrator may want to archive log
files to tape when they contain only log records before the earliest
one needed for restart.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lsn</CODE> - The LogSequenceNumber object for which a filename is wanted.
<p>
<DT><B>Returns:</B><DD>The name of the log file that contains the log record specified by a
LogSequenceNumber object.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if an invalid parameter was specified.
<p>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3>
startReplication</H3>
<PRE>
public void <B>startReplication</B>(<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> cdata,
boolean master)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Configure the database environment as a client or master in a group
of replicated database environments. Replication master
environments are the only database environments where replicated
databases may be modified. Replication client environments are
read-only as long as they are clients. Replication client
environments may be upgraded to be replication master environments
in the case that the current master fails or there is no master
present.
<p>
The enclosing database environment must already have been configured
to send replication messages by calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationTransport(int, com.sleepycat.db.ReplicationTransport)"><CODE>EnvironmentConfig.setReplicationTransport</CODE></A>.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cdata</CODE> - An opaque data item that is sent over the communication infrastructure
when the client or master comes online. If no such information is
useful, cdata should be null.
<p><DD><CODE>master</CODE> - Configure the environment as a replication master. If false, the
environment will be configured as as a replication client.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="electReplicationMaster(int, int)"><!-- --></A><H3>
electReplicationMaster</H3>
<PRE>
public void <B>electReplicationMaster</B>(int nsites,
int nvotes)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Hold an election for the master of a replication group.
<p>
If the election is successful, the new master's ID may be the ID of the
previous master, or the ID of the current environment. The application
is responsible for adjusting its usage of the other environments in the
replication group, including directing all database updates to the newly
selected master, in accordance with the results of this election.
<p>
The thread of control that calls this method must not be the thread
of control that processes incoming messages; processing the incoming
messages is necessary to successfully complete an election.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nsites</CODE> - The number of environments that the application believes are in the
replication group. This number is used by Berkeley DB to avoid
having two masters active simultaneously, even in the case of a
network partition. During an election, a new master cannot be
elected unless more than half of nsites agree on the new master.
Thus, in the face of a network partition, the side of the partition
with more than half the environments will elect a new master and
continue, while the environments communicating with fewer than half
the other environments will fail to find a new master.
<p><DD><CODE>nvotes</CODE> - The number of votes required by the application to successfully
elect a new master. It must be a positive integer, no greater than
nsites, or 0 if the election should use a simple majority of the
nsites value as the requirement. A warning is given if half or
fewer votes are required to win an election as that can potentially
lead to multiple masters in the face of a network partition.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="flushReplication()"><!-- --></A><H3>
flushReplication</H3>
<PRE>
public void <B>flushReplication</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Internal method: re-push the last log record to all clients, in case they've
lost messages and don't know it.
<p>
This method may not be called before the database environment is opened.
<p>
<p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><!-- --></A><H3>
processReplicationMessage</H3>
<PRE>
public <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,
<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> rec,
int envid)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Process an incoming replication message sent by a member of the
replication group to the local database environment.
<p>
For implementation reasons, all incoming replication messages must
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
required that a single thread of control process all messages, only
that all threads of control processing messages use the same handle.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>control</CODE> - A copy of the control parameter specified by Berkeley DB on the
sending environment.
<p><DD><CODE>envid</CODE> - The local identifier that corresponds to the environment that sent
the message to be processed.
<p><DD><CODE>rec</CODE> - A copy of the rec parameter specified by Berkeley DB on the sending
environment.
<p>
<DT><B>Returns:</B><DD>A <A HREF="../../../com/sleepycat/db/ReplicationStatus.html" title="class in com.sleepycat.db"><CODE>ReplicationStatus</CODE></A> object.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><!-- --></A><H3>
setReplicationConfig</H3>
<PRE>
public void <B>setReplicationConfig</B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config,
boolean onoff)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Configure the replication subsystem.
<p>
The database environment's replication subsystem may also be set using the environment's
DB_CONFIG file. The syntax of the entry in that file is a single line
with the string "rep_set_config", one or more whitespace characters, and the method configuration parameter as a string; for example,
"rep_set_config REP_CONF_NOWAIT".
Because the DB_CONFIG file is read when the database environment is
opened, it will silently overrule configuration done before that time.
<p>
This method configures a database environment, including all threads
of control accessing the database environment, not only the operations
performed using a specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<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.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getReplicationConfig(com.sleepycat.db.ReplicationConfig)"><!-- --></A><H3>
getReplicationConfig</H3>
<PRE>
public boolean <B>getReplicationConfig</B>(<A HREF="../../../com/sleepycat/db/ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Get the configuration of the replication subsystem.
This method may be called at any time during the life of the application.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Whether the specified feature is enabled or disabled.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)"><!-- --></A><H3>
setReplicationTimeout</H3>
<PRE>
public void <B>setReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type,
int replicationTimeout)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Set the network timeout applied to the specified timeout type.
This method may be called at any time during the life of the application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of timeout to retrieve.
<p><DD><CODE>replicationTimeout</CODE> - The time in milliseconds of the desired timeout.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType)"><!-- --></A><H3>
getReplicationTimeout</H3>
<PRE>
public int <B>getReplicationTimeout</B>(<A HREF="../../../com/sleepycat/db/ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</A> type)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Get the network timeout applied to the specified timeout type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of timeout to retrieve.
<p>
<DT><B>Returns:</B><DD>The network timeout applied to the specified timout type.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="syncReplication()"><!-- --></A><H3>
syncReplication</H3>
<PRE>
public void <B>syncReplication</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Forces synchronization to begin for this client. This method is the other
half of setting <A HREF="../../../com/sleepycat/db/ReplicationConfig.html#DELAYCLIENT"><CODE>ReplicationConfig.DELAYCLIENT</CODE></A> with
<A HREF="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><CODE>setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</CODE></A>.
<p>
When a new master is elected and the application has configured delayed
synchronization, the application must choose when to perform
synchronization by using this method. Otherwise the client will remain
unsynchronized and will ignore all new incoming log messages.
<p>
This method may not be called before the database environment is opened.
<p>
<p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)"><!-- --></A><H3>
replicationManagerStart</H3>
<PRE>
public void <B>replicationManagerStart</B>(int nthreads,
<A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</A> policy)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Starts the replication manager.
<p>
The replication manager is implemented inside the Berkeley DB library,
it is designed to manage a replication group. This includes network
transport, all replication message processing and acknowledgment, and
group elections.
<p>
For more information on building replication manager applications,
please see the "Replication Manager Getting Started Guide" included in
the Berkeley DB documentation.
<p>
This method may not be called before the database environment is opened.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nthreads</CODE> - Specify the number of threads of control created and dedicated to
processing replication messages. In addition to these message processing
threads, the replication manager creates and manages a few of its own
threads of control.
<p><DD><CODE>policy</CODE> - The policy defines the startup characteristics of a replication group.
See <A HREF="../../../com/sleepycat/db/ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db"><CODE>ReplicationManagerStartPolicy</CODE></A> for more information.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getReplicationManagerSiteList()"><!-- --></A><H3>
getReplicationManagerSiteList</H3>
<PRE>
public <A HREF="../../../com/sleepycat/db/ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</A>[] <B>getReplicationManagerSiteList</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return an array of all sites known to the replication manager.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getCacheStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getCacheStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getCacheFileStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getCacheFileStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getLogStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getLogStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the database environment's logging statistics.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The database environment's logging statistics.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getReplicationStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getReplicationStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the database environment's replication statistics.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The database environment's replication statistics.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getReplicationManagerStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getReplicationManagerStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the database environment's replication manager statistics.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The database environment's replication manager statistics.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getLockStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getLockStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the database environment's locking statistics.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The locking statistics attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The database environment's locking statistics.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getMutexStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getMutexStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the database environment's mutex statistics.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The statistics attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The database environment's mutex statistics.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getTransactionStats(com.sleepycat.db.StatsConfig)"><!-- --></A><H3>
getTransactionStats</H3>
<PRE>
public <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)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Return the database environment's transactional statistics.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The transactional statistics attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The database environment's transactional statistics.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="beginCDSGroup()"><!-- --></A><H3>
beginCDSGroup</H3>
<PRE>
public <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> <B>beginCDSGroup</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Allocate a locker ID in an environment configured for Berkeley DB
Concurrent Data Store applications. Returns a <A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db"><CODE>Transaction</CODE></A> object
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.
<p>
See
<a href="../../../../ref/cam/intro.html" target="_top">Berkeley DB Concurrent Data Store applications</a>
for more information about when this is required.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A transaction handle that wraps a CDS locker ID.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><!-- --></A><H3>
beginTransaction</H3>
<PRE>
public <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,
<A HREF="../../../com/sleepycat/db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Create a new transaction in the database environment.
<p>
Transactions may only span threads if they do so serially; that is,
each transaction must be active in only a single thread of control
at a time.
<p>
This restriction holds for parents of nested transactions as well;
no two children may be concurrently active in more than one thread
of control at any one time.
<p>
Cursors may not span transactions; that is, each cursor must be opened
and closed within a single transaction.
<p>
A parent transaction may not issue any Berkeley DB operations --
except for <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A>,
<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> --
while it has active child transactions (child transactions that have
not yet been committed or aborted).
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>parent</CODE> - If the parent parameter is non-null, the new transaction will be a
nested transaction, with the transaction indicated by parent as its
parent. Transactions may be nested to any level. In the presence
of distributed transactions and two-phase commit, only the parental
transaction, that is a transaction without a parent specified,
should be passed as an parameter to <A HREF="../../../com/sleepycat/db/Transaction.html#prepare(byte[])"><CODE>Transaction.prepare</CODE></A>.
<p><DD><CODE>config</CODE> - The transaction attributes. If null, default attributes are used.
<p>
<DT><B>Returns:</B><DD>The newly created transaction's handle.
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="checkpoint(com.sleepycat.db.CheckpointConfig)"><!-- --></A><H3>
checkpoint</H3>
<PRE>
public void <B>checkpoint</B>(<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A> config)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Synchronously checkpoint the database environment.
<p>
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - The checkpoint attributes. If null, default attributes are used.
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="logFlush(com.sleepycat.db.LogSequenceNumber)"><!-- --></A><H3>
logFlush</H3>
<PRE>
public void <B>logFlush</B>(<A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</A> lsn)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Flush log records to stable storage.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>lsn</CODE> - All log records with LogSequenceNumber values less than or equal to
the lsn parameter are written to stable storage. If lsn is null,
all records in the log are flushed.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="logPut(com.sleepycat.db.DatabaseEntry, boolean)"><!-- --></A><H3>
logPut</H3>
<PRE>
public <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,
boolean flush)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Append a record to the log.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - The record to append to the log.
<p>
The caller is responsible for providing any necessary structure to
data. (For example, in a write-ahead logging protocol, the
application must understand what part of data is an operation code,
what part is redo information, and what part is undo information.
In addition, most transaction managers will store in data the
LogSequenceNumber of the previous log record for the same
transaction, to support chaining back through the transaction's log
records during undo.)
<p><DD><CODE>flush</CODE> - The log is forced to disk after this record is written, guaranteeing
that all records with LogSequenceNumber values less than or equal
to the one being "put" are on disk before this method returns.
<p>
<DT><B>Returns:</B><DD>The LogSequenceNumber of the put record.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="logPrint(com.sleepycat.db.Transaction, java.lang.String)"><!-- --></A><H3>
logPrint</H3>
<PRE>
public void <B>logPrint</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn,
java.lang.String message)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Append an informational message to the Berkeley DB database environment log files.
<p>
This method allows applications to include information in
the database environment log files, for later review using the
<a href="../../../../utility/db_printlog.html" target="_top">db_printlog</a>
utility. This method is intended for debugging and performance tuning.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>txn</CODE> - If the logged message refers to an application-specified transaction,
the <code>txn</code> parameter is a transaction handle, otherwise
<code>null</code>.
<p>
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="getArchiveLogFiles(boolean)"><!-- --></A><H3>
getArchiveLogFiles</H3>
<PRE>
public java.io.File[] <B>getArchiveLogFiles</B>(boolean includeInUse)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getArchiveDatabases()"><!-- --></A><H3>
getArchiveDatabases</H3>
<PRE>
public java.io.File[] <B>getArchiveDatabases</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="removeOldLogFiles()"><!-- --></A><H3>
removeOldLogFiles</H3>
<PRE>
public void <B>removeOldLogFiles</B>()
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Remove log files that are no longer needed.
<p>
Automatic log file removal is likely to make catastrophic recovery
impossible.
<p>
<p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="recover(int, boolean)"><!-- --></A><H3>
recover</H3>
<PRE>
public <A HREF="../../../com/sleepycat/db/PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</A>[] <B>recover</B>(int count,
boolean continued)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="resetFileID(java.lang.String, boolean)"><!-- --></A><H3>
resetFileID</H3>
<PRE>
public void <B>resetFileID</B>(java.lang.String filename,
boolean encrypted)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Allows database files to be copied, and then the copy used in the same
database environment as the original.
<p>
All databases contain an ID string used to identify the database in the
database environment cache. If a physical database file is copied, and
used in the same environment as another file with the same ID strings,
corruption can occur. This method creates new ID strings for all of
the databases in the physical file.
<p>
This method modifies the physical file, in-place.
Applications should not reset IDs in files that are currently in use.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<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.
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="resetLogSequenceNumber(java.lang.String, boolean)"><!-- --></A><H3>
resetLogSequenceNumber</H3>
<PRE>
public void <B>resetLogSequenceNumber</B>(java.lang.String filename,
boolean encrypted)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Allows database files to be moved from one transactional database
environment to another.
<p>
Database pages in transactional database environments contain references
to the environment's log files (that is, log sequence numbers, or LSNs).
Copying or moving a database file from one database environment to
another, and then modifying it, can result in data corruption if the
LSNs are not first cleared.
<p>
Note that LSNs should be reset before moving or copying the database
file into a new database environment, rather than moving or copying the
database file and then resetting the LSNs. Berkeley DB has consistency checks
that may be triggered if an application calls this method
on a database in a new environment when the database LSNs still reflect
the old environment.
<p>
This method modifies the physical file, in-place.
Applications should not reset LSNs in files that are currently in use.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<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.
<p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="panic(boolean)"><!-- --></A><H3>
panic</H3>
<PRE>
public void <B>panic</B>(boolean onoff)
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
<DL>
<DD>Set the panic state for the database environment.
Database environments in a panic state normally refuse all attempts to
call library functions, throwing a <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>.
<p>
This method configures a database environment, including all threads
of control accessing the database environment, not only the operations
performed using a specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>onoff</CODE> - If true, set the panic state for the database environment.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getVersionString()"><!-- --></A><H3>
getVersionString</H3>
<PRE>
public static java.lang.String <B>getVersionString</B>()</PRE>
<DL>
<DD>Return the release version information, suitable for display.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The release version information, suitable for display.</DL>
</DD>
</DL>
<HR>
<A NAME="getVersionMajor()"><!-- --></A><H3>
getVersionMajor</H3>
<PRE>
public static int <B>getVersionMajor</B>()</PRE>
<DL>
<DD>Return the release major number.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The release major number.</DL>
</DD>
</DL>
<HR>
<A NAME="getVersionMinor()"><!-- --></A><H3>
getVersionMinor</H3>
<PRE>
public static int <B>getVersionMinor</B>()</PRE>
<DL>
<DD>Return the release minor number.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The release minor number.</DL>
</DD>
</DL>
<HR>
<A NAME="getVersionPatch()"><!-- --></A><H3>
getVersionPatch</H3>
<PRE>
public static int <B>getVersionPatch</B>()</PRE>
<DL>
<DD>Return the release patch number.
<p>
This method may be called at any time during the life of the application.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The release patch number.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/Environment.html" target="_top"><B>FRAMES</B></A>
<A HREF="Environment.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
bc1980b66a68f286299491ee8724e71c
>
files
>
267
