6852 lines
270 KiB
HTML
6852 lines
270 KiB
HTML
<!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.5.0) on Thu May 15 17:17:31 EDT 2008 -->
|
|
<TITLE>
|
|
EnvironmentConfig (Oracle - Berkeley DB Java API)
|
|
</TITLE>
|
|
|
|
<META NAME="keywords" CONTENT="com.sleepycat.db.EnvironmentConfig class">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
parent.document.title="EnvironmentConfig (Oracle - Berkeley DB Java API)";
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
|
|
|
|
<!-- ========= 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="class-use/EnvironmentConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>
|
|
<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface 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/EnvironmentConfig.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="EnvironmentConfig.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <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 EnvironmentConfig</H2>
|
|
<PRE>
|
|
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
|
|
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.EnvironmentConfig</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>EnvironmentConfig</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang">Cloneable</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Specifies the attributes of an environment.
|
|
<p>
|
|
To change the default settings for a database environment, an application
|
|
creates a configuration object, customizes settings and uses it for
|
|
environment construction. The set methods of this class validate the
|
|
configuration values when the method is invoked. An
|
|
IllegalArgumentException is thrown if the value is not valid for that
|
|
attribute.
|
|
<p>
|
|
All commonly used environment attributes have convenience setter/getter
|
|
methods defined in this class. For example, to change the default
|
|
transaction timeout setting for an environment, the application should
|
|
do the following:
|
|
<p>
|
|
<blockquote><pre>
|
|
// customize an environment configuration
|
|
EnvironmentConfig envConfig = new EnvironmentConfig();
|
|
envConfig.setTxnTimeout(10000); // will throw if timeout value is invalid
|
|
// Open the environment.
|
|
Environment myEnvironment = new Environment(home, envConfig);
|
|
</pre></blockquote>
|
|
<p>
|
|
Additional parameters are described in the example.properties file found at
|
|
the top level of the distribution package. These additional parameters
|
|
will not be needed by most applications. This category of
|
|
properties can be specified for the EnvironmentConfig object through a
|
|
Properties object read by EnvironmentConfig(Properties), or
|
|
individually through EnvironmentConfig.setConfigParam().
|
|
<p>
|
|
For example, an application can change the default btree node size with:
|
|
<blockquote><pre>
|
|
envConfig.setConfigParam("je.nodeMaxEntries", "256");
|
|
</pre></blockquote>
|
|
<p>
|
|
Environment configuration follows this order of precedence:
|
|
<ol>
|
|
<li>Configuration parameters specified in <environment
|
|
home>/je.properties take first precedence.
|
|
<li>Configuration parameters set in the EnvironmentConfig object used
|
|
at Environment construction are next.
|
|
<li>Any configuration parameters not set by the application are set to
|
|
system defaults, described in the example.properties file.
|
|
</ol>
|
|
<p>
|
|
An EnvironmentConfig can be used to specify both mutable and immutable
|
|
environment properties. Immutable properties may be specified when the
|
|
first Environment handle (instance) is opened for a given physical
|
|
environment. When more handles are opened for the same environment, the
|
|
following rules apply:
|
|
<p>
|
|
<ol>
|
|
<li>Immutable properties must equal the original values specified when
|
|
constructing an Environment handle for an already open environment. When a
|
|
mismatch occurs, an exception is thrown.
|
|
<li>Mutable properties are ignored when constructing an Environment
|
|
handle for an already open environment.
|
|
</ol>
|
|
<p>
|
|
After an Environment has been constructed, its mutable properties may
|
|
be changed using
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#setConfig(com.sleepycat.db.EnvironmentConfig)"><CODE>Environment.setConfig(com.sleepycat.db.EnvironmentConfig)</CODE></A>.
|
|
<p>
|
|
<P>
|
|
|
|
<P>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_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>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static <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/EnvironmentConfig.html#DEFAULT">DEFAULT</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== 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/EnvironmentConfig.html#EnvironmentConfig()">EnvironmentConfig</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Create an EnvironmentConfig initialized with the system default settings.</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> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)">addDataDir</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dataDir)</CODE>
|
|
|
|
<BR>
|
|
Set the path of a directory to be used as the location of the access
|
|
method database files.</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/EnvironmentConfig.html#addDataDir(java.lang.String)">addDataDir</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> dataDir)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>addDataDir(java.io.File)</CODE></A></I></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/EnvironmentConfig.html#getAllowCreate()">getAllowCreate</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to create any
|
|
underlying files, as necessary.</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/EnvironmentConfig.html#getCacheCount()">getCacheCount</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the number of shared memory buffer pools, that is, the number
|
|
of cache regions.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getCacheMax()">getCacheMax</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum size of the cache.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getCacheSize()">getCacheSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the size of the shared memory buffer pool, that is, the cache.</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/EnvironmentConfig.html#getCDBLockAllDatabases()">getCDBLockAllDatabases</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the Concurrent Data Store applications are configured to
|
|
perform locking on an environment-wide basis rather than on a
|
|
per-database basis.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A>[]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getDataDirs()">getDataDirs</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the array of data directories.</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/EnvironmentConfig.html#getDirectDatabaseIO()">getDirectDatabaseIO</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment has been configured to not buffer
|
|
database files.</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/EnvironmentConfig.html#getDirectLogIO()">getDirectLogIO</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment has been configured to not buffer
|
|
log files.</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/EnvironmentConfig.html#getDsyncDatabases()">getDsyncDatabases</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment has been configured to flush database
|
|
writes to the backing disk before returning from the write system call.</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/EnvironmentConfig.html#getDsyncLog()">getDsyncLog</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment has been configured to flush log
|
|
writes to the backing disk before returning from the write system
|
|
call.</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/EnvironmentConfig.html#getEncrypted()">getEncrypted</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the database environment has been configured to perform
|
|
encryption.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getErrorHandler()">getErrorHandler</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the function to be called if an error occurs.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getErrorPrefix()">getErrorPrefix</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the prefix string that appears before error messages.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getErrorStream()">getErrorStream</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the an OutputStream for displaying error messages.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/EventHandler.html" title="interface in com.sleepycat.db">EventHandler</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getEventHandler()">getEventHandler</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the object's methods to be called when a triggered event occurs.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getFeedbackHandler()">getFeedbackHandler</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the object's methods to be called to provide feedback.</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/EnvironmentConfig.html#getInitializeCache()">getInitializeCache</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured with a shared
|
|
memory buffer pool.</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/EnvironmentConfig.html#getInitializeCDB()">getInitializeCDB</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured for the Concurrent
|
|
Data Store product.</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/EnvironmentConfig.html#getInitializeLocking()">getInitializeLocking</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured for locking.</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/EnvironmentConfig.html#getInitializeLogging()">getInitializeLogging</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured for logging.</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/EnvironmentConfig.html#getInitializeRegions()">getInitializeRegions</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment has been configured to page-fault
|
|
shared regions into memory when initially creating or joining a
|
|
database environment.</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/EnvironmentConfig.html#getInitializeReplication()">getInitializeReplication</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured for replication.</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/EnvironmentConfig.html#getJoinEnvironment()">getJoinEnvironment</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the handle is configured to join an existing environment.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> byte[][]</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getLockConflicts()">getLockConflicts</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the locking conflicts matrix.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getLockDetectMode()">getLockDetectMode</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the deadlock detector is configured to run whenever a lock
|
|
conflict occurs.</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/EnvironmentConfig.html#getLockDown()">getLockDown</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to lock shared
|
|
environment files and memory-mapped databases into memory.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getLockTimeout()">getLockTimeout</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the database environment lock timeout value, in microseconds;
|
|
a timeout of 0 means no timeout is set.</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/EnvironmentConfig.html#getLogAutoRemove()">getLogAutoRemove</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to to automatically 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> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getLogBufferSize()">getLogBufferSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the size of the in-memory log buffer, in bytes.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getLogDirectory()">getLogDirectory</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the path of a directory to be used as the location of logging files.</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/EnvironmentConfig.html#getLogFileMode()">getLogFileMode</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the absolute file mode for created log files.</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/EnvironmentConfig.html#getLogInMemory()">getLogInMemory</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to maintain transaction logs
|
|
in memory rather than on disk.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getLogRecordHandler()">getLogRecordHandler</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the handler for application-specific log records.</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/EnvironmentConfig.html#getLogRegionSize()">getLogRegionSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the size of the underlying logging subsystem region.</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/EnvironmentConfig.html#getLogZero()">getLogZero</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to zero all pages of
|
|
new log files upon their creation.</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/EnvironmentConfig.html#getMaxLockers()">getMaxLockers</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum number of lockers.</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/EnvironmentConfig.html#getMaxLockObjects()">getMaxLockObjects</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum number of locked objects.</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/EnvironmentConfig.html#getMaxLocks()">getMaxLocks</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum number of locks.</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/EnvironmentConfig.html#getMaxLogFileSize()">getMaxLogFileSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum size of a single file in the log, in bytes.</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/EnvironmentConfig.html#getMaxMutexes()">getMaxMutexes</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the total number of mutexes allocated.</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/EnvironmentConfig.html#getMaxOpenFiles()">getMaxOpenFiles</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum number of file descriptors that will be opened concurrently..</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/EnvironmentConfig.html#getMaxWrite()">getMaxWrite</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum number of sequential write operations.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMaxWriteSleep()">getMaxWriteSleep</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the microseconds to pause before scheduling further write operations.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMessageHandler()">getMessageHandler</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the function to be called with an informational message.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMessageStream()">getMessageStream</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the an OutputStream for displaying informational messages.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMMapSize()">getMMapSize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMode()">getMode</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the mode to use when creating underlying files and shared
|
|
memory segments.</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/EnvironmentConfig.html#getMultiversion()">getMultiversion</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the handle is configured to open all databases for multiversion
|
|
concurrency control.</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/EnvironmentConfig.html#getMutexAlignment()">getMutexAlignment</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the mutex alignment, in bytes.</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/EnvironmentConfig.html#getMutexIncrement()">getMutexIncrement</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the number of additional mutexes to allocate.</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/EnvironmentConfig.html#getMutexTestAndSetSpins()">getMutexTestAndSetSpins</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the test-and-set spin count.</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/EnvironmentConfig.html#getNoLocking()">getNoLocking</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to grant all requested mutual
|
|
exclusion mutexes and database locks without regard for their actual
|
|
availability.</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/EnvironmentConfig.html#getNoMMap()">getNoMMap</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to copy read-only database files
|
|
into the local cache instead of potentially mapping them into process
|
|
memory.</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/EnvironmentConfig.html#getNoPanic()">getNoPanic</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to ignore any panic state in
|
|
the database environment.</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/EnvironmentConfig.html#getOverwrite()">getOverwrite</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to overwrite files stored in
|
|
encrypted formats before deleting them.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getPanicHandler()">getPanicHandler</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the function to be called if the database environment panics.</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/EnvironmentConfig.html#getPrivate()">getPrivate</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to only be accessed
|
|
by a single process.</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/EnvironmentConfig.html#getRegister()">getRegister</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the check for process failure when the environment is opened.</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/EnvironmentConfig.html#getReplicationClockskewFast()">getReplicationClockskewFast</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the current clock skew value for the fastest clock in the group of sites.</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/EnvironmentConfig.html#getReplicationClockskewSlow()">getReplicationClockskewSlow</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the current clock skew value for the slowest clock in the group of sites.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getReplicationLimit()">getReplicationLimit</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the transmit limit in bytes for a single call to
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</CODE></A>.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getReplicationManagerAckPolicy()">getReplicationManagerAckPolicy</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the network Ack policy used by 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/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getReplicationManagerLocalSite()">getReplicationManagerLocalSite</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the address of the local (this) site in a replication group.</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/EnvironmentConfig.html#getReplicationNumSites()">getReplicationNumSites</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the total number of sites in the replication group.</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/EnvironmentConfig.html#getReplicationPriority()">getReplicationPriority</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the current environment's priority.</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/EnvironmentConfig.html#getReplicationRequestMax()">getReplicationRequestMax</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the threshold for the maximum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</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/EnvironmentConfig.html#getReplicationRequestMin()">getReplicationRequestMin</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the threshold for the minimum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../com/sleepycat/db/ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getReplicationTransport()">getReplicationTransport</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the replication callback function used to transmit data using
|
|
the replication application's communication infrastructure.</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/EnvironmentConfig.html#getRunFatalRecovery()">getRunFatalRecovery</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the handle is configured to run catastrophic recovery on
|
|
the database environment before opening it for use.</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/EnvironmentConfig.html#getRunRecovery()">getRunRecovery</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the handle is configured to run normal recovery on the
|
|
database environment before opening it for use.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getSegmentId()">getSegmentId</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the base segment ID.</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/EnvironmentConfig.html#getSystemMemory()">getSystemMemory</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to allocate memory
|
|
from system shared memory instead of from memory backed by the
|
|
filesystem.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getTemporaryDirectory()">getTemporaryDirectory</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the path of a directory to be used as the location of
|
|
temporary files.</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/EnvironmentConfig.html#getTestAndSetSpins()">getTestAndSetSpins</A></B>()</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMutexTestAndSetSpins()"><CODE>getMutexTestAndSetSpins()</CODE></A></I></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/EnvironmentConfig.html#getThreaded()">getThreaded</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the handle is configured to be <em>free-threaded</em>.</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/EnvironmentConfig.html#getTransactional()">getTransactional</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured for transactions.</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/EnvironmentConfig.html#getTxnMaxActive()">getTxnMaxActive</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the minimum number of simultaneously active transactions supported
|
|
by the database environment.</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/EnvironmentConfig.html#getTxnNoSync()">getTxnNoSync</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to not write or synchronously
|
|
flush the log on transaction commit.</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/EnvironmentConfig.html#getTxnNotDurable()">getTxnNotDurable</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to not write log records.</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/EnvironmentConfig.html#getTxnNoWait()">getTxnNoWait</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the transactions have been configured to not wait for locks by default.</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/EnvironmentConfig.html#getTxnSnapshot()">getTxnSnapshot</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the handle is configured to run all transactions at snapshot
|
|
isolation.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getTxnTimeout()">getTxnTimeout</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the database environment transaction timeout value, in
|
|
microseconds; a timeout of 0 means no timeout is set.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getTxnTimestamp()">getTxnTimestamp</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return the time to which recovery will be done, or 0 if recovery will
|
|
be done to the most current possible date.</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/EnvironmentConfig.html#getTxnWriteNoSync()">getTxnWriteNoSync</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to write, but not synchronously
|
|
flush, the log on transaction commit.</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/EnvironmentConfig.html#getUseEnvironment()">getUseEnvironment</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to accept information
|
|
from the process environment when naming files.</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/EnvironmentConfig.html#getUseEnvironmentRoot()">getUseEnvironmentRoot</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the database environment is configured to accept information
|
|
from the process environment when naming files if the process has
|
|
appropriate permissions.</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/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)">getVerbose</A></B>(<A HREF="../../../com/sleepycat/db/VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</A> flag)</CODE>
|
|
|
|
<BR>
|
|
Return if the database environment is configured to display
|
|
a given type of verbose information.</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/EnvironmentConfig.html#getVerboseDeadlock()">getVerboseDeadlock</A></B>()</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I></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/EnvironmentConfig.html#getVerboseRecovery()">getVerboseRecovery</A></B>()</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I></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/EnvironmentConfig.html#getVerboseRegister()">getVerboseRegister</A></B>()</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I></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/EnvironmentConfig.html#getVerboseReplication()">getVerboseReplication</A></B>()</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I></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/EnvironmentConfig.html#getVerboseWaitsFor()">getVerboseWaitsFor</A></B>()</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I></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/EnvironmentConfig.html#getYieldCPU()">getYieldCPU</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Return true if the system has been configured to yield the processor
|
|
immediately after each page or mutex acquisition.</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/EnvironmentConfig.html#replicationManagerAddRemoteSite(com.sleepycat.db.ReplicationHostAddress, boolean)">replicationManagerAddRemoteSite</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</A> repmgrRemoteAddr,
|
|
boolean isPeer)</CODE>
|
|
|
|
<BR>
|
|
Add a remote site to 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/EnvironmentConfig.html#setAllowCreate(boolean)">setAllowCreate</A></B>(boolean allowCreate)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to create any underlying files,
|
|
as necessary.</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/EnvironmentConfig.html#setCacheCount(int)">setCacheCount</A></B>(int cacheCount)</CODE>
|
|
|
|
<BR>
|
|
Set the number of shared memory buffer pools, that is, the number of
|
|
caches.</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/EnvironmentConfig.html#setCacheMax(long)">setCacheMax</A></B>(long cacheMax)</CODE>
|
|
|
|
<BR>
|
|
Set the maximum cache size in bytes.</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/EnvironmentConfig.html#setCacheSize(long)">setCacheSize</A></B>(long cacheSize)</CODE>
|
|
|
|
<BR>
|
|
Set the size of the shared memory buffer pool, that is, the size of the
|
|
cache.</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/EnvironmentConfig.html#setCDBLockAllDatabases(boolean)">setCDBLockAllDatabases</A></B>(boolean cdbLockAllDatabases)</CODE>
|
|
|
|
<BR>
|
|
Configure Concurrent Data Store applications to perform locking on
|
|
an environment-wide basis rather than on a per-database basis.</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/EnvironmentConfig.html#setDirectDatabaseIO(boolean)">setDirectDatabaseIO</A></B>(boolean directDatabaseIO)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to not buffer database files.</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/EnvironmentConfig.html#setDirectLogIO(boolean)">setDirectLogIO</A></B>(boolean directLogIO)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to not buffer log files.</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/EnvironmentConfig.html#setDsyncDatabases(boolean)">setDsyncDatabases</A></B>(boolean dsyncDatabases)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to flush database writes to the backing
|
|
disk before returning from the write system call, rather than flushing
|
|
database writes explicitly in a separate system call, as necessary.</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/EnvironmentConfig.html#setDsyncLog(boolean)">setDsyncLog</A></B>(boolean dsyncLog)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to flush log writes to the
|
|
backing disk before returning from the write system call, rather
|
|
than flushing log writes explicitly in a separate system call.</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/EnvironmentConfig.html#setEncrypted(java.lang.String)">setEncrypted</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password)</CODE>
|
|
|
|
<BR>
|
|
Set the password used to perform encryption and decryption.</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/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)">setErrorHandler</A></B>(<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> errorHandler)</CODE>
|
|
|
|
<BR>
|
|
Set the function to be called if an error occurs.</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/EnvironmentConfig.html#setErrorPrefix(java.lang.String)">setErrorPrefix</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> errorPrefix)</CODE>
|
|
|
|
<BR>
|
|
Set the prefix string that appears before error messages.</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/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)">setErrorStream</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> errorStream)</CODE>
|
|
|
|
<BR>
|
|
Set an OutputStream for displaying error messages.</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/EnvironmentConfig.html#setEventHandler(com.sleepycat.db.EventHandler)">setEventHandler</A></B>(<A HREF="../../../com/sleepycat/db/EventHandler.html" title="interface in com.sleepycat.db">EventHandler</A> eventHandler)</CODE>
|
|
|
|
<BR>
|
|
Set an object whose methods are to be called when a triggered event occurs.</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/EnvironmentConfig.html#setFeedbackHandler(com.sleepycat.db.FeedbackHandler)">setFeedbackHandler</A></B>(<A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> feedbackHandler)</CODE>
|
|
|
|
<BR>
|
|
Set an object whose methods are called to provide feedback.</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/EnvironmentConfig.html#setInitializeCache(boolean)">setInitializeCache</A></B>(boolean initializeCache)</CODE>
|
|
|
|
<BR>
|
|
Configure a shared memory buffer pool 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/EnvironmentConfig.html#setInitializeCDB(boolean)">setInitializeCDB</A></B>(boolean initializeCDB)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment for the Concurrent Data Store
|
|
product.</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/EnvironmentConfig.html#setInitializeLocking(boolean)">setInitializeLocking</A></B>(boolean initializeLocking)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment for locking.</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/EnvironmentConfig.html#setInitializeLogging(boolean)">setInitializeLogging</A></B>(boolean initializeLogging)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment for logging.</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/EnvironmentConfig.html#setInitializeRegions(boolean)">setInitializeRegions</A></B>(boolean initializeRegions)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to page-fault shared regions into
|
|
memory when initially creating or joining 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/EnvironmentConfig.html#setInitializeReplication(boolean)">setInitializeReplication</A></B>(boolean initializeReplication)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment for replication.</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/EnvironmentConfig.html#setJoinEnvironment(boolean)">setJoinEnvironment</A></B>(boolean joinEnvironment)</CODE>
|
|
|
|
<BR>
|
|
Configure the handle to join an existing 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/EnvironmentConfig.html#setLockConflicts(byte[][])">setLockConflicts</A></B>(byte[][] lockConflicts)</CODE>
|
|
|
|
<BR>
|
|
Configure the locking conflicts matrix.</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/EnvironmentConfig.html#setLockDetectMode(com.sleepycat.db.LockDetectMode)">setLockDetectMode</A></B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> lockDetectMode)</CODE>
|
|
|
|
<BR>
|
|
Configure if the deadlock detector is to be run whenever a lock
|
|
conflict occurs.</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/EnvironmentConfig.html#setLockDown(boolean)">setLockDown</A></B>(boolean lockDown)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to lock shared environment files
|
|
and memory-mapped databases into memory.</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/EnvironmentConfig.html#setLockTimeout(long)">setLockTimeout</A></B>(long lockTimeout)</CODE>
|
|
|
|
<BR>
|
|
Set the timeout value for the database environment
|
|
locks.</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/EnvironmentConfig.html#setLogAutoRemove(boolean)">setLogAutoRemove</A></B>(boolean logAutoRemove)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to automatically 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/EnvironmentConfig.html#setLogBufferSize(int)">setLogBufferSize</A></B>(int logBufferSize)</CODE>
|
|
|
|
<BR>
|
|
Set the size of the in-memory log buffer, in bytes.</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/EnvironmentConfig.html#setLogDirectory(java.io.File)">setLogDirectory</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> logDirectory)</CODE>
|
|
|
|
<BR>
|
|
Set the path of a directory to be used as the location of logging files.</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/EnvironmentConfig.html#setLogFileMode(int)">setLogFileMode</A></B>(int logFileMode)</CODE>
|
|
|
|
<BR>
|
|
Set the absolute file mode for created log files.</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/EnvironmentConfig.html#setLogInMemory(boolean)">setLogInMemory</A></B>(boolean logInMemory)</CODE>
|
|
|
|
<BR>
|
|
If set, maintain transaction logs in memory rather than on disk.</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/EnvironmentConfig.html#setLogRecordHandler(com.sleepycat.db.LogRecordHandler)">setLogRecordHandler</A></B>(<A HREF="../../../com/sleepycat/db/LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</A> logRecordHandler)</CODE>
|
|
|
|
<BR>
|
|
Set a function to process application-specific log records.</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/EnvironmentConfig.html#setLogRegionSize(int)">setLogRegionSize</A></B>(int logRegionSize)</CODE>
|
|
|
|
<BR>
|
|
Set the size of the underlying logging area of the database
|
|
environment, in bytes.</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/EnvironmentConfig.html#setLogZero(boolean)">setLogZero</A></B>(boolean logZero)</CODE>
|
|
|
|
<BR>
|
|
If set, zero all pages of a log file when that log file is created.</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/EnvironmentConfig.html#setMaxLockers(int)">setMaxLockers</A></B>(int maxLockers)</CODE>
|
|
|
|
<BR>
|
|
Set the maximum number of locking entities supported by 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/EnvironmentConfig.html#setMaxLockObjects(int)">setMaxLockObjects</A></B>(int maxLockObjects)</CODE>
|
|
|
|
<BR>
|
|
Set the maximum number of locked objects supported by 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/EnvironmentConfig.html#setMaxLocks(int)">setMaxLocks</A></B>(int maxLocks)</CODE>
|
|
|
|
<BR>
|
|
Set the maximum number of locks supported by 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/EnvironmentConfig.html#setMaxLogFileSize(int)">setMaxLogFileSize</A></B>(int maxLogFileSize)</CODE>
|
|
|
|
<BR>
|
|
Set the maximum size of a single file in the log, in bytes.</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/EnvironmentConfig.html#setMaxMutexes(int)">setMaxMutexes</A></B>(int maxMutexes)</CODE>
|
|
|
|
<BR>
|
|
Set the total number of mutexes to allocate.</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/EnvironmentConfig.html#setMaxOpenFiles(int)">setMaxOpenFiles</A></B>(int maxOpenFiles)</CODE>
|
|
|
|
<BR>
|
|
Limit the number of file descriptors the library will open concurrently
|
|
when flushing dirty pages from the cache.</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/EnvironmentConfig.html#setMaxWrite(int, long)">setMaxWrite</A></B>(int maxWrite,
|
|
long maxWriteSleep)</CODE>
|
|
|
|
<BR>
|
|
Limit the number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.</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/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)">setMessageHandler</A></B>(<A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> messageHandler)</CODE>
|
|
|
|
<BR>
|
|
Set a function to be called with an informational message.</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/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)">setMessageStream</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> messageStream)</CODE>
|
|
|
|
<BR>
|
|
Set an OutputStream for displaying informational messages.</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/EnvironmentConfig.html#setMMapSize(long)">setMMapSize</A></B>(long mmapSize)</CODE>
|
|
|
|
<BR>
|
|
Set the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.</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/EnvironmentConfig.html#setMode(int)">setMode</A></B>(int mode)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to use a specific mode when
|
|
creating underlying files and shared memory segments.</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/EnvironmentConfig.html#setMultiversion(boolean)">setMultiversion</A></B>(boolean multiversion)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to open all databases that are not
|
|
using the queue access method for multiversion concurrency control.</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/EnvironmentConfig.html#setMutexAlignment(int)">setMutexAlignment</A></B>(int mutexAlignment)</CODE>
|
|
|
|
<BR>
|
|
Set the mutex alignment, in bytes.</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/EnvironmentConfig.html#setMutexIncrement(int)">setMutexIncrement</A></B>(int mutexIncrement)</CODE>
|
|
|
|
<BR>
|
|
Increase the number of mutexes to allocate.</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/EnvironmentConfig.html#setMutexTestAndSetSpins(int)">setMutexTestAndSetSpins</A></B>(int mutexTestAndSetSpins)</CODE>
|
|
|
|
<BR>
|
|
Specify the number of times that test-and-set mutexes should spin
|
|
without blocking.</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/EnvironmentConfig.html#setNoLocking(boolean)">setNoLocking</A></B>(boolean noLocking)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to grant all requested mutual exclusion mutexes
|
|
and database locks without regard for their actual availability.</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/EnvironmentConfig.html#setNoMMap(boolean)">setNoMMap</A></B>(boolean noMMap)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to copy read-only database files into the local
|
|
cache instead of potentially mapping them into process memory.</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/EnvironmentConfig.html#setNoPanic(boolean)">setNoPanic</A></B>(boolean noPanic)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to ignore any panic state 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/EnvironmentConfig.html#setOverwrite(boolean)">setOverwrite</A></B>(boolean overwrite)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to overwrite files stored in encrypted formats
|
|
before deleting them.</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/EnvironmentConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)">setPanicHandler</A></B>(<A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> panicHandler)</CODE>
|
|
|
|
<BR>
|
|
Set the function to be called if the database environment panics.</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/EnvironmentConfig.html#setPrivate(boolean)">setPrivate</A></B>(boolean isPrivate)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to only be accessed by a single
|
|
process (although that process may be multithreaded).</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/EnvironmentConfig.html#setRegister(boolean)">setRegister</A></B>(boolean register)</CODE>
|
|
|
|
<BR>
|
|
Check if a process has failed while using the database environment, that
|
|
is, if a process has exited with an open <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> 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/EnvironmentConfig.html#setReplicationClockskew(int, int)">setReplicationClockskew</A></B>(int replicationClockskewFast,
|
|
int replicationClockskewSlow)</CODE>
|
|
|
|
<BR>
|
|
Sets the clock skew ratio among replication group members based on the
|
|
fastest and slowest measurements among the group for use with master leases.</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/EnvironmentConfig.html#setReplicationLimit(long)">setReplicationLimit</A></B>(long replicationLimit)</CODE>
|
|
|
|
<BR>
|
|
Impose a byte-count limit on the amount of data that will be
|
|
transmitted from a site in a single call to <A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</CODE></A>.</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/EnvironmentConfig.html#setReplicationManagerAckPolicy(com.sleepycat.db.ReplicationManagerAckPolicy)">setReplicationManagerAckPolicy</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</A> repmgrAckPolicy)</CODE>
|
|
|
|
<BR>
|
|
Set the network Ack policy used by 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/EnvironmentConfig.html#setReplicationManagerLocalSite(com.sleepycat.db.ReplicationHostAddress)">setReplicationManagerLocalSite</A></B>(<A HREF="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</A> repmgrLocalSiteAddr)</CODE>
|
|
|
|
<BR>
|
|
Set the address of the local (this) site in 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/EnvironmentConfig.html#setReplicationNumSites(int)">setReplicationNumSites</A></B>(int replicationNumSites)</CODE>
|
|
|
|
<BR>
|
|
Set the total number of sites in the 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/EnvironmentConfig.html#setReplicationPriority(int)">setReplicationPriority</A></B>(int replicationPriority)</CODE>
|
|
|
|
<BR>
|
|
Set the current environment's priority.</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/EnvironmentConfig.html#setReplicationRequestMax(int)">setReplicationRequestMax</A></B>(int replicationRequestMax)</CODE>
|
|
|
|
<BR>
|
|
Set a threshold for the maximum time that a client waits before requesting
|
|
retransmission of a missing message.</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/EnvironmentConfig.html#setReplicationRequestMin(int)">setReplicationRequestMin</A></B>(int replicationRequestMin)</CODE>
|
|
|
|
<BR>
|
|
Set a threshold for the minimum time that a client waits before requesting
|
|
retransmission of a missing message.</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/EnvironmentConfig.html#setReplicationTransport(int, com.sleepycat.db.ReplicationTransport)">setReplicationTransport</A></B>(int envid,
|
|
<A HREF="../../../com/sleepycat/db/ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</A> replicationTransport)</CODE>
|
|
|
|
<BR>
|
|
Initialize the communication infrastructure for a database environment
|
|
participating in a replicated application.</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/EnvironmentConfig.html#setRPCServer(java.lang.String, long, long)">setRPCServer</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> rpcServer,
|
|
long rpcClientTimeout,
|
|
long rpcServerTimeout)</CODE>
|
|
|
|
<BR>
|
|
Establish a connection to a RPC server for this 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/EnvironmentConfig.html#setRunFatalRecovery(boolean)">setRunFatalRecovery</A></B>(boolean runFatalRecovery)</CODE>
|
|
|
|
<BR>
|
|
Configure to run catastrophic recovery on this environment before opening it for
|
|
normal use.</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/EnvironmentConfig.html#setRunRecovery(boolean)">setRunRecovery</A></B>(boolean runRecovery)</CODE>
|
|
|
|
<BR>
|
|
Configure to run normal recovery on this environment before opening it for
|
|
normal use.</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/EnvironmentConfig.html#setSegmentId(long)">setSegmentId</A></B>(long segmentId)</CODE>
|
|
|
|
<BR>
|
|
Specify a base segment ID for database environment shared memory
|
|
regions created in system memory on VxWorks or systems supporting
|
|
X/Open-style shared memory interfaces; for example, UNIX systems
|
|
supporting <code>shmget</code> and related System V IPC interfaces.</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/EnvironmentConfig.html#setSystemMemory(boolean)">setSystemMemory</A></B>(boolean systemMemory)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to allocate memory from system
|
|
shared memory instead of from memory backed by the filesystem.</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/EnvironmentConfig.html#setTemporaryDirectory(java.io.File)">setTemporaryDirectory</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> temporaryDirectory)</CODE>
|
|
|
|
<BR>
|
|
Set the path of a directory to be used as the location of temporary
|
|
files.</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/EnvironmentConfig.html#setTemporaryDirectory(java.lang.String)">setTemporaryDirectory</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> temporaryDirectory)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setTemporaryDirectory(java.io.File)"><CODE>setTemporaryDirectory(java.io.File)</CODE></A></I></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/EnvironmentConfig.html#setTestAndSetSpins(int)">setTestAndSetSpins</A></B>(int mutexTestAndSetSpins)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMutexTestAndSetSpins(int)"><CODE>setMutexTestAndSetSpins(int)</CODE></A></I></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/EnvironmentConfig.html#setThreaded(boolean)">setThreaded</A></B>(boolean threaded)</CODE>
|
|
|
|
<BR>
|
|
Configure the handle to be <em>free-threaded</em>; that is, usable
|
|
by multiple threads within a single address space.</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/EnvironmentConfig.html#setTransactional(boolean)">setTransactional</A></B>(boolean transactional)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment for transactions.</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/EnvironmentConfig.html#setTxnMaxActive(int)">setTxnMaxActive</A></B>(int txnMaxActive)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to support at least txnMaxActive
|
|
active transactions.</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/EnvironmentConfig.html#setTxnNoSync(boolean)">setTxnNoSync</A></B>(boolean txnNoSync)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to not write or synchronously flush the log
|
|
on transaction commit.</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/EnvironmentConfig.html#setTxnNotDurable(boolean)">setTxnNotDurable</A></B>(boolean txnNotDurable)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to not write log records.</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/EnvironmentConfig.html#setTxnNoWait(boolean)">setTxnNoWait</A></B>(boolean txnNoWait)</CODE>
|
|
|
|
<BR>
|
|
If a lock is unavailable for any Berkeley DB operation performed in the
|
|
context of a transaction, cause the operation to throw <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> without waiting for the lock.</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/EnvironmentConfig.html#setTxnSnapshot(boolean)">setTxnSnapshot</A></B>(boolean txnSnapshot)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to run transactions at snapshot
|
|
isolation by default.</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/EnvironmentConfig.html#setTxnTimeout(long)">setTxnTimeout</A></B>(long txnTimeout)</CODE>
|
|
|
|
<BR>
|
|
Set the timeout value for the database environment
|
|
transactions.</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/EnvironmentConfig.html#setTxnTimestamp(java.util.Date)">setTxnTimestamp</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> txnTimestamp)</CODE>
|
|
|
|
<BR>
|
|
Recover to the specified time rather than to the most current
|
|
possible date.</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/EnvironmentConfig.html#setTxnWriteNoSync(boolean)">setTxnWriteNoSync</A></B>(boolean txnWriteNoSync)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to write, but not synchronously flush, the log on
|
|
transaction commit.</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/EnvironmentConfig.html#setUseEnvironment(boolean)">setUseEnvironment</A></B>(boolean useEnvironment)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to accept information from the
|
|
process environment when naming files, regardless of the status of
|
|
the process.</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/EnvironmentConfig.html#setUseEnvironmentRoot(boolean)">setUseEnvironmentRoot</A></B>(boolean useEnvironmentRoot)</CODE>
|
|
|
|
<BR>
|
|
Configure the database environment to accept information from the
|
|
process environment when naming files, if the process has
|
|
appropriate permissions (for example, users with a user-ID of 0 on
|
|
UNIX systems).</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/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)">setVerbose</A></B>(<A HREF="../../../com/sleepycat/db/VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</A> flag,
|
|
boolean enable)</CODE>
|
|
|
|
<BR>
|
|
Display verbose information.</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/EnvironmentConfig.html#setVerboseDeadlock(boolean)">setVerboseDeadlock</A></B>(boolean verboseDeadlock)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I></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/EnvironmentConfig.html#setVerboseRecovery(boolean)">setVerboseRecovery</A></B>(boolean verboseRecovery)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I></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/EnvironmentConfig.html#setVerboseRegister(boolean)">setVerboseRegister</A></B>(boolean verboseRegister)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I></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/EnvironmentConfig.html#setVerboseReplication(boolean)">setVerboseReplication</A></B>(boolean verboseReplication)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I></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/EnvironmentConfig.html#setVerboseWaitsFor(boolean)">setVerboseWaitsFor</A></B>(boolean verboseWaitsFor)</CODE>
|
|
|
|
<BR>
|
|
<B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I></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/EnvironmentConfig.html#setYieldCPU(boolean)">setYieldCPU</A></B>(boolean yieldCPU)</CODE>
|
|
|
|
<BR>
|
|
Configure the system to yield the processor immediately after each
|
|
page or mutex acquisition.</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.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_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>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="DEFAULT"><!-- --></A><H3>
|
|
DEFAULT</H3>
|
|
<PRE>
|
|
public static final <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</A> <B>DEFAULT</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
|
|
<!-- ========= 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="EnvironmentConfig()"><!-- --></A><H3>
|
|
EnvironmentConfig</H3>
|
|
<PRE>
|
|
public <B>EnvironmentConfig</B>()</PRE>
|
|
<DL>
|
|
<DD>Create an EnvironmentConfig initialized with the system default settings.
|
|
<P>
|
|
</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="setAllowCreate(boolean)"><!-- --></A><H3>
|
|
setAllowCreate</H3>
|
|
<PRE>
|
|
public void <B>setAllowCreate</B>(boolean allowCreate)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to create any underlying files,
|
|
as necessary.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>allowCreate</CODE> - If true, configure the database environment to create any underlying
|
|
files, as necessary.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAllowCreate()"><!-- --></A><H3>
|
|
getAllowCreate</H3>
|
|
<PRE>
|
|
public boolean <B>getAllowCreate</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to create any
|
|
underlying files, as necessary.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to create any
|
|
underlying files, as necessary.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCacheSize(long)"><!-- --></A><H3>
|
|
setCacheSize</H3>
|
|
<PRE>
|
|
public void <B>setCacheSize</B>(long cacheSize)</PRE>
|
|
<DL>
|
|
<DD>Set the size of the shared memory buffer pool, that is, the size of the
|
|
cache.
|
|
<p>
|
|
The cache should be the size of the normal working data set of the
|
|
application, with some small amount of additional memory for unusual
|
|
situations. (Note: the working set is not the same as the number of
|
|
pages accessed simultaneously, and is usually much larger.)
|
|
<p>
|
|
The default cache size is 256KB, and may not be specified as less than
|
|
20KB. Any cache size less than 500MB is automatically increased by 25%
|
|
to account for buffer pool overhead; cache sizes larger than 500MB are
|
|
used as specified. The current maximum size of a single cache is 4GB.
|
|
(All sizes are in powers-of-two, that is, 256KB is 2^18 not 256,000.)
|
|
<p>
|
|
The database environment's cache size 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 "set_cachesize", one or more whitespace characters, and the cache size specified in three parts: the gigabytes of cache, the
|
|
additional bytes of cache, and the number of caches, also separated by
|
|
whitespace characters. For example, "set_cachesize 2 524288000 3" would
|
|
create a 2.5GB logical cache, split between three physical caches.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>cacheSize</CODE> - The size of the shared memory buffer pool, that is, the size of the
|
|
cache.
|
|
<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="getCacheSize()"><!-- --></A><H3>
|
|
getCacheSize</H3>
|
|
<PRE>
|
|
public long <B>getCacheSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the size of the shared memory buffer pool, that is, the cache.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The size of the shared memory buffer pool, that is, the cache.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCacheMax(long)"><!-- --></A><H3>
|
|
setCacheMax</H3>
|
|
<PRE>
|
|
public void <B>setCacheMax</B>(long cacheMax)</PRE>
|
|
<DL>
|
|
<DD>Set the maximum cache size in bytes. The specified size is rounded to the
|
|
nearest multiple of the cache region size, which is the initial cache size
|
|
divded by the number of regions specified to <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setCacheCount(int)"><CODE>setCacheCount(int)</CODE></A>. If no
|
|
value is specified, it defaults to the initial cache size.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getCacheMax()"><!-- --></A><H3>
|
|
getCacheMax</H3>
|
|
<PRE>
|
|
public long <B>getCacheMax</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum size of the cache.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum size of the cache.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCacheCount(int)"><!-- --></A><H3>
|
|
setCacheCount</H3>
|
|
<PRE>
|
|
public void <B>setCacheCount</B>(int cacheCount)</PRE>
|
|
<DL>
|
|
<DD>Set the number of shared memory buffer pools, that is, the number of
|
|
caches.
|
|
<p>
|
|
It is possible to specify caches larger than 4GB and/or large enough
|
|
they cannot be allocated contiguously on some architectures. For
|
|
example, some releases of Solaris limit the amount of memory that may
|
|
be allocated contiguously by a process. This method allows applications
|
|
to break the cache broken up into a number of equally sized, separate
|
|
pieces of memory.
|
|
<p>
|
|
<p>
|
|
The database environment's cache size 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 "set_cachesize", one or more whitespace characters, and the cache size specified in three parts: the gigabytes of cache, the
|
|
additional bytes of cache, and the number of caches, also separated by
|
|
whitespace characters. For example, "set_cachesize 2 524288000 3" would
|
|
create a 2.5GB logical cache, split between three physical caches.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>cacheCount</CODE> - The number of shared memory buffer pools, that is, the number of caches.
|
|
<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="getCacheCount()"><!-- --></A><H3>
|
|
getCacheCount</H3>
|
|
<PRE>
|
|
public int <B>getCacheCount</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the number of shared memory buffer pools, that is, the number
|
|
of cache regions.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The number of shared memory buffer pools, that is, the number
|
|
of cache regions.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setCDBLockAllDatabases(boolean)"><!-- --></A><H3>
|
|
setCDBLockAllDatabases</H3>
|
|
<PRE>
|
|
public void <B>setCDBLockAllDatabases</B>(boolean cdbLockAllDatabases)</PRE>
|
|
<DL>
|
|
<DD>Configure Concurrent Data Store applications to perform locking on
|
|
an environment-wide basis rather than on a per-database basis.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>cdbLockAllDatabases</CODE> - If true, configure Concurrent Data Store applications to perform
|
|
locking on an environment-wide basis rather than on a per-database
|
|
basis.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getCDBLockAllDatabases()"><!-- --></A><H3>
|
|
getCDBLockAllDatabases</H3>
|
|
<PRE>
|
|
public boolean <B>getCDBLockAllDatabases</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the Concurrent Data Store applications are configured to
|
|
perform locking on an environment-wide basis rather than on a
|
|
per-database basis.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the Concurrent Data Store applications are configured to
|
|
perform locking on an environment-wide basis rather than on a
|
|
per-database basis.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addDataDir(java.io.File)"><!-- --></A><H3>
|
|
addDataDir</H3>
|
|
<PRE>
|
|
public void <B>addDataDir</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> dataDir)</PRE>
|
|
<DL>
|
|
<DD>Set the path of a directory to be used as the location of the access
|
|
method database files.
|
|
<p>
|
|
Paths specified to <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> and
|
|
<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)"><CODE>Environment.openSecondaryDatabase</CODE></A> will be searched
|
|
relative to this path. Paths set using this method are additive, and
|
|
specifying more than one will result in each specified directory
|
|
being searched for database files. If any directories are
|
|
specified, created database files will always be created in the
|
|
first path specified.
|
|
<p>
|
|
If no database directories are specified, database files must be named
|
|
either by absolute paths or relative to the environment home directory.
|
|
<p>
|
|
The database environment's data directories 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 "set_data_dir", one or more whitespace characters, and the directory name.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, the
|
|
information specified to this method must be consistent with the
|
|
existing environment or corruption can occur.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dataDir</CODE> - A directory to be used as a location for database files.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="addDataDir(java.lang.String)"><!-- --></A><H3>
|
|
addDataDir</H3>
|
|
<PRE>
|
|
public void <B>addDataDir</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> dataDir)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#addDataDir(java.io.File)"><CODE>addDataDir(java.io.File)</CODE></A></I>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDataDirs()"><!-- --></A><H3>
|
|
getDataDirs</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A>[] <B>getDataDirs</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the array of data directories.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The array of data directories.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDirectDatabaseIO(boolean)"><!-- --></A><H3>
|
|
setDirectDatabaseIO</H3>
|
|
<PRE>
|
|
public void <B>setDirectDatabaseIO</B>(boolean directDatabaseIO)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to not buffer database files.
|
|
<p>
|
|
This is intended to avoid to avoid double caching.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>directDatabaseIO</CODE> - If true, configure the database environment to not buffer database files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDirectDatabaseIO()"><!-- --></A><H3>
|
|
getDirectDatabaseIO</H3>
|
|
<PRE>
|
|
public boolean <B>getDirectDatabaseIO</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment has been configured to not buffer
|
|
database files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment has been configured to not buffer
|
|
database files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDirectLogIO(boolean)"><!-- --></A><H3>
|
|
setDirectLogIO</H3>
|
|
<PRE>
|
|
public void <B>setDirectLogIO</B>(boolean directLogIO)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to not buffer log files.
|
|
<p>
|
|
This is intended to avoid to avoid double caching.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>directLogIO</CODE> - If true, configure the database environment to not buffer log files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDirectLogIO()"><!-- --></A><H3>
|
|
getDirectLogIO</H3>
|
|
<PRE>
|
|
public boolean <B>getDirectLogIO</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment has been configured to not buffer
|
|
log files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment has been configured to not buffer
|
|
log files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDsyncDatabases(boolean)"><!-- --></A><H3>
|
|
setDsyncDatabases</H3>
|
|
<PRE>
|
|
public void <B>setDsyncDatabases</B>(boolean dsyncDatabases)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to flush database writes to the backing
|
|
disk before returning from the write system call, rather than flushing
|
|
database writes explicitly in a separate system call, as necessary.
|
|
<p>
|
|
This is only available on some systems (for example, systems supporting the
|
|
m4_posix1_name standard O_DSYNC flag, or systems supporting the Win32
|
|
FILE_FLAG_WRITE_THROUGH flag). This flag may result in inaccurate file
|
|
modification times and other file-level information for Berkeley DB database
|
|
files. This flag will almost certainly result in a performance decrease on
|
|
most systems. This flag is only applicable to certain filesysystem (for
|
|
example, the Veritas VxFS filesystem), where the filesystem's support for
|
|
trickling writes back to stable storage behaves badly (or more likely, has
|
|
been misconfigured).
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dsyncDatabases</CODE> - If true, configure the database environment to flush database writes to the
|
|
backing disk before returning from the write system call, rather than
|
|
flushing log writes explicitly in a separate system call.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDsyncDatabases()"><!-- --></A><H3>
|
|
getDsyncDatabases</H3>
|
|
<PRE>
|
|
public boolean <B>getDsyncDatabases</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment has been configured to flush database
|
|
writes to the backing disk before returning from the write system call.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment has been configured to flush database
|
|
writes to the backing disk before returning from the write system call.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setDsyncLog(boolean)"><!-- --></A><H3>
|
|
setDsyncLog</H3>
|
|
<PRE>
|
|
public void <B>setDsyncLog</B>(boolean dsyncLog)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to flush log writes to the
|
|
backing disk before returning from the write system call, rather
|
|
than flushing log writes explicitly in a separate system call.
|
|
<p>
|
|
This configuration is only available on some systems (for example,
|
|
systems supporting the POSIX standard O_DSYNC flag, or systems
|
|
supporting the Win32 FILE_FLAG_WRITE_THROUGH flag). This
|
|
configuration may result in inaccurate file modification times and
|
|
other file-level information for Berkeley DB log files. This
|
|
configuration may offer a performance increase on some systems and
|
|
a performance decrease on others.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dsyncLog</CODE> - If true, configure the database environment to flush log writes to
|
|
the backing disk before returning from the write system call, rather
|
|
than flushing log writes explicitly in a separate system call.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getDsyncLog()"><!-- --></A><H3>
|
|
getDsyncLog</H3>
|
|
<PRE>
|
|
public boolean <B>getDsyncLog</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment has been configured to flush log
|
|
writes to the backing disk before returning from the write system
|
|
call.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment has been configured to flush log
|
|
writes to the backing disk before returning from the write system
|
|
call.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setEncrypted(java.lang.String)"><!-- --></A><H3>
|
|
setEncrypted</H3>
|
|
<PRE>
|
|
public void <B>setEncrypted</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> password)</PRE>
|
|
<DL>
|
|
<DD>Set the password used to perform encryption and decryption.
|
|
<p>
|
|
Berkeley DB uses the Rijndael/AES (also known as the Advanced
|
|
Encryption Standard and Federal Information Processing
|
|
Standard (FIPS) 197) algorithm for encryption or decryption.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getEncrypted()"><!-- --></A><H3>
|
|
getEncrypted</H3>
|
|
<PRE>
|
|
public boolean <B>getEncrypted</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the database environment has been configured to perform
|
|
encryption.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The database environment has been configured to perform
|
|
encryption.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setErrorHandler(com.sleepycat.db.ErrorHandler)"><!-- --></A><H3>
|
|
setErrorHandler</H3>
|
|
<PRE>
|
|
public void <B>setErrorHandler</B>(<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> errorHandler)</PRE>
|
|
<DL>
|
|
<DD>Set the function to be called if an error occurs.
|
|
<p>
|
|
When an error occurs in the Berkeley DB library, an exception is thrown.
|
|
In some cases, however, the error information returned to the
|
|
application may be insufficient to completely describe the cause of the
|
|
error, especially during initial application debugging.
|
|
<p>
|
|
The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>DatabaseConfig.setErrorHandler</CODE></A> methods are used to enhance the mechanism for reporting
|
|
error messages to the application. In some cases, when an error occurs,
|
|
Berkeley DB will invoke the ErrorHandler's object error method. It is
|
|
up to this method to display the error message in an appropriate manner.
|
|
<p>
|
|
Alternatively, applications can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setErrorStream</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><CODE>DatabaseConfig.setErrorStream</CODE></A> to
|
|
display the additional information via an output stream. Applications
|
|
should not mix these approaches.
|
|
<p>
|
|
This error-logging enhancement does not slow performance or significantly
|
|
increase application size, and may be run during normal operation as well
|
|
as during application debugging.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>errorHandler</CODE> - The function to be called if an error occurs.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getErrorHandler()"><!-- --></A><H3>
|
|
getErrorHandler</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> <B>getErrorHandler</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the function to be called if an error occurs.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The function to be called if an error occurs.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setErrorPrefix(java.lang.String)"><!-- --></A><H3>
|
|
setErrorPrefix</H3>
|
|
<PRE>
|
|
public void <B>setErrorPrefix</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> errorPrefix)</PRE>
|
|
<DL>
|
|
<DD>Set the prefix string that appears before error messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>errorPrefix</CODE> - The prefix string that appears before error messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getErrorPrefix()"><!-- --></A><H3>
|
|
getErrorPrefix</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getErrorPrefix</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the prefix string that appears before error messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The prefix string that appears before error messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setErrorStream(java.io.OutputStream)"><!-- --></A><H3>
|
|
setErrorStream</H3>
|
|
<PRE>
|
|
public void <B>setErrorStream</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> errorStream)</PRE>
|
|
<DL>
|
|
<DD>Set an OutputStream for displaying error messages.
|
|
<p>
|
|
When an error occurs in the Berkeley DB library, an exception is thrown.
|
|
In some cases, however, the error information returned to the
|
|
application may be insufficient to completely describe the cause of the
|
|
error, especially during initial application debugging.
|
|
<p>
|
|
The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setErrorStream</CODE></A> and
|
|
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><CODE>DatabaseConfig.setErrorStream</CODE></A> methods are used to enhance
|
|
the mechanism for reporting error messages to the application by setting
|
|
a OutputStream to be used for displaying additional Berkeley DB error
|
|
messages. In some cases, when an error occurs, Berkeley DB will output
|
|
an additional error message to the specified stream.
|
|
<p>
|
|
The error message will consist of the prefix string and a colon
|
|
("<b>:</b>") (if a prefix string was previously specified using
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><CODE>EnvironmentConfig.setErrorPrefix</CODE></A> or <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)"><CODE>DatabaseConfig.setErrorPrefix</CODE></A>), an error string, and a trailing newline character.
|
|
<p>
|
|
Setting errorStream to null unconfigures the interface.
|
|
<p>
|
|
Alternatively, applications can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>DatabaseConfig.setErrorHandler</CODE></A> to capture
|
|
the additional error information in a way that does not use output
|
|
streams. Applications should not mix these approaches.
|
|
<p>
|
|
This error-logging enhancement does not slow performance or significantly
|
|
increase application size, and may be run during normal operation as well
|
|
as during application debugging.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>errorStream</CODE> - The application-specified OutputStream for error messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getErrorStream()"><!-- --></A><H3>
|
|
getErrorStream</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> <B>getErrorStream</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the an OutputStream for displaying error messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The an OutputStream for displaying error messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setEventHandler(com.sleepycat.db.EventHandler)"><!-- --></A><H3>
|
|
setEventHandler</H3>
|
|
<PRE>
|
|
public void <B>setEventHandler</B>(<A HREF="../../../com/sleepycat/db/EventHandler.html" title="interface in com.sleepycat.db">EventHandler</A> eventHandler)</PRE>
|
|
<DL>
|
|
<DD>Set an object whose methods are to be called when a triggered event occurs.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>eventHandler</CODE> - An object whose methods are called when event callbacks are initiated from
|
|
within Berkeley DB.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getEventHandler()"><!-- --></A><H3>
|
|
getEventHandler</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/EventHandler.html" title="interface in com.sleepycat.db">EventHandler</A> <B>getEventHandler</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the object's methods to be called when a triggered event occurs.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The object's methods to be called when a triggered event occurs.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setFeedbackHandler(com.sleepycat.db.FeedbackHandler)"><!-- --></A><H3>
|
|
setFeedbackHandler</H3>
|
|
<PRE>
|
|
public void <B>setFeedbackHandler</B>(<A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> feedbackHandler)</PRE>
|
|
<DL>
|
|
<DD>Set an object whose methods are called to provide feedback.
|
|
<p>
|
|
Some operations performed by the Berkeley DB library can take
|
|
non-trivial amounts of time. This method can be used by applications
|
|
to monitor progress within these operations. When an operation is
|
|
likely to take a long time, Berkeley DB will call the object's methods
|
|
with progress information.
|
|
<p>
|
|
It is up to the object's methods to display this information in an
|
|
appropriate manner.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<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>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>feedbackHandler</CODE> - An object whose methods are called to provide feedback.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getFeedbackHandler()"><!-- --></A><H3>
|
|
getFeedbackHandler</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> <B>getFeedbackHandler</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the object's methods to be called to provide feedback.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The object's methods to be called to provide feedback.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInitializeCache(boolean)"><!-- --></A><H3>
|
|
setInitializeCache</H3>
|
|
<PRE>
|
|
public void <B>setInitializeCache</B>(boolean initializeCache)</PRE>
|
|
<DL>
|
|
<DD>Configure a shared memory buffer pool in the database environment.
|
|
<p>
|
|
This subsystem should be used whenever an application is using any
|
|
Berkeley DB access method.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>initializeCache</CODE> - If true, configure a shared memory buffer pool in the database
|
|
environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInitializeCache()"><!-- --></A><H3>
|
|
getInitializeCache</H3>
|
|
<PRE>
|
|
public boolean <B>getInitializeCache</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured with a shared
|
|
memory buffer pool.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured with a shared
|
|
memory buffer pool.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInitializeCDB(boolean)"><!-- --></A><H3>
|
|
setInitializeCDB</H3>
|
|
<PRE>
|
|
public void <B>setInitializeCDB</B>(boolean initializeCDB)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment for the Concurrent Data Store
|
|
product.
|
|
<p>
|
|
In this mode, Berkeley DB provides multiple reader/single writer access.
|
|
The only other subsystem that should be specified for this handle is a
|
|
cache.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>initializeCDB</CODE> - If true, configure the database environment for the Concurrent Data
|
|
Store product.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInitializeCDB()"><!-- --></A><H3>
|
|
getInitializeCDB</H3>
|
|
<PRE>
|
|
public boolean <B>getInitializeCDB</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured for the Concurrent
|
|
Data Store product.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured for the Concurrent
|
|
Data Store product.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInitializeLocking(boolean)"><!-- --></A><H3>
|
|
setInitializeLocking</H3>
|
|
<PRE>
|
|
public void <B>setInitializeLocking</B>(boolean initializeLocking)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment for locking.
|
|
<p>
|
|
Locking should be used when multiple processes or threads are going
|
|
to be reading and writing a database, so they do not interfere with
|
|
each other. If all threads are accessing the database(s) read-only,
|
|
locking is unnecessary. When locking is configured, it is usually
|
|
necessary to run a deadlock detector, as well.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>initializeLocking</CODE> - If true, configure the database environment for locking.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInitializeLocking()"><!-- --></A><H3>
|
|
getInitializeLocking</H3>
|
|
<PRE>
|
|
public boolean <B>getInitializeLocking</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured for locking.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured for locking.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInitializeLogging(boolean)"><!-- --></A><H3>
|
|
setInitializeLogging</H3>
|
|
<PRE>
|
|
public void <B>setInitializeLogging</B>(boolean initializeLogging)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment for logging.
|
|
<p>
|
|
Logging should be used when recovery from application or system
|
|
failure is necessary. If the log region is being created and log
|
|
files are already present, the log files are reviewed; subsequent
|
|
log writes are appended to the end of the log, rather than overwriting
|
|
current log entries.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>initializeLogging</CODE> - If true, configure the database environment for logging.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInitializeLogging()"><!-- --></A><H3>
|
|
getInitializeLogging</H3>
|
|
<PRE>
|
|
public boolean <B>getInitializeLogging</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured for logging.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured for logging.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInitializeRegions(boolean)"><!-- --></A><H3>
|
|
setInitializeRegions</H3>
|
|
<PRE>
|
|
public void <B>setInitializeRegions</B>(boolean initializeRegions)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to page-fault shared regions into
|
|
memory when initially creating or joining a database environment.
|
|
<p>
|
|
In some applications, the expense of page-faulting the underlying
|
|
shared memory regions can affect performance. For example, if the
|
|
page-fault occurs while holding a lock, other lock requests can
|
|
convoy, and overall throughput may decrease. This method
|
|
configures Berkeley DB to page-fault shared regions into memory when
|
|
initially creating or joining a database environment. In addition,
|
|
Berkeley DB will write the shared regions when creating an
|
|
environment, forcing the underlying virtual memory and filesystems
|
|
to instantiate both the necessary memory and the necessary disk
|
|
space. This can also avoid out-of-disk space failures later on.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>initializeRegions</CODE> - If true, configure the database environment to page-fault shared
|
|
regions into memory when initially creating or joining a database
|
|
environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInitializeRegions()"><!-- --></A><H3>
|
|
getInitializeRegions</H3>
|
|
<PRE>
|
|
public boolean <B>getInitializeRegions</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment has been configured to page-fault
|
|
shared regions into memory when initially creating or joining a
|
|
database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment has been configured to page-fault
|
|
shared regions into memory when initially creating or joining a
|
|
database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setInitializeReplication(boolean)"><!-- --></A><H3>
|
|
setInitializeReplication</H3>
|
|
<PRE>
|
|
public void <B>setInitializeReplication</B>(boolean initializeReplication)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment for replication.
|
|
<p>
|
|
Replication requires both locking and transactions.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>initializeReplication</CODE> - If true, configure the database environment for replication.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInitializeReplication()"><!-- --></A><H3>
|
|
getInitializeReplication</H3>
|
|
<PRE>
|
|
public boolean <B>getInitializeReplication</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured for replication.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured for replication.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setJoinEnvironment(boolean)"><!-- --></A><H3>
|
|
setJoinEnvironment</H3>
|
|
<PRE>
|
|
public void <B>setJoinEnvironment</B>(boolean joinEnvironment)</PRE>
|
|
<DL>
|
|
<DD>Configure the handle to join an existing environment.
|
|
<p>
|
|
This option allows applications to join an existing environment
|
|
without knowing which subsystems the environment supports.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>joinEnvironment</CODE> - If true, configure the handle to join an existing environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJoinEnvironment()"><!-- --></A><H3>
|
|
getJoinEnvironment</H3>
|
|
<PRE>
|
|
public boolean <B>getJoinEnvironment</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the handle is configured to join an existing environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The handle is configured to join an existing environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLockConflicts(byte[][])"><!-- --></A><H3>
|
|
setLockConflicts</H3>
|
|
<PRE>
|
|
public void <B>setLockConflicts</B>(byte[][] lockConflicts)</PRE>
|
|
<DL>
|
|
<DD>Configure the locking conflicts matrix.
|
|
<p>
|
|
If the locking conflicts matrix is never configured, a standard
|
|
conflicts array is used.
|
|
<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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lockConflicts</CODE> - The locking conflicts matrix. A non-0 value for an array element
|
|
indicates the requested_mode and held_mode conflict:
|
|
<blockquote><pre>
|
|
lockConflicts[requested_mode][held_mode]
|
|
</pre></blockquote>
|
|
<p>
|
|
The <em>not-granted</em> mode must be represented by 0.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLockConflicts()"><!-- --></A><H3>
|
|
getLockConflicts</H3>
|
|
<PRE>
|
|
public byte[][] <B>getLockConflicts</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the locking conflicts matrix.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The locking conflicts matrix.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLockDetectMode(com.sleepycat.db.LockDetectMode)"><!-- --></A><H3>
|
|
setLockDetectMode</H3>
|
|
<PRE>
|
|
public void <B>setLockDetectMode</B>(<A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> lockDetectMode)</PRE>
|
|
<DL>
|
|
<DD>Configure if the deadlock detector is to be run whenever a lock
|
|
conflict occurs.
|
|
<p>
|
|
The database environment's deadlock detector configuration 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 "set_lk_detect", one or more whitespace characters, and the method <code>detect</code> parameter as a string; for example,
|
|
"set_lk_detect DB_LOCK_OLDEST".
|
|
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>
|
|
Although the method may be called at any time during the life of the
|
|
application, it should normally be called before opening the database
|
|
environment.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lockDetectMode</CODE> - The lock request(s) to be rejected. As transactions acquire locks
|
|
on behalf of a single locker ID, rejecting a lock request associated
|
|
with a transaction normally requires the transaction be aborted.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLockDetectMode()"><!-- --></A><H3>
|
|
getLockDetectMode</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</A> <B>getLockDetectMode</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the deadlock detector is configured to run whenever a lock
|
|
conflict occurs.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the deadlock detector is configured to run whenever a lock
|
|
conflict occurs.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLockDown(boolean)"><!-- --></A><H3>
|
|
setLockDown</H3>
|
|
<PRE>
|
|
public void <B>setLockDown</B>(boolean lockDown)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to lock shared environment files
|
|
and memory-mapped databases into memory.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lockDown</CODE> - If true, configure the database environment to lock shared
|
|
environment files and memory-mapped databases into memory.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLockDown()"><!-- --></A><H3>
|
|
getLockDown</H3>
|
|
<PRE>
|
|
public boolean <B>getLockDown</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to lock shared
|
|
environment files and memory-mapped databases into memory.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to lock shared
|
|
environment files and memory-mapped databases into memory.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLockTimeout(long)"><!-- --></A><H3>
|
|
setLockTimeout</H3>
|
|
<PRE>
|
|
public void <B>setLockTimeout</B>(long lockTimeout)</PRE>
|
|
<DL>
|
|
<DD>Set the timeout value for the database environment
|
|
locks.
|
|
<p>
|
|
Lock timeouts are checked whenever a thread of control blocks on a lock
|
|
or when deadlock detection is performed. The lock may have been
|
|
requested explicitly through the Lock subsystem interfaces, or it may
|
|
be a lock requested by the database access methods underlying the
|
|
application.
|
|
As timeouts are only checked when the lock request first blocks or when
|
|
deadlock detection is performed, the accuracy of the timeout depends on
|
|
how often deadlock detection is performed.
|
|
<p>
|
|
Timeout values specified for the database environment may be overridden
|
|
on a
|
|
per-lock basis by <A HREF="../../../com/sleepycat/db/Environment.html#lockVector(int, boolean, com.sleepycat.db.LockRequest[])"><CODE>Environment.lockVector</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>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>lockTimeout</CODE> - The timeout value, specified as an unsigned 32-bit number of
|
|
microseconds, limiting the maximum timeout to roughly 71 minutes.
|
|
<p>
|
|
<p>
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
|
|
<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="getLockTimeout()"><!-- --></A><H3>
|
|
getLockTimeout</H3>
|
|
<PRE>
|
|
public long <B>getLockTimeout</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the database environment lock timeout value, in microseconds;
|
|
a timeout of 0 means no timeout is set.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The database environment lock timeout value, in microseconds;
|
|
a timeout of 0 means no timeout is set.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogAutoRemove(boolean)"><!-- --></A><H3>
|
|
setLogAutoRemove</H3>
|
|
<PRE>
|
|
public void <B>setLogAutoRemove</B>(boolean logAutoRemove)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to automatically remove log files that are no
|
|
longer needed.
|
|
<p>
|
|
Automatic log file removal is likely to make catastrophic recovery
|
|
impossible.
|
|
<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>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logAutoRemove</CODE> - If true, configure the system to automatically remove log files that
|
|
are no longer needed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogAutoRemove()"><!-- --></A><H3>
|
|
getLogAutoRemove</H3>
|
|
<PRE>
|
|
public boolean <B>getLogAutoRemove</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to to automatically remove log
|
|
files that are no longer needed.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to to automatically remove log
|
|
files that are no longer needed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogInMemory(boolean)"><!-- --></A><H3>
|
|
setLogInMemory</H3>
|
|
<PRE>
|
|
public void <B>setLogInMemory</B>(boolean logInMemory)</PRE>
|
|
<DL>
|
|
<DD>If set, maintain transaction logs in memory rather than on disk. This means
|
|
that transactions exhibit the ACI (atomicity, consistency, and isolation)
|
|
properties, but not D (durability); that is, database integrity will be
|
|
maintained, but if the application or system fails, integrity will not
|
|
persist. All database files must be verified and/or restored from a
|
|
replication group master or archival backup after application or system
|
|
failure.
|
|
<p>
|
|
When in-memory logs are configured and no more log buffer space is
|
|
available, Berkeley DB methods will throw a <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A>.
|
|
When choosing log buffer and file sizes for in-memory logs, applications
|
|
should ensure the in-memory log buffer size is large enough that no
|
|
transaction will ever span the entire buffer, and avoid a state where the
|
|
in-memory buffer is full and no space can be freed because a transaction
|
|
that started in the first log "file" is still active.
|
|
<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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logInMemory</CODE> - If true, maintain transaction logs in memory rather than on disk.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogInMemory()"><!-- --></A><H3>
|
|
getLogInMemory</H3>
|
|
<PRE>
|
|
public boolean <B>getLogInMemory</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to maintain transaction logs
|
|
in memory rather than on disk.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to maintain transaction logs
|
|
in memory rather than on disk.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogRecordHandler(com.sleepycat.db.LogRecordHandler)"><!-- --></A><H3>
|
|
setLogRecordHandler</H3>
|
|
<PRE>
|
|
public void <B>setLogRecordHandler</B>(<A HREF="../../../com/sleepycat/db/LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</A> logRecordHandler)</PRE>
|
|
<DL>
|
|
<DD>Set a function to process application-specific log records.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, the
|
|
information specified to this method must be consistent with the
|
|
existing environment or corruption can occur.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logRecordHandler</CODE> - The handler for application-specific log records.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogRecordHandler()"><!-- --></A><H3>
|
|
getLogRecordHandler</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</A> <B>getLogRecordHandler</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the handler for application-specific log records.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The handler for application-specific log records.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogZero(boolean)"><!-- --></A><H3>
|
|
setLogZero</H3>
|
|
<PRE>
|
|
public void <B>setLogZero</B>(boolean logZero)</PRE>
|
|
<DL>
|
|
<DD>If set, zero all pages of a log file when that log file is created. This
|
|
has been shown to provide greater transaction throughput in some
|
|
environments. The log file will be zeroed by the thread which needs to
|
|
re-create the new log file. Other threads may not write to the log file
|
|
while this is happening.
|
|
<p>
|
|
This method configures the database environment, including all threads of
|
|
control accessing the database environment.
|
|
<p>
|
|
This method may not be called after the environment has been opened.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logZero</CODE> - If true, zero all pages of new log files upon their creation.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogZero()"><!-- --></A><H3>
|
|
getLogZero</H3>
|
|
<PRE>
|
|
public boolean <B>getLogZero</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to zero all pages of
|
|
new log files upon their creation.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to pre-zero log pages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationManagerAckPolicy(com.sleepycat.db.ReplicationManagerAckPolicy)"><!-- --></A><H3>
|
|
setReplicationManagerAckPolicy</H3>
|
|
<PRE>
|
|
public void <B>setReplicationManagerAckPolicy</B>(<A HREF="../../../com/sleepycat/db/ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</A> repmgrAckPolicy)</PRE>
|
|
<DL>
|
|
<DD>Set the network Ack policy used by the replication manager.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>repmgrAckPolicy</CODE> - The network Ack policy used by the replication manager.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationManagerAckPolicy()"><!-- --></A><H3>
|
|
getReplicationManagerAckPolicy</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</A> <B>getReplicationManagerAckPolicy</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the network Ack policy used by the replication manager.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The network Ack policy used by the replication manager.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationManagerLocalSite(com.sleepycat.db.ReplicationHostAddress)"><!-- --></A><H3>
|
|
setReplicationManagerLocalSite</H3>
|
|
<PRE>
|
|
public void <B>setReplicationManagerLocalSite</B>(<A HREF="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</A> repmgrLocalSiteAddr)</PRE>
|
|
<DL>
|
|
<DD>Set the address of the local (this) site in a replication group.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>repmgrLocalSiteAddr</CODE> - The address of the local site.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationManagerLocalSite()"><!-- --></A><H3>
|
|
getReplicationManagerLocalSite</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</A> <B>getReplicationManagerLocalSite</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the address of the local (this) site in a replication group.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The address of the local site.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="replicationManagerAddRemoteSite(com.sleepycat.db.ReplicationHostAddress, boolean)"><!-- --></A><H3>
|
|
replicationManagerAddRemoteSite</H3>
|
|
<PRE>
|
|
public void <B>replicationManagerAddRemoteSite</B>(<A HREF="../../../com/sleepycat/db/ReplicationHostAddress.html" title="class in com.sleepycat.db">ReplicationHostAddress</A> repmgrRemoteAddr,
|
|
boolean isPeer)
|
|
throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE>
|
|
<DL>
|
|
<DD>Add a remote site to a replication group.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>repmgrRemoteAddr</CODE> - The address of the remote site<DD><CODE>isPeer</CODE> - Whether the remote site is the local site's peer.
|
|
<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="setMaxLocks(int)"><!-- --></A><H3>
|
|
setMaxLocks</H3>
|
|
<PRE>
|
|
public void <B>setMaxLocks</B>(int maxLocks)</PRE>
|
|
<DL>
|
|
<DD>Set the maximum number of locks supported by the database
|
|
environment.
|
|
<p>
|
|
This value is used during environment creation to estimate how much
|
|
space to allocate for various lock-table data structures. The
|
|
default value is 1000 locks.
|
|
<p>
|
|
The database environment's maximum number of locks 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 "set_lk_max_locks", one or more whitespace characters, and the number of locks.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxLocks</CODE> - The maximum number of locks supported by the database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxLocks()"><!-- --></A><H3>
|
|
getMaxLocks</H3>
|
|
<PRE>
|
|
public int <B>getMaxLocks</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum number of locks.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum number of locks.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMaxLockers(int)"><!-- --></A><H3>
|
|
setMaxLockers</H3>
|
|
<PRE>
|
|
public void <B>setMaxLockers</B>(int maxLockers)</PRE>
|
|
<DL>
|
|
<DD>Set the maximum number of locking entities supported by the database
|
|
environment.
|
|
<p>
|
|
This value is used during environment creation to estimate how much
|
|
space to allocate for various lock-table data structures. The default
|
|
value is 1000 lockers.
|
|
<p>
|
|
The database environment's maximum number of lockers 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 "set_lk_max_lockers", one or more whitespace characters, and the number of lockers.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxLockers</CODE> - The maximum number simultaneous locking entities supported by the
|
|
database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxLockers()"><!-- --></A><H3>
|
|
getMaxLockers</H3>
|
|
<PRE>
|
|
public int <B>getMaxLockers</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum number of lockers.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum number of lockers.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMaxLockObjects(int)"><!-- --></A><H3>
|
|
setMaxLockObjects</H3>
|
|
<PRE>
|
|
public void <B>setMaxLockObjects</B>(int maxLockObjects)</PRE>
|
|
<DL>
|
|
<DD>Set the maximum number of locked objects supported by the database
|
|
environment.
|
|
<p>
|
|
This value is used during environment creation to estimate how much
|
|
space to allocate for various lock-table data structures. The default
|
|
value is 1000 objects.
|
|
<p>
|
|
The database environment's maximum number of objects 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 "set_lk_max_objects", one or more whitespace characters, and the number of objects.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxLockObjects</CODE> - The maximum number of locked objects supported by the database
|
|
environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxLockObjects()"><!-- --></A><H3>
|
|
getMaxLockObjects</H3>
|
|
<PRE>
|
|
public int <B>getMaxLockObjects</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum number of locked objects.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum number of locked objects.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMaxLogFileSize(int)"><!-- --></A><H3>
|
|
setMaxLogFileSize</H3>
|
|
<PRE>
|
|
public void <B>setMaxLogFileSize</B>(int maxLogFileSize)</PRE>
|
|
<DL>
|
|
<DD>Set the maximum size of a single file in the log, in bytes.
|
|
<p>
|
|
By default, or if the maxLogFileSize parameter is set to 0, a size
|
|
of 10MB is used. If no size is specified by the application, the
|
|
size last specified for the database region will be used, or if no
|
|
database region previously existed, the default will be used.
|
|
Because <A HREF="../../../com/sleepycat/db/LogSequenceNumber.html" title="class in com.sleepycat.db"><CODE>LogSequenceNumber</CODE></A> file offsets are unsigned four-byte
|
|
values, the set value may not be larger than the maximum unsigned
|
|
four-byte value.
|
|
<p>
|
|
The database environment's log file size 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 "set_lg_max", one or more whitespace characters, and the size in bytes.
|
|
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>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxLogFileSize</CODE> - The maximum size of a single file in the log, in bytes.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxLogFileSize()"><!-- --></A><H3>
|
|
getMaxLogFileSize</H3>
|
|
<PRE>
|
|
public int <B>getMaxLogFileSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum size of a single file in the log, in bytes.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum size of a single file in the log, in bytes.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogBufferSize(int)"><!-- --></A><H3>
|
|
setLogBufferSize</H3>
|
|
<PRE>
|
|
public void <B>setLogBufferSize</B>(int logBufferSize)</PRE>
|
|
<DL>
|
|
<DD>Set the size of the in-memory log buffer, in bytes.
|
|
<p>
|
|
Log information is stored in-memory until the storage space fills up
|
|
or transaction commit forces the information to be flushed to stable
|
|
storage. In the presence of long-running transactions or transactions
|
|
producing large amounts of data, larger buffer sizes can increase
|
|
throughput.
|
|
<p>
|
|
By default, or if the value is set to 0, a size of 32K is used.
|
|
<p>
|
|
The database environment's log buffer size 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 "set_lg_bsize", one or more whitespace characters, and the size in bytes.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logBufferSize</CODE> - The size of the in-memory log buffer, in bytes.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogBufferSize()"><!-- --></A><H3>
|
|
getLogBufferSize</H3>
|
|
<PRE>
|
|
public int <B>getLogBufferSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the size of the in-memory log buffer, in bytes.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The size of the in-memory log buffer, in bytes.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogDirectory(java.io.File)"><!-- --></A><H3>
|
|
setLogDirectory</H3>
|
|
<PRE>
|
|
public void <B>setLogDirectory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> logDirectory)</PRE>
|
|
<DL>
|
|
<DD>Set the path of a directory to be used as the location of logging files.
|
|
<p>
|
|
Log files created by the Log Manager subsystem will be created in this
|
|
directory. If no logging directory is specified, log files are
|
|
created in the environment home directory.
|
|
<p>
|
|
For the greatest degree of recoverability from system or application
|
|
failure, database files and log files should be located on separate
|
|
physical devices.
|
|
<p>
|
|
The database environment's logging directory 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 "set_lg_dir", one or more whitespace characters, and the directory name.
|
|
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 only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, the
|
|
information specified to this method must be consistent with the
|
|
existing environment or corruption can occur.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logDirectory</CODE> - The directory used to store the logging files.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogDirectory()"><!-- --></A><H3>
|
|
getLogDirectory</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> <B>getLogDirectory</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the path of a directory to be used as the location of logging files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The path of a directory to be used as the location of logging files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogFileMode(int)"><!-- --></A><H3>
|
|
setLogFileMode</H3>
|
|
<PRE>
|
|
public void <B>setLogFileMode</B>(int logFileMode)</PRE>
|
|
<DL>
|
|
<DD>Set the absolute file mode for created log files. This method is
|
|
<b>only</b> useful for the rare Berkeley DB application that does not
|
|
control its umask value.
|
|
<p>
|
|
Normally, if Berkeley DB applications set their umask appropriately, all
|
|
processes in the application suite will have read permission on the log
|
|
files created by any process in the application suite. However, if the
|
|
Berkeley DB application is a library, a process using the library might set
|
|
its umask to a value preventing other processes in the application suite
|
|
from reading the log files it creates. In this rare case, this method
|
|
can be used to set the mode of created log files to an absolute value.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logFileMode</CODE> - The absolute mode of the created log file.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogFileMode()"><!-- --></A><H3>
|
|
getLogFileMode</H3>
|
|
<PRE>
|
|
public int <B>getLogFileMode</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the absolute file mode for created log files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The absolute file mode for created log files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setLogRegionSize(int)"><!-- --></A><H3>
|
|
setLogRegionSize</H3>
|
|
<PRE>
|
|
public void <B>setLogRegionSize</B>(int logRegionSize)</PRE>
|
|
<DL>
|
|
<DD>Set the size of the underlying logging area of the database
|
|
environment, in bytes.
|
|
<p>
|
|
By default, or if the value is set to 0, the default size is 60KB.
|
|
The log region is used to store filenames, and so may need to be
|
|
increased in size if a large number of files will be opened and
|
|
registered with the specified database environment's log manager.
|
|
<p>
|
|
The database environment's log region size 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 "set_lg_regionmax", one or more whitespace characters, and the size in bytes.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>logRegionSize</CODE> - The size of the logging area in the database environment, in bytes.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogRegionSize()"><!-- --></A><H3>
|
|
getLogRegionSize</H3>
|
|
<PRE>
|
|
public int <B>getLogRegionSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the size of the underlying logging subsystem region.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The size of the underlying logging subsystem region.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMaxOpenFiles(int)"><!-- --></A><H3>
|
|
setMaxOpenFiles</H3>
|
|
<PRE>
|
|
public void <B>setMaxOpenFiles</B>(int maxOpenFiles)</PRE>
|
|
<DL>
|
|
<DD>Limit the number of file descriptors the library will open concurrently
|
|
when flushing dirty pages from the cache.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxOpenFiles</CODE> - The maximum number of file descriptors that may be concurrently opened
|
|
by the library when flushing dirty pages from the cache.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxOpenFiles()"><!-- --></A><H3>
|
|
getMaxOpenFiles</H3>
|
|
<PRE>
|
|
public int <B>getMaxOpenFiles</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum number of file descriptors that will be opened concurrently..
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum number of file descriptors that will be opened concurrently..</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMaxWrite(int, long)"><!-- --></A><H3>
|
|
setMaxWrite</H3>
|
|
<PRE>
|
|
public void <B>setMaxWrite</B>(int maxWrite,
|
|
long maxWriteSleep)</PRE>
|
|
<DL>
|
|
<DD>Limit the number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxWrite</CODE> - The maximum number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.<DD><CODE>maxWriteSleep</CODE> - The number of microseconds the thread of control should pause before
|
|
scheduling further write operations.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxWrite()"><!-- --></A><H3>
|
|
getMaxWrite</H3>
|
|
<PRE>
|
|
public int <B>getMaxWrite</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum number of sequential write operations.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum number of sequential write operations.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxWriteSleep()"><!-- --></A><H3>
|
|
getMaxWriteSleep</H3>
|
|
<PRE>
|
|
public long <B>getMaxWriteSleep</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the microseconds to pause before scheduling further write operations.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The microseconds to pause before scheduling further write operations.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMessageHandler(com.sleepycat.db.MessageHandler)"><!-- --></A><H3>
|
|
setMessageHandler</H3>
|
|
<PRE>
|
|
public void <B>setMessageHandler</B>(<A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> messageHandler)</PRE>
|
|
<DL>
|
|
<DD>Set a function to be called with an informational message.
|
|
<p>
|
|
There are interfaces in the Berkeley DB library which either directly
|
|
output informational messages or statistical information, or configure
|
|
the library to output such messages when performing other operations,
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><CODE>EnvironmentConfig.setVerboseDeadlock</CODE></A> for example.
|
|
<p>
|
|
The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A> and
|
|
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>DatabaseConfig.setMessageHandler</CODE></A> methods are used to display
|
|
these messages for the application.
|
|
<p>
|
|
Setting messageHandler to null unconfigures the interface.
|
|
<p>
|
|
Alternatively, you can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A>
|
|
and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><CODE>DatabaseConfig.setMessageStream</CODE></A> to send the additional
|
|
information directly to an output streams. You should not mix these
|
|
approaches.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>messageHandler</CODE> - The application-specified function for informational messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMessageHandler()"><!-- --></A><H3>
|
|
getMessageHandler</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> <B>getMessageHandler</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the function to be called with an informational message.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The function to be called with an informational message.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMessageStream(java.io.OutputStream)"><!-- --></A><H3>
|
|
setMessageStream</H3>
|
|
<PRE>
|
|
public void <B>setMessageStream</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> messageStream)</PRE>
|
|
<DL>
|
|
<DD>Set an OutputStream for displaying informational messages.
|
|
<p>
|
|
There are interfaces in the Berkeley DB library which either directly
|
|
output informational messages or statistical information, or configure
|
|
the library to output such messages when performing other operations,
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><CODE>EnvironmentConfig.setVerboseDeadlock</CODE></A> for example.
|
|
<p>
|
|
The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A> and
|
|
<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><CODE>DatabaseConfig.setMessageStream</CODE></A> methods are used to display
|
|
these messages for the application. In this case, the message will
|
|
include a trailing newline character.
|
|
<p>
|
|
Setting messageStream to null unconfigures the interface.
|
|
<p>
|
|
Alternatively, you can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A>
|
|
and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>DatabaseConfig.setMessageHandler</CODE></A> to capture the additional
|
|
information in a way that does not use output streams. You should not
|
|
mix these approaches.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>messageStream</CODE> - The application-specified OutputStream for informational messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMessageStream()"><!-- --></A><H3>
|
|
getMessageStream</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/OutputStream.html" title="class or interface in java.io">OutputStream</A> <B>getMessageStream</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the an OutputStream for displaying informational messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The an OutputStream for displaying informational messages.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMMapSize(long)"><!-- --></A><H3>
|
|
setMMapSize</H3>
|
|
<PRE>
|
|
public void <B>setMMapSize</B>(long mmapSize)</PRE>
|
|
<DL>
|
|
<DD>Set the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.
|
|
<p>
|
|
If no value is specified, it defaults to 10MB.
|
|
<p>
|
|
Files that are opened read-only in the pool (and that satisfy a few
|
|
other criteria) are, by default, mapped into the process address space
|
|
instead of being copied into the local cache. This can result in
|
|
better-than-usual performance because available virtual memory is
|
|
normally much larger than the local cache, and page faults are faster
|
|
than page copying on many systems. However, it can cause resource
|
|
starvation in the presence of limited virtual memory, and it can result
|
|
in immense process sizes in the presence of large databases.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>mmapSize</CODE> - The maximum file size, in bytes, for a file to be mapped into the
|
|
process address space.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMMapSize()"><!-- --></A><H3>
|
|
getMMapSize</H3>
|
|
<PRE>
|
|
public long <B>getMMapSize</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The maximum file size, in bytes, for a file to be mapped into the
|
|
process address space.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMode(int)"><!-- --></A><H3>
|
|
setMode</H3>
|
|
<PRE>
|
|
public void <B>setMode</B>(int mode)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to use a specific mode when
|
|
creating underlying files and shared memory segments.
|
|
<p>
|
|
On UNIX systems or in POSIX environments, files created in the
|
|
database environment are created with the specified mode (as
|
|
modified by the process' umask value at the time of creation).
|
|
<p>
|
|
On UNIX systems or in POSIX environments, system shared memory
|
|
segments created by the library are created with the specified
|
|
mode, unmodified by the process' umask value.
|
|
<p>
|
|
If is 0, the library will use a default mode of readable and
|
|
writable by both owner and group.
|
|
<p>
|
|
Created files are owned by the process owner; the group ownership
|
|
of created files is based on the system and directory defaults,
|
|
and is not further specified by the library.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>mode</CODE> - The mode to use when creating underlying files and shared memory
|
|
segments.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMode()"><!-- --></A><H3>
|
|
getMode</H3>
|
|
<PRE>
|
|
public long <B>getMode</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the mode to use when creating underlying files and shared
|
|
memory segments.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The mode to use when creating underlying files and shared
|
|
memory segments.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMultiversion(boolean)"><!-- --></A><H3>
|
|
setMultiversion</H3>
|
|
<PRE>
|
|
public void <B>setMultiversion</B>(boolean multiversion)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to open all databases that are not
|
|
using the queue access method for multiversion concurrency control.
|
|
See <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMultiversion(boolean)"><CODE>DatabaseConfig.setMultiversion(boolean)</CODE></A> for more information.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>multiversion</CODE> - If true, all databases that are not using the queue access method will be
|
|
opened for multiversion concurrency control.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMultiversion()"><!-- --></A><H3>
|
|
getMultiversion</H3>
|
|
<PRE>
|
|
public boolean <B>getMultiversion</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the handle is configured to open all databases for multiversion
|
|
concurrency control.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the handle is configured to open all databases for multiversion
|
|
concurrency control.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setNoLocking(boolean)"><!-- --></A><H3>
|
|
setNoLocking</H3>
|
|
<PRE>
|
|
public void <B>setNoLocking</B>(boolean noLocking)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to grant all requested mutual exclusion mutexes
|
|
and database locks without regard for their actual availability.
|
|
<p>
|
|
This functionality should never be used for purposes other than
|
|
debugging.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>noLocking</CODE> - If true, configure the system to grant all requested mutual exclusion
|
|
mutexes and database locks without regard for their actual availability.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNoLocking()"><!-- --></A><H3>
|
|
getNoLocking</H3>
|
|
<PRE>
|
|
public boolean <B>getNoLocking</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to grant all requested mutual
|
|
exclusion mutexes and database locks without regard for their actual
|
|
availability.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to grant all requested mutual
|
|
exclusion mutexes and database locks without regard for their actual
|
|
availability.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setNoMMap(boolean)"><!-- --></A><H3>
|
|
setNoMMap</H3>
|
|
<PRE>
|
|
public void <B>setNoMMap</B>(boolean noMMap)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to copy read-only database files into the local
|
|
cache instead of potentially mapping them into process memory.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>noMMap</CODE> - If true, configure the system to copy read-only database files into
|
|
the local cache instead of potentially mapping them into process memory.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNoMMap()"><!-- --></A><H3>
|
|
getNoMMap</H3>
|
|
<PRE>
|
|
public boolean <B>getNoMMap</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to copy read-only database files
|
|
into the local cache instead of potentially mapping them into process
|
|
memory.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to copy read-only database files
|
|
into the local cache instead of potentially mapping them into process
|
|
memory.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setNoPanic(boolean)"><!-- --></A><H3>
|
|
setNoPanic</H3>
|
|
<PRE>
|
|
public void <B>setNoPanic</B>(boolean noPanic)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to ignore any panic state in the database
|
|
environment.
|
|
<p>
|
|
Database environments in a panic state normally refuse all attempts to
|
|
call Berkeley DB functions, throwing <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>.
|
|
This functionality should never be used for purposes other than
|
|
debugging.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>noPanic</CODE> - If true, configure the system to ignore any panic state in the
|
|
database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNoPanic()"><!-- --></A><H3>
|
|
getNoPanic</H3>
|
|
<PRE>
|
|
public boolean <B>getNoPanic</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to ignore any panic state in
|
|
the database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to ignore any panic state in
|
|
the database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setOverwrite(boolean)"><!-- --></A><H3>
|
|
setOverwrite</H3>
|
|
<PRE>
|
|
public void <B>setOverwrite</B>(boolean overwrite)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to overwrite files stored in encrypted formats
|
|
before deleting them.
|
|
<p>
|
|
Berkeley DB overwrites files using alternating 0xff, 0x00 and 0xff
|
|
byte patterns. For file overwriting to be effective, the underlying
|
|
file must be stored on a fixed-block filesystem. Systems with
|
|
journaling or logging filesystems will require operating system
|
|
support and probably modification of the Berkeley DB sources.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>overwrite</CODE> - If true, configure the system to overwrite files stored in encrypted
|
|
formats before deleting them.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getOverwrite()"><!-- --></A><H3>
|
|
getOverwrite</H3>
|
|
<PRE>
|
|
public boolean <B>getOverwrite</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to overwrite files stored in
|
|
encrypted formats before deleting them.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to overwrite files stored in
|
|
encrypted formats before deleting them.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPanicHandler(com.sleepycat.db.PanicHandler)"><!-- --></A><H3>
|
|
setPanicHandler</H3>
|
|
<PRE>
|
|
public void <B>setPanicHandler</B>(<A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> panicHandler)</PRE>
|
|
<DL>
|
|
<DD>Set the function to be called if the database environment panics.
|
|
<p>
|
|
Errors can occur in the Berkeley DB library where the only solution is
|
|
to shut down the application and run recovery (for example, if Berkeley
|
|
DB is unable to allocate heap memory). In such cases, the Berkeley DB
|
|
methods will throw a <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>. It is often easier
|
|
to simply exit the application when such errors occur rather than
|
|
gracefully return up the stack. This method specifies a function to be
|
|
called when <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A> is about to be thrown from a
|
|
Berkeley DB method.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>panicHandler</CODE> - The function to be called if the database environment panics.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPanicHandler()"><!-- --></A><H3>
|
|
getPanicHandler</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> <B>getPanicHandler</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the function to be called if the database environment panics.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The function to be called if the database environment panics.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPrivate(boolean)"><!-- --></A><H3>
|
|
setPrivate</H3>
|
|
<PRE>
|
|
public void <B>setPrivate</B>(boolean isPrivate)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to only be accessed by a single
|
|
process (although that process may be multithreaded).
|
|
<p>
|
|
This has two effects on the database environment. First, all
|
|
underlying data structures are allocated from per-process memory
|
|
instead of from shared memory that is potentially accessible to more
|
|
than a single process. Second, mutexes are only configured to work
|
|
between threads.
|
|
<p>
|
|
This flag should not be specified if more than a single process is
|
|
accessing the environment because it is likely to cause database
|
|
corruption and unpredictable behavior. For example, if both a
|
|
server application and the a Berkeley DB utility are expected to
|
|
access the environment, the database environment should not be
|
|
configured as private.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>isPrivate</CODE> - If true, configure the database environment to only be accessed by
|
|
a single process.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPrivate()"><!-- --></A><H3>
|
|
getPrivate</H3>
|
|
<PRE>
|
|
public boolean <B>getPrivate</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to only be accessed
|
|
by a single process.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to only be accessed
|
|
by a single process.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationClockskew(int, int)"><!-- --></A><H3>
|
|
setReplicationClockskew</H3>
|
|
<PRE>
|
|
public void <B>setReplicationClockskew</B>(int replicationClockskewFast,
|
|
int replicationClockskewSlow)</PRE>
|
|
<DL>
|
|
<DD>Sets the clock skew ratio among replication group members based on the
|
|
fastest and slowest measurements among the group for use with master leases.
|
|
Calling this method is optional, the default values for clock skew assume no
|
|
skew. The user must also configure leases via the
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)"><CODE>Environment.setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</CODE></A> method. Additionally, the user must
|
|
also set the master lease timeout via the
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)"><CODE>Environment.setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)</CODE></A> method and the number of sites in
|
|
the replication group via the (@link #setReplicationNumSites} method. These
|
|
methods may be called in any order. For a description of the clock skew
|
|
values, see <a href="../../../../ref/rep/clock_skew.html">Clock skew</a>.
|
|
For a description of master leases, see
|
|
<a href="../../../../ref/rep/lease.html">Master leases</a>.
|
|
<p>
|
|
These arguments can be used to express either raw measurements of a clock
|
|
timing experiment or a percentage across machines. For instance a group of
|
|
sites have a 2% variance, then <code>replicationClockskewFast</code> should be given as
|
|
102, and <code>replicationClockskewSlow</code> should be set at 100. Or, for a 0.03%
|
|
difference, you can use 10003 and 10000 respectively.
|
|
<p>
|
|
The database environment's replication subsystem may also be configured using
|
|
the environment's
|
|
<a href="../../../../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.
|
|
The syntax of the entry in that file is a single line with the string
|
|
"rep_set_clockskew", one or more whitespace characters, and the clockskew
|
|
specified in two parts: the replicationClockskewFast and the replicationClockskewSlow. For example,
|
|
"rep_set_clockskew 102 100". Because the
|
|
<a href="../../../../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> 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, not only operations performed
|
|
using the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle.
|
|
<p>
|
|
This method may not be called after the <A HREF="../../../com/sleepycat/db/Environment.html#replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)"><CODE>Environment.replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)</CODE></A> or <A HREF="../../../com/sleepycat/db/Environment.html#startReplication(com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Environment.startReplication(com.sleepycat.db.DatabaseEntry, boolean)</CODE></A> methods are called.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>replicationClockskewFast</CODE> - The value, relative to the <code>replicationClockskewSlow</code>, of the fastest clock in the group of sites.<DD><CODE>replicationClockskewSlow</CODE> - The value of the slowest clock in the group of sites.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationClockskewFast()"><!-- --></A><H3>
|
|
getReplicationClockskewFast</H3>
|
|
<PRE>
|
|
public int <B>getReplicationClockskewFast</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the current clock skew value for the fastest clock in the group of sites.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The current clock skew value for the fastest clock in the group of sites.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationClockskewSlow()"><!-- --></A><H3>
|
|
getReplicationClockskewSlow</H3>
|
|
<PRE>
|
|
public int <B>getReplicationClockskewSlow</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the current clock skew value for the slowest clock in the group of sites.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The current clock skew value for the slowest clock in the group of sites.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationLimit(long)"><!-- --></A><H3>
|
|
setReplicationLimit</H3>
|
|
<PRE>
|
|
public void <B>setReplicationLimit</B>(long replicationLimit)</PRE>
|
|
<DL>
|
|
<DD>Impose a byte-count limit on the amount of data that will be
|
|
transmitted from a site in a single call to <A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</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 not be called before the database environment is opened.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>replicationLimit</CODE> - The maximum number of bytes that will be sent in a single call to
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</CODE></A>.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationLimit()"><!-- --></A><H3>
|
|
getReplicationLimit</H3>
|
|
<PRE>
|
|
public long <B>getReplicationLimit</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the transmit limit in bytes for a single call to
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</CODE></A>.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The transmit limit in bytes for a single call to <A HREF="../../../com/sleepycat/db/Environment.html#processReplicationMessage(com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, int)"><CODE>Environment.processReplicationMessage</CODE></A>.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationRequestMin(int)"><!-- --></A><H3>
|
|
setReplicationRequestMin</H3>
|
|
<PRE>
|
|
public void <B>setReplicationRequestMin</B>(int replicationRequestMin)</PRE>
|
|
<DL>
|
|
<DD>Set a threshold for the minimum time that a client waits before requesting
|
|
retransmission of a missing message. Specifically, if the client detects a
|
|
gap in the sequence of incoming log records or database pages, Berkeley DB
|
|
will wait for at least <code>replicationRequestMin</code> microseconds before requesting
|
|
retransmission of the missing record. Berkeley DB will double that amount
|
|
before requesting the same missing record again, and so on, up to a maximum
|
|
threshold, set by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationRequestMax(int)"><CODE>setReplicationRequestMax(int)</CODE></A>.
|
|
<p>
|
|
These values are thresholds only. Since Berkeley DB has no thread available
|
|
in the library as a timer, the threshold is only checked when a thread enters
|
|
the Berkeley DB library to process an incoming replication message. Any
|
|
amount of time may have passed since the last message arrived and Berkeley DB
|
|
only checks whether the amount of time since a request was made is beyond the
|
|
threshold value or not.
|
|
<p>
|
|
By default the minimum is 40000 and the maximum is 1280000 (1.28 seconds).
|
|
These defaults are fairly arbitrary and the application likely needs to
|
|
adjust these. The values should be based on expected load and performance
|
|
characteristics of the master and client host platforms and transport
|
|
infrastructure as well as round-trip message time.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>replicationRequestMin</CODE> - The minimum amount of time the client waits before requesting retransmission
|
|
of a missing message.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationRequestMin()"><!-- --></A><H3>
|
|
getReplicationRequestMin</H3>
|
|
<PRE>
|
|
public int <B>getReplicationRequestMin</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the threshold for the minimum amount of time that a client waits before
|
|
requesting retransmission of a missed message.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The threshold for the minimum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationRequestMax(int)"><!-- --></A><H3>
|
|
setReplicationRequestMax</H3>
|
|
<PRE>
|
|
public void <B>setReplicationRequestMax</B>(int replicationRequestMax)</PRE>
|
|
<DL>
|
|
<DD>Set a threshold for the maximum time that a client waits before requesting
|
|
retransmission of a missing message. Specifically, if the client detects a
|
|
gap in the sequence of incoming log records or database pages, Berkeley DB
|
|
will wait for at least the minimum threshold, set by
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setReplicationRequestMin(int)"><CODE>setReplicationRequestMin(int)</CODE></A>, before requesting retransmission of the
|
|
missing record. Berkeley DB will double that amount before requesting the
|
|
same missing record again, and so on, up to <code>replicationRequestMax</code>.
|
|
<p>
|
|
These values are thresholds only. Since Berkeley DB has no thread available
|
|
in the library as a timer, the threshold is only checked when a thread enters
|
|
the Berkeley DB library to process an incoming replication message. Any
|
|
amount of time may have passed since the last message arrived and Berkeley DB
|
|
only checks whether the amount of time since a request was made is beyond the
|
|
threshold value or not.
|
|
<p>
|
|
By default the minimum is 40000 and the maximum is 1280000 (1.28 seconds).
|
|
These defaults are fairly arbitrary and the application likely needs to
|
|
adjust these. The values should be based on expected load and performance
|
|
characteristics of the master and client host platforms and transport
|
|
infrastructure as well as round-trip message time.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>replicationRequestMax</CODE> - The maximum amount of time the client waits before requesting retransmission
|
|
of a missing message.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationRequestMax()"><!-- --></A><H3>
|
|
getReplicationRequestMax</H3>
|
|
<PRE>
|
|
public int <B>getReplicationRequestMax</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the threshold for the maximum amount of time that a client waits before
|
|
requesting retransmission of a missed message.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The threshold for the maximum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationTransport(int, com.sleepycat.db.ReplicationTransport)"><!-- --></A><H3>
|
|
setReplicationTransport</H3>
|
|
<PRE>
|
|
public void <B>setReplicationTransport</B>(int envid,
|
|
<A HREF="../../../com/sleepycat/db/ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</A> replicationTransport)</PRE>
|
|
<DL>
|
|
<DD>Initialize the communication infrastructure for a database environment
|
|
participating in a replicated application.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>envid</CODE> - The local environment's ID. It must be a positive integer and
|
|
uniquely identify this Berkeley DB database environment.
|
|
<p><DD><CODE>replicationTransport</CODE> - The callback function is used to transmit data using the replication
|
|
application's communication infrastructure.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationTransport()"><!-- --></A><H3>
|
|
getReplicationTransport</H3>
|
|
<PRE>
|
|
public <A HREF="../../../com/sleepycat/db/ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</A> <B>getReplicationTransport</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the replication callback function used to transmit data using
|
|
the replication application's communication infrastructure.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The replication callback function used to transmit data using the
|
|
replication application's communication infrastructure.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRegister(boolean)"><!-- --></A><H3>
|
|
setRegister</H3>
|
|
<PRE>
|
|
public void <B>setRegister</B>(boolean register)</PRE>
|
|
<DL>
|
|
<DD>Check if a process has failed while using the database environment, that
|
|
is, if a process has exited with an open <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle. (For
|
|
this check to be accurate, all processes using the environment must
|
|
specify this flag when opening the environment.) If recovery
|
|
needs to be run for any reason and either <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setRunRecovery(boolean)"><CODE>setRunRecovery(boolean)</CODE></A> or
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setRunFatalRecovery(boolean)"><CODE>setRunFatalRecovery(boolean)</CODE></A> are also specified, recovery will be performed
|
|
and the open will proceed normally. If recovery needs to be run and no
|
|
recovery flag is specified, a <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A> will be thrown.
|
|
If recovery does not need to be run, the recovery flags will be ignored.
|
|
See
|
|
<a href="../../../../ref/transapp/app.html" target="_top">Architecting
|
|
Transactional Data Store applications</a>) for more information.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>register</CODE> - If true, check for process failure when the environment is opened.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRegister()"><!-- --></A><H3>
|
|
getRegister</H3>
|
|
<PRE>
|
|
public boolean <B>getRegister</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the check for process failure when the environment is opened.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the check for process failure when the environment is opened.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRunFatalRecovery(boolean)"><!-- --></A><H3>
|
|
setRunFatalRecovery</H3>
|
|
<PRE>
|
|
public void <B>setRunFatalRecovery</B>(boolean runFatalRecovery)</PRE>
|
|
<DL>
|
|
<DD>Configure to run catastrophic recovery on this environment before opening it for
|
|
normal use.
|
|
<p>
|
|
A standard part of the recovery process is to remove the existing
|
|
database environment and create a new one. Applications running
|
|
recovery must be prepared to re-create the environment because
|
|
underlying shared regions will be removed and re-created.
|
|
<p>
|
|
If the thread of control performing recovery does not specify the
|
|
correct database environment initialization information (for example,
|
|
the correct memory pool cache size), the result can be an application
|
|
running in an environment with incorrect cache and other subsystem
|
|
sizes. For this reason, the thread of control performing recovery
|
|
should specify correct configuration information before recovering the
|
|
environment; or it should remove the environment after recovery is
|
|
completed, leaving creation of a correctly sized environment to a
|
|
subsequent call.
|
|
<p>
|
|
All recovery processing must be single-threaded; that is, only a single
|
|
thread of control may perform recovery or access a database environment
|
|
while recovery is being performed. Because it is not an error to run
|
|
recovery for an environment for which no recovery is required, it is
|
|
reasonable programming practice for the thread of control responsible
|
|
for performing recovery and creating the environment to always specify
|
|
recovery during startup.
|
|
<p>
|
|
This method returns successfully if recovery is run no log files exist,
|
|
so it is necessary to ensure that all necessary log files are present
|
|
before running recovery.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>runFatalRecovery</CODE> - If true, configure to run catastrophic recovery on this environment
|
|
before opening it for normal use.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRunFatalRecovery()"><!-- --></A><H3>
|
|
getRunFatalRecovery</H3>
|
|
<PRE>
|
|
public boolean <B>getRunFatalRecovery</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the handle is configured to run catastrophic recovery on
|
|
the database environment before opening it for use.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The handle is configured to run catastrophic recovery on
|
|
the database environment before opening it for use.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRunRecovery(boolean)"><!-- --></A><H3>
|
|
setRunRecovery</H3>
|
|
<PRE>
|
|
public void <B>setRunRecovery</B>(boolean runRecovery)</PRE>
|
|
<DL>
|
|
<DD>Configure to run normal recovery on this environment before opening it for
|
|
normal use.
|
|
<p>
|
|
A standard part of the recovery process is to remove the existing
|
|
database environment and create a new one. Applications running
|
|
recovery must be prepared to re-create the environment because
|
|
underlying shared regions will be removed and re-created.
|
|
<p>
|
|
If the thread of control performing recovery does not specify the
|
|
correct database environment initialization information (for example,
|
|
the correct memory pool cache size), the result can be an application
|
|
running in an environment with incorrect cache and other subsystem
|
|
sizes. For this reason, the thread of control performing recovery
|
|
should specify correct configuration information before recovering the
|
|
environment; or it should remove the environment after recovery is
|
|
completed, leaving creation of a correctly sized environment to a
|
|
subsequent call.
|
|
<p>
|
|
All recovery processing must be single-threaded; that is, only a single
|
|
thread of control may perform recovery or access a database environment
|
|
while recovery is being performed. Because it is not an error to run
|
|
recovery for an environment for which no recovery is required, it is
|
|
reasonable programming practice for the thread of control responsible
|
|
for performing recovery and creating the environment to always specify
|
|
recovery during startup.
|
|
<p>
|
|
This method returns successfully if recovery is run no log files exist,
|
|
so it is necessary to ensure that all necessary log files are present
|
|
before running recovery.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>runRecovery</CODE> - If true, configure to run normal recovery on this environment
|
|
before opening it for normal use.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRunRecovery()"><!-- --></A><H3>
|
|
getRunRecovery</H3>
|
|
<PRE>
|
|
public boolean <B>getRunRecovery</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the handle is configured to run normal recovery on the
|
|
database environment before opening it for use.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The handle is configured to run normal recovery on the
|
|
database environment before opening it for use.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSystemMemory(boolean)"><!-- --></A><H3>
|
|
setSystemMemory</H3>
|
|
<PRE>
|
|
public void <B>setSystemMemory</B>(boolean systemMemory)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to allocate memory from system
|
|
shared memory instead of from memory backed by the filesystem.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>systemMemory</CODE> - If true, configure the database environment to allocate memory from
|
|
system shared memory instead of from memory backed by the filesystem.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSystemMemory()"><!-- --></A><H3>
|
|
getSystemMemory</H3>
|
|
<PRE>
|
|
public boolean <B>getSystemMemory</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to allocate memory
|
|
from system shared memory instead of from memory backed by the
|
|
filesystem.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to allocate memory
|
|
from system shared memory instead of from memory backed by the
|
|
filesystem.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setRPCServer(java.lang.String, long, long)"><!-- --></A><H3>
|
|
setRPCServer</H3>
|
|
<PRE>
|
|
public void <B>setRPCServer</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> rpcServer,
|
|
long rpcClientTimeout,
|
|
long rpcServerTimeout)</PRE>
|
|
<DL>
|
|
<DD>Establish a connection to a RPC server for this database environment.
|
|
<p>
|
|
After this method is called, subsequent calls to Berkeley DB library
|
|
interfaces may throw exceptions encapsulating DB_NOSERVER,
|
|
DB_NOSERVER_ID or DB_NOSERVER_HOME.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>rpcServer</CODE> - The host to which the client will connect and create a channel for
|
|
communication.
|
|
<p><DD><CODE>rpcClientTimeout</CODE> - The number of seconds the client should wait for results to come
|
|
back from the server. Once the timeout has expired on any
|
|
communication with the server, <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><CODE>DatabaseException</CODE></A>
|
|
encapsulating DB_NOSERVER will be thrown. If this value is zero, a
|
|
default timeout is used.
|
|
<p><DD><CODE>rpcServerTimeout</CODE> - The number of seconds the server should allow a client connection
|
|
to remain idle before assuming that the client is gone. Once that
|
|
timeout has been reached, the server releases all resources
|
|
associated with that client connection. Subsequent attempts by that
|
|
client to communicate with the server result in an error return,
|
|
indicating that an invalid identifier has been given to the server.
|
|
This value can be considered a hint to the server. The server may
|
|
alter this value based on its own policies or allowed values. If
|
|
this value is zero, a default timeout is used.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setSegmentId(long)"><!-- --></A><H3>
|
|
setSegmentId</H3>
|
|
<PRE>
|
|
public void <B>setSegmentId</B>(long segmentId)</PRE>
|
|
<DL>
|
|
<DD>Specify a base segment ID for database environment shared memory
|
|
regions created in system memory on VxWorks or systems supporting
|
|
X/Open-style shared memory interfaces; for example, UNIX systems
|
|
supporting <code>shmget</code> and related System V IPC interfaces.
|
|
<p>
|
|
This base segment ID will be used when database environment shared
|
|
memory regions are first created. It will be incremented a small
|
|
integer value each time a new shared memory region is created; that
|
|
is, if the base ID is 35, the first shared memory region created
|
|
will have a segment ID of 35, and the next one will have a segment
|
|
ID between 36 and 40 or so. A database environment always creates
|
|
a master shared memory region; an additional shared memory region
|
|
for each of the subsystems supported by the environment (Locking,
|
|
Logging, Memory Pool and Transaction); plus an additional shared
|
|
memory region for each additional memory pool cache that is
|
|
supported. Already existing regions with the same segment IDs will
|
|
be removed.
|
|
<p>
|
|
The intent behind this method is two-fold: without it, applications
|
|
have no way to ensure that two Berkeley DB applications don't
|
|
attempt to use the same segment IDs when creating different database
|
|
environments. In addition, by using the same segment IDs each time
|
|
the environment is created, previously created segments will be
|
|
removed, and the set of segments on the system will not grow without
|
|
bound.
|
|
The database environment's base segment ID 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 "set_shm_key", one or more whitespace characters, and the ID.
|
|
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 only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, the
|
|
information specified to this method must be consistent with the
|
|
existing environment or corruption can occur.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>segmentId</CODE> - The base segment ID for the database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getSegmentId()"><!-- --></A><H3>
|
|
getSegmentId</H3>
|
|
<PRE>
|
|
public long <B>getSegmentId</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the base segment ID.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The base segment ID.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTemporaryDirectory(java.io.File)"><!-- --></A><H3>
|
|
setTemporaryDirectory</H3>
|
|
<PRE>
|
|
public void <B>setTemporaryDirectory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> temporaryDirectory)</PRE>
|
|
<DL>
|
|
<DD>Set the path of a directory to be used as the location of temporary
|
|
files.
|
|
<p>
|
|
The files created to back in-memory access method databases will be
|
|
created relative to this path. These temporary files can be quite
|
|
large, depending on the size of the database.
|
|
<p>
|
|
If no directory is specified, the following alternatives are checked
|
|
in the specified order. The first existing directory path is used
|
|
for all temporary files.
|
|
<blockquote><ol>
|
|
<li>The value of the environment variable TMPDIR.
|
|
<li>The value of the environment variable TEMP.
|
|
<li>The value of the environment variable TMP.
|
|
<li>The value of the environment variable TempFolder.
|
|
<li>The value returned by the GetTempPath interface.
|
|
<li>The directory /var/tmp.
|
|
<li>The directory /usr/tmp.
|
|
<li>The directory /temp.
|
|
<li>The directory /tmp.
|
|
<li>The directory C:/temp.
|
|
<li>The directory C:/tmp.
|
|
</ol</blockquote>
|
|
<p>
|
|
Note: the environment variables are only checked if the database
|
|
environment has been configured with one of
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setUseEnvironment(boolean)"><CODE>EnvironmentConfig.setUseEnvironment</CODE></A> or
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setUseEnvironmentRoot(boolean)"><CODE>EnvironmentConfig.setUseEnvironmentRoot</CODE></A>.
|
|
<p>
|
|
Note: the GetTempPath interface is only checked on Win/32 platforms.
|
|
<p>
|
|
The database environment's temporary file directory 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 "set_tmp_dir", one or more whitespace characters, and the directory name.
|
|
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 only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, the
|
|
information specified to this method must be consistent with the
|
|
existing environment or corruption can occur.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>temporaryDirectory</CODE> - The directory to be used to store temporary files.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTemporaryDirectory(java.lang.String)"><!-- --></A><H3>
|
|
setTemporaryDirectory</H3>
|
|
<PRE>
|
|
public void <B>setTemporaryDirectory</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> temporaryDirectory)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setTemporaryDirectory(java.io.File)"><CODE>setTemporaryDirectory(java.io.File)</CODE></A></I>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTemporaryDirectory()"><!-- --></A><H3>
|
|
getTemporaryDirectory</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> <B>getTemporaryDirectory</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the path of a directory to be used as the location of
|
|
temporary files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The path of a directory to be used as the location of
|
|
temporary files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMutexAlignment(int)"><!-- --></A><H3>
|
|
setMutexAlignment</H3>
|
|
<PRE>
|
|
public void <B>setMutexAlignment</B>(int mutexAlignment)</PRE>
|
|
<DL>
|
|
<DD>Set the mutex alignment, in bytes.
|
|
<p>
|
|
It is sometimes advantageous to align mutexes on specific byte
|
|
boundaries in order to minimize cache line collisions. This method
|
|
specifies an alignment for mutexes allocated by Berkeley DB.
|
|
<p>
|
|
The database environment's mutex alignment 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 "mutex_set_align", one or more whitespace characters, and the mutex alignment in bytes.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>mutexAlignment</CODE> - mutex alignment, in bytes. The mutex alignment must be a power-of-two.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMutexAlignment()"><!-- --></A><H3>
|
|
getMutexAlignment</H3>
|
|
<PRE>
|
|
public int <B>getMutexAlignment</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the mutex alignment, in bytes.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The mutex alignment, in bytes.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMutexIncrement(int)"><!-- --></A><H3>
|
|
setMutexIncrement</H3>
|
|
<PRE>
|
|
public void <B>setMutexIncrement</B>(int mutexIncrement)</PRE>
|
|
<DL>
|
|
<DD>Increase the number of mutexes to allocate.
|
|
<p>
|
|
Berkeley DB allocates a default number of mutexes based on the initial
|
|
configuration of the database environment. That default calculation may
|
|
be too small if the application has an unusual need for mutexes (for
|
|
example, if the application opens an unexpectedly large number of
|
|
databases) or too large (if the application is trying to minimize its
|
|
memory footprint). This method configure the number of additional
|
|
mutexes to allocate.
|
|
<p>
|
|
Calling this method discards any value previously
|
|
set using the <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMaxMutexes(int)"><CODE>setMaxMutexes(int)</CODE></A> method.
|
|
<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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>mutexIncrement</CODE> - The number of additional mutexes to allocate.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMutexIncrement()"><!-- --></A><H3>
|
|
getMutexIncrement</H3>
|
|
<PRE>
|
|
public int <B>getMutexIncrement</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the number of additional mutexes to allocate.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The number of additional mutexes to allocate.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMaxMutexes(int)"><!-- --></A><H3>
|
|
setMaxMutexes</H3>
|
|
<PRE>
|
|
public void <B>setMaxMutexes</B>(int maxMutexes)</PRE>
|
|
<DL>
|
|
<DD>Set the total number of mutexes to allocate.
|
|
<p>
|
|
Berkeley DB allocates a default number of mutexes based on the initial
|
|
configuration of the database environment. That default calculation may
|
|
be too small if the application has an unusual need for mutexes (for
|
|
example, if the application opens an unexpectedly large number of
|
|
databases) or too large (if the application is trying to minimize its
|
|
memory footprint). This method is used to specify an
|
|
absolute number of mutexes to allocate.
|
|
<p>
|
|
Calling this method discards any value previously
|
|
set using the <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMutexIncrement(int)"><CODE>setMutexIncrement(int)</CODE></A> method.
|
|
<p>
|
|
The database environment's total number of mutexes may also be set using
|
|
the environment's <b>DB_CONFIG</b> file. The syntax of the entry in that
|
|
file is a single line with the string "mutex_set_max", one or more
|
|
whitespace characters, and the total number of mutexes. Because the
|
|
<b>DB_CONFIG</b> 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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>maxMutexes</CODE> - The absolute number of mutexes to allocate.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMaxMutexes()"><!-- --></A><H3>
|
|
getMaxMutexes</H3>
|
|
<PRE>
|
|
public int <B>getMaxMutexes</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the total number of mutexes allocated.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The total number of mutexes allocated.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setMutexTestAndSetSpins(int)"><!-- --></A><H3>
|
|
setMutexTestAndSetSpins</H3>
|
|
<PRE>
|
|
public void <B>setMutexTestAndSetSpins</B>(int mutexTestAndSetSpins)</PRE>
|
|
<DL>
|
|
<DD>Specify the number of times that test-and-set mutexes should spin
|
|
without blocking. The value defaults to 1 on uniprocessor systems and
|
|
to 50 times the number of processors on multiprocessor systems.
|
|
<p>
|
|
The database environment's test-and-set spin count 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 "set_tas_spins", one or more whitespace characters, and the number of spins.
|
|
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 only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>mutexTestAndSetSpins</CODE> - The number of spins test-and-set mutexes should execute before blocking.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getMutexTestAndSetSpins()"><!-- --></A><H3>
|
|
getMutexTestAndSetSpins</H3>
|
|
<PRE>
|
|
public int <B>getMutexTestAndSetSpins</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the test-and-set spin count.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The test-and-set spin count.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationNumSites(int)"><!-- --></A><H3>
|
|
setReplicationNumSites</H3>
|
|
<PRE>
|
|
public void <B>setReplicationNumSites</B>(int replicationNumSites)</PRE>
|
|
<DL>
|
|
<DD>Set the total number of sites in the replication group.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>replicationNumSites</CODE> - The total number of sites in the replication group.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationNumSites()"><!-- --></A><H3>
|
|
getReplicationNumSites</H3>
|
|
<PRE>
|
|
public int <B>getReplicationNumSites</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the total number of sites in the replication group.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The total number of sites in the replication group.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setReplicationPriority(int)"><!-- --></A><H3>
|
|
setReplicationPriority</H3>
|
|
<PRE>
|
|
public void <B>setReplicationPriority</B>(int replicationPriority)</PRE>
|
|
<DL>
|
|
<DD>Set the current environment's priority. Priority is used to determine
|
|
which replicated site will be selected as master when an election occurs.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>replicationPriority</CODE> - The database environment priority.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getReplicationPriority()"><!-- --></A><H3>
|
|
getReplicationPriority</H3>
|
|
<PRE>
|
|
public int <B>getReplicationPriority</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the current environment's priority. Priority is used to determine
|
|
which replicated site will be selected as master when an election occurs.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The database environment priority.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTestAndSetSpins(int)"><!-- --></A><H3>
|
|
setTestAndSetSpins</H3>
|
|
<PRE>
|
|
public void <B>setTestAndSetSpins</B>(int mutexTestAndSetSpins)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMutexTestAndSetSpins(int)"><CODE>setMutexTestAndSetSpins(int)</CODE></A></I>
|
|
<P>
|
|
<DD>Set the number of times test-and-set mutexes should spin before
|
|
blocking.
|
|
<p>
|
|
The value defaults to 1 on uniprocessor systems and to 50 times the
|
|
number of processors on multiprocessor systems.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>mutexTestAndSetSpins</CODE> - The number of times test-and-set mutexes should spin before blocking.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTestAndSetSpins()"><!-- --></A><H3>
|
|
getTestAndSetSpins</H3>
|
|
<PRE>
|
|
public int <B>getTestAndSetSpins</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getMutexTestAndSetSpins()"><CODE>getMutexTestAndSetSpins()</CODE></A></I>
|
|
<P>
|
|
<DD>Return the number of times test-and-set mutexes should spin before
|
|
blocking.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The number of times test-and-set mutexes should spin before
|
|
blocking.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setThreaded(boolean)"><!-- --></A><H3>
|
|
setThreaded</H3>
|
|
<PRE>
|
|
public void <B>setThreaded</B>(boolean threaded)</PRE>
|
|
<DL>
|
|
<DD>Configure the handle to be <em>free-threaded</em>; that is, usable
|
|
by multiple threads within a single address space.
|
|
<p>
|
|
This is the default; threading is always assumed in Java, so no special
|
|
configuration is required.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>threaded</CODE> - If true, configure the handle to be <em>free-threaded</em>.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getThreaded()"><!-- --></A><H3>
|
|
getThreaded</H3>
|
|
<PRE>
|
|
public boolean <B>getThreaded</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the handle is configured to be <em>free-threaded</em>.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the handle is configured to be <em>free-threaded</em>.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTransactional(boolean)"><!-- --></A><H3>
|
|
setTransactional</H3>
|
|
<PRE>
|
|
public void <B>setTransactional</B>(boolean transactional)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment for transactions.
|
|
<p>
|
|
This configuration option should be used when transactional guarantees
|
|
such as atomicity of multiple operations and durability are important.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>transactional</CODE> - If true, configure the database environment for transactions.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTransactional()"><!-- --></A><H3>
|
|
getTransactional</H3>
|
|
<PRE>
|
|
public boolean <B>getTransactional</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured for transactions.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured for transactions.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnNoSync(boolean)"><!-- --></A><H3>
|
|
setTxnNoSync</H3>
|
|
<PRE>
|
|
public void <B>setTxnNoSync</B>(boolean txnNoSync)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to not write or synchronously flush the log
|
|
on transaction commit.
|
|
<p>
|
|
This means that transactions exhibit the ACI (atomicity, consistency,
|
|
and isolation) properties, but not D (durability); that is, database
|
|
integrity will be maintained, but if the application or system fails,
|
|
it is possible some number of the most recently committed transactions
|
|
may be undone during recovery. The number of transactions at risk is
|
|
governed by how many log updates can fit into the log buffer, how often
|
|
the operating system flushes dirty buffers to disk, and how often the
|
|
log is checkpointed.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnNoSync</CODE> - If true, configure the system to not write or synchronously flush
|
|
the log on transaction commit.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnNoSync()"><!-- --></A><H3>
|
|
getTxnNoSync</H3>
|
|
<PRE>
|
|
public boolean <B>getTxnNoSync</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to not write or synchronously
|
|
flush the log on transaction commit.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to not write or synchronously
|
|
flush the log on transaction commit.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnNoWait(boolean)"><!-- --></A><H3>
|
|
setTxnNoWait</H3>
|
|
<PRE>
|
|
public void <B>setTxnNoWait</B>(boolean txnNoWait)</PRE>
|
|
<DL>
|
|
<DD>If a lock is unavailable for any Berkeley DB operation performed in the
|
|
context of a transaction, cause the operation to throw <A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> without waiting for the lock.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnNoWait</CODE> - If true, configure transactions to not wait for locks by default.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnNoWait()"><!-- --></A><H3>
|
|
getTxnNoWait</H3>
|
|
<PRE>
|
|
public boolean <B>getTxnNoWait</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the transactions have been configured to not wait for locks by default.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the transactions have been configured to not wait for locks by default.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnNotDurable(boolean)"><!-- --></A><H3>
|
|
setTxnNotDurable</H3>
|
|
<PRE>
|
|
public void <B>setTxnNotDurable</B>(boolean txnNotDurable)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to not write log records.
|
|
<p>
|
|
This means that transactions exhibit the ACI (atomicity, consistency,
|
|
and isolation) properties, but not D (durability); that is, database
|
|
integrity will be maintained, but if the application or system
|
|
fails, integrity will not persist. All database files must be
|
|
verified and/or restored from backup after a failure. In order to
|
|
ensure integrity after application shut down, all database handles
|
|
must be closed without specifying noSync, or all database changes
|
|
must be flushed from the database environment cache using the
|
|
<A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><CODE>Environment.checkpoint</CODE></A>.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnNotDurable</CODE> - If true, configure the system to not write log records.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnNotDurable()"><!-- --></A><H3>
|
|
getTxnNotDurable</H3>
|
|
<PRE>
|
|
public boolean <B>getTxnNotDurable</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to not write log records.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to not write log records.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnSnapshot(boolean)"><!-- --></A><H3>
|
|
setTxnSnapshot</H3>
|
|
<PRE>
|
|
public void <B>setTxnSnapshot</B>(boolean txnSnapshot)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to run transactions at snapshot
|
|
isolation by default. See <A HREF="../../../com/sleepycat/db/TransactionConfig.html#setSnapshot(boolean)"><CODE>TransactionConfig.setSnapshot(boolean)</CODE></A> for more
|
|
information.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnSnapshot</CODE> - If true, configure the system to default to snapshot isolation.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnSnapshot()"><!-- --></A><H3>
|
|
getTxnSnapshot</H3>
|
|
<PRE>
|
|
public boolean <B>getTxnSnapshot</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the handle is configured to run all transactions at snapshot
|
|
isolation.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the handle is configured to run all transactions at snapshot
|
|
isolation.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnMaxActive(int)"><!-- --></A><H3>
|
|
setTxnMaxActive</H3>
|
|
<PRE>
|
|
public void <B>setTxnMaxActive</B>(int txnMaxActive)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to support at least txnMaxActive
|
|
active transactions.
|
|
<p>
|
|
This value bounds the size of the memory allocated for transactions.
|
|
Child transactions are counted as active until they either commit
|
|
or abort.
|
|
<p>
|
|
When all of the memory available in the database environment for
|
|
transactions is in use, calls to <A HREF="../../../com/sleepycat/db/Environment.html#beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)"><CODE>Environment.beginTransaction</CODE></A>
|
|
will fail (until some active transactions complete). If this
|
|
interface is never called, the database environment is configured
|
|
to support at least 20 active transactions.
|
|
<p>
|
|
The database environment's number of active transactions 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 "set_tx_max", one or more whitespace characters, and the number of transactions.
|
|
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 not be called after the
|
|
environment has been opened.
|
|
If joining an existing database environment, any
|
|
information specified to this method will be ignored.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnMaxActive</CODE> - The minimum number of simultaneously active transactions supported
|
|
by the database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnMaxActive()"><!-- --></A><H3>
|
|
getTxnMaxActive</H3>
|
|
<PRE>
|
|
public int <B>getTxnMaxActive</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the minimum number of simultaneously active transactions supported
|
|
by the database environment.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The minimum number of simultaneously active transactions supported
|
|
by the database environment.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnTimeout(long)"><!-- --></A><H3>
|
|
setTxnTimeout</H3>
|
|
<PRE>
|
|
public void <B>setTxnTimeout</B>(long txnTimeout)</PRE>
|
|
<DL>
|
|
<DD>Set the timeout value for the database environment
|
|
transactions.
|
|
<p>
|
|
Transaction timeouts are checked whenever a thread of control blocks on
|
|
a lock or when deadlock detection is performed. The lock is one
|
|
requested on behalf of a transaction, normally by the database access
|
|
methods underlying the application.
|
|
As timeouts are only checked when the lock request first blocks or when
|
|
deadlock detection is performed, the accuracy of the timeout depends on
|
|
how often deadlock detection is performed.
|
|
<p>
|
|
Timeout values specified for the database environment may be overridden
|
|
on a
|
|
per-transaction basis by <A HREF="../../../com/sleepycat/db/Transaction.html#setTxnTimeout(long)"><CODE>Transaction.setTxnTimeout</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>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnTimeout</CODE> - The timeout value, specified as an unsigned 32-bit number of
|
|
microseconds, limiting the maximum timeout to roughly 71 minutes.
|
|
<p>
|
|
<p>
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified.
|
|
<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="getTxnTimeout()"><!-- --></A><H3>
|
|
getTxnTimeout</H3>
|
|
<PRE>
|
|
public long <B>getTxnTimeout</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the database environment transaction timeout value, in
|
|
microseconds; a timeout of 0 means no timeout is set.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The database environment transaction timeout value, in
|
|
microseconds; a timeout of 0 means no timeout is set.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnTimestamp(java.util.Date)"><!-- --></A><H3>
|
|
setTxnTimestamp</H3>
|
|
<PRE>
|
|
public void <B>setTxnTimestamp</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> txnTimestamp)</PRE>
|
|
<DL>
|
|
<DD>Recover to the specified time rather than to the most current
|
|
possible date.
|
|
<p>
|
|
Once a database environment has been upgraded to a new version of
|
|
Berkeley DB involving a log format change, it is no longer possible
|
|
to recover to a specific time before that upgrade.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle, not an entire database environment.
|
|
<p>
|
|
This method may not be called after the
|
|
environment has been opened.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnTimestamp</CODE> - The recovery timestamp.
|
|
Only the seconds (not the milliseconds) of the timestamp are used.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnTimestamp()"><!-- --></A><H3>
|
|
getTxnTimestamp</H3>
|
|
<PRE>
|
|
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> <B>getTxnTimestamp</B>()</PRE>
|
|
<DL>
|
|
<DD>Return the time to which recovery will be done, or 0 if recovery will
|
|
be done to the most current possible date.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The time to which recovery will be done, or 0 if recovery will be
|
|
done to the most current possible date.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setTxnWriteNoSync(boolean)"><!-- --></A><H3>
|
|
setTxnWriteNoSync</H3>
|
|
<PRE>
|
|
public void <B>setTxnWriteNoSync</B>(boolean txnWriteNoSync)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to write, but not synchronously flush, the log on
|
|
transaction commit.
|
|
<p>
|
|
This means that transactions exhibit the ACI (atomicity, consistency,
|
|
and isolation) properties, but not D (durability); that is, database
|
|
integrity will be maintained, but if the system fails, it is possible
|
|
some number of the most recently committed transactions may be undone
|
|
during recovery. The number of transactions at risk is governed by how
|
|
often the system flushes dirty buffers to disk and how often the log is
|
|
checkpointed.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>txnWriteNoSync</CODE> - If true, configure the system to write, but not synchronously flush,
|
|
the log on transaction commit.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getTxnWriteNoSync()"><!-- --></A><H3>
|
|
getTxnWriteNoSync</H3>
|
|
<PRE>
|
|
public boolean <B>getTxnWriteNoSync</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to write, but not synchronously
|
|
flush, the log on transaction commit.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to write, but not synchronously
|
|
flush, the log on transaction commit.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setUseEnvironment(boolean)"><!-- --></A><H3>
|
|
setUseEnvironment</H3>
|
|
<PRE>
|
|
public void <B>setUseEnvironment</B>(boolean useEnvironment)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to accept information from the
|
|
process environment when naming files, regardless of the status of
|
|
the process.
|
|
<p>
|
|
Because permitting users to specify which files are used can create
|
|
security problems, environment information will be used in file
|
|
naming for all users only if configured to do so.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>useEnvironment</CODE> - If true, configure the database environment to accept information
|
|
from the process environment when naming files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getUseEnvironment()"><!-- --></A><H3>
|
|
getUseEnvironment</H3>
|
|
<PRE>
|
|
public boolean <B>getUseEnvironment</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to accept information
|
|
from the process environment when naming files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to accept information
|
|
from the process environment when naming files.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setUseEnvironmentRoot(boolean)"><!-- --></A><H3>
|
|
setUseEnvironmentRoot</H3>
|
|
<PRE>
|
|
public void <B>setUseEnvironmentRoot</B>(boolean useEnvironmentRoot)</PRE>
|
|
<DL>
|
|
<DD>Configure the database environment to accept information from the
|
|
process environment when naming files, if the process has
|
|
appropriate permissions (for example, users with a user-ID of 0 on
|
|
UNIX systems).
|
|
<p>
|
|
Because permitting users to specify which files are used can create
|
|
security problems, environment information will be used in file
|
|
naming for all users only if configured to do so.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>useEnvironmentRoot</CODE> - If true, configure the database environment to accept information
|
|
from the process environment when naming files if the process has
|
|
appropriate permissions.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getUseEnvironmentRoot()"><!-- --></A><H3>
|
|
getUseEnvironmentRoot</H3>
|
|
<PRE>
|
|
public boolean <B>getUseEnvironmentRoot</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the database environment is configured to accept information
|
|
from the process environment when naming files if the process has
|
|
appropriate permissions.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the database environment is configured to accept information
|
|
from the process environment when naming files if the process has
|
|
appropriate permissions.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><!-- --></A><H3>
|
|
setVerbose</H3>
|
|
<PRE>
|
|
public void <B>setVerbose</B>(<A HREF="../../../com/sleepycat/db/VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</A> flag,
|
|
boolean enable)</PRE>
|
|
<DL>
|
|
<DD>Display verbose information.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>flag</CODE> - The type of verbose information being configured.
|
|
<p><DD><CODE>enable</CODE> - If true, display additional information.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVerbose(com.sleepycat.db.VerboseConfig)"><!-- --></A><H3>
|
|
getVerbose</H3>
|
|
<PRE>
|
|
public boolean <B>getVerbose</B>(<A HREF="../../../com/sleepycat/db/VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</A> flag)</PRE>
|
|
<DL>
|
|
<DD>Return if the database environment is configured to display
|
|
a given type of verbose information.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>flag</CODE> - The type of verbose information being queried.
|
|
<p>
|
|
<DT><B>Returns:</B><DD>If the database environment is configured to display additional
|
|
information of the specified type.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVerboseDeadlock(boolean)"><!-- --></A><H3>
|
|
setVerboseDeadlock</H3>
|
|
<PRE>
|
|
public void <B>setVerboseDeadlock</B>(boolean verboseDeadlock)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I>
|
|
<P>
|
|
<DD>Display additional information when doing deadlock detection.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>verboseDeadlock</CODE> - If true, display additional information when doing deadlock
|
|
detection.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVerboseDeadlock()"><!-- --></A><H3>
|
|
getVerboseDeadlock</H3>
|
|
<PRE>
|
|
public boolean <B>getVerboseDeadlock</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I>
|
|
<P>
|
|
<DD>Return if the database environment is configured to display
|
|
additional information when doing deadlock detection.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>If the database environment is configured to display additional
|
|
information when doing deadlock detection.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVerboseRecovery(boolean)"><!-- --></A><H3>
|
|
setVerboseRecovery</H3>
|
|
<PRE>
|
|
public void <B>setVerboseRecovery</B>(boolean verboseRecovery)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I>
|
|
<P>
|
|
<DD>Display additional information when performing recovery.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>verboseRecovery</CODE> - If true, display additional information when performing recovery.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVerboseRecovery()"><!-- --></A><H3>
|
|
getVerboseRecovery</H3>
|
|
<PRE>
|
|
public boolean <B>getVerboseRecovery</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I>
|
|
<P>
|
|
<DD>Return if the database environment is configured to display
|
|
additional information when performing recovery.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>If the database environment is configured to display additional
|
|
information when performing recovery.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVerboseRegister(boolean)"><!-- --></A><H3>
|
|
setVerboseRegister</H3>
|
|
<PRE>
|
|
public void <B>setVerboseRegister</B>(boolean verboseRegister)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I>
|
|
<P>
|
|
<DD>Display additional information concerning support for the
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setRegister(boolean)"><CODE>setRegister(boolean)</CODE></A> method.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>verboseRegister</CODE> - If true, display additional information concerning support for the
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setRegister(boolean)"><CODE>setRegister(boolean)</CODE></A> method
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVerboseRegister()"><!-- --></A><H3>
|
|
getVerboseRegister</H3>
|
|
<PRE>
|
|
public boolean <B>getVerboseRegister</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I>
|
|
<P>
|
|
<DD>Return if the database environment is configured to display
|
|
additional information concerning support for the
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setRegister(boolean)"><CODE>setRegister(boolean)</CODE></A> method.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>If the database environment is configured to display additional
|
|
information concerning support for the
|
|
<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setRegister(boolean)"><CODE>setRegister(boolean)</CODE></A> method.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVerboseReplication(boolean)"><!-- --></A><H3>
|
|
setVerboseReplication</H3>
|
|
<PRE>
|
|
public void <B>setVerboseReplication</B>(boolean verboseReplication)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I>
|
|
<P>
|
|
<DD>Display additional information when processing replication messages.
|
|
<p>
|
|
Note, to get complete replication logging when debugging replication
|
|
applications, you must also configure and build the Berkeley DB
|
|
library with the --enable-diagnostic configuration option as well
|
|
as call this method.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>verboseReplication</CODE> - If true, display additional information when processing replication
|
|
messages.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVerboseReplication()"><!-- --></A><H3>
|
|
getVerboseReplication</H3>
|
|
<PRE>
|
|
public boolean <B>getVerboseReplication</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I>
|
|
<P>
|
|
<DD>Return if the database environment is configured to display
|
|
additional information when processing replication messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>If the database environment is configured to display additional
|
|
information when processing replication messages.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVerboseWaitsFor(boolean)"><!-- --></A><H3>
|
|
setVerboseWaitsFor</H3>
|
|
<PRE>
|
|
public void <B>setVerboseWaitsFor</B>(boolean verboseWaitsFor)</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerbose(com.sleepycat.db.VerboseConfig, boolean)"><CODE>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</CODE></A></I>
|
|
<P>
|
|
<DD>Display the waits-for table when doing deadlock detection.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>verboseWaitsFor</CODE> - If true, display the waits-for table when doing deadlock detection.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVerboseWaitsFor()"><!-- --></A><H3>
|
|
getVerboseWaitsFor</H3>
|
|
<PRE>
|
|
public boolean <B>getVerboseWaitsFor</B>()</PRE>
|
|
<DL>
|
|
<DD><B>Deprecated.</B> <I>replaced by <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#getVerbose(com.sleepycat.db.VerboseConfig)"><CODE>getVerbose(com.sleepycat.db.VerboseConfig)</CODE></A></I>
|
|
<P>
|
|
<DD>Return if the database environment is configured to display the
|
|
waits-for table when doing deadlock detection.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>If the database environment is configured to display the waits-for
|
|
table when doing deadlock detection.
|
|
<p></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setYieldCPU(boolean)"><!-- --></A><H3>
|
|
setYieldCPU</H3>
|
|
<PRE>
|
|
public void <B>setYieldCPU</B>(boolean yieldCPU)</PRE>
|
|
<DL>
|
|
<DD>Configure the system to yield the processor immediately after each
|
|
page or mutex acquisition.
|
|
<p>
|
|
This functionality should never be used for purposes other than
|
|
stress testing.
|
|
<p>
|
|
This method only affects the specified <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle (and
|
|
any other library handles opened within the scope of that handle).
|
|
For consistent behavior across the environment, all <A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A>
|
|
handles opened in the database environment must either call this method
|
|
or the configuration should be specified in the database environment's
|
|
DB_CONFIG configuration file.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>yieldCPU</CODE> - If true, configure the system to yield the processor immediately
|
|
after each page or mutex acquisition.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getYieldCPU()"><!-- --></A><H3>
|
|
getYieldCPU</H3>
|
|
<PRE>
|
|
public boolean <B>getYieldCPU</B>()</PRE>
|
|
<DL>
|
|
<DD>Return true if the system has been configured to yield the processor
|
|
immediately after each page or mutex acquisition.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>True if the system has been configured to yield the processor
|
|
immediately after each page or mutex acquisition.</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="class-use/EnvironmentConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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>
|
|
<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface 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/EnvironmentConfig.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="EnvironmentConfig.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <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>
|
|
<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
|
</BODY>
|
|
</HTML>
|