mirror of
https://github.com/yasuhirokimura/db18
synced 2026-06-08 18:29:23 +00:00
Yasuhiro KIMURA
7696 lines
327 KiB
HTML
7696 lines
327 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
|
|
<title>EnvironmentConfig (Oracle - Berkeley DB Java API)</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="date" content="2020-06-01">
|
|
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
|
|
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="EnvironmentConfig (Oracle - Berkeley DB Java API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":42,"i10":42,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":42,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":42,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":42,"i116":42,"i117":42,"i118":42,"i119":42,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":42,"i128":42,"i129":10,"i130":10,"i131":10,"i132":10,"i133":10,"i134":10,"i135":10,"i136":10,"i137":10,"i138":10,"i139":10,"i140":10,"i141":10,"i142":10,"i143":10,"i144":10,"i145":10,"i146":10,"i147":10,"i148":10,"i149":10,"i150":10,"i151":10,"i152":10,"i153":10,"i154":10,"i155":10,"i156":10,"i157":10,"i158":10,"i159":10,"i160":10,"i161":10,"i162":10,"i163":10,"i164":42,"i165":10,"i166":10,"i167":10,"i168":10,"i169":10,"i170":10,"i171":10,"i172":10,"i173":10,"i174":10,"i175":10,"i176":10,"i177":10,"i178":10,"i179":10,"i180":10,"i181":10,"i182":10,"i183":10,"i184":10,"i185":10,"i186":10,"i187":10,"i188":10,"i189":10,"i190":10,"i191":10,"i192":10,"i193":10,"i194":10,"i195":10,"i196":10,"i197":10,"i198":10,"i199":10,"i200":10,"i201":10,"i202":10,"i203":10,"i204":10,"i205":10,"i206":10,"i207":10,"i208":10,"i209":10,"i210":10,"i211":10,"i212":10,"i213":10,"i214":10,"i215":10,"i216":10,"i217":10,"i218":10,"i219":10,"i220":42,"i221":42,"i222":10,"i223":10,"i224":10,"i225":10,"i226":10,"i227":10,"i228":10,"i229":10,"i230":10,"i231":10,"i232":10,"i233":10,"i234":42,"i235":42,"i236":42,"i237":42,"i238":42,"i239":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/EnvironmentConfig.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.sleepycat.db</a></div>
|
|
<h2 title="Class EnvironmentConfig" class="title">Class EnvironmentConfig</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.db.EnvironmentConfig</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code>java.lang.Cloneable</code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">EnvironmentConfig</span>
|
|
extends java.lang.Object
|
|
implements java.lang.Cloneable</pre>
|
|
<div class="block">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:
|
|
<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>
|
|
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.
|
|
</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:
|
|
<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="Environment.html#setConfig-com.sleepycat.db.EnvironmentConfig-"><code>Environment.setConfig(com.sleepycat.db.EnvironmentConfig)</code></a>.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Field</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#EnvironmentConfig--">EnvironmentConfig</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create an EnvironmentConfig initialized with the system default settings.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDataDir-java.io.File-">addDataDir</a></span>​(java.io.File dataDir)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Add the path of a directory to be used as the location of the access method database files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addDataDir-java.lang.String-">addDataDir</a></span>​(java.lang.String dataDir)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#addDataDir-java.io.File-"><code>addDataDir(java.io.File)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addReplicationManagerSite-com.sleepycat.db.ReplicationManagerSiteConfig-">addReplicationManagerSite</a></span>​(<a href="ReplicationManagerSiteConfig.html" title="class in com.sleepycat.db">ReplicationManagerSiteConfig</a> repmgrSiteConfig)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure a site in a replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowCreate--">getAllowCreate</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to create any
|
|
underlying files, as necessary.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="BackupHandler.html" title="interface in com.sleepycat.db">BackupHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBackupHandler--">getBackupHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a>
|
|
used to override default hot backup behavior.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBackupReadCount--">getBackupReadCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the number of pages to read before pausing during the hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBackupReadSleep--">getBackupReadSleep</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the number of microseconds to sleep between batches of reads during
|
|
a hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBackupSize--">getBackupSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the size of the buffer, in megabytes, to read from the database
|
|
during a hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBackupWriteDirect--">getBackupWriteDirect</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return return true if direct I/O is used when writing pages to the disk
|
|
during a hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlobDir--">getBlobDir</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#getExternalFileDir--"><code>getExternalFileDir()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlobThreshold--">getBlobThreshold</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#getExternalFileThreshold--"><code>getExternalFileThreshold()</code></a>.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheCount--">getCacheCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the number of shared memory buffer pools, that is, the number
|
|
of cache regions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheMax--">getCacheMax</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum size of the cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCachePageSize--">getCachePageSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the environment's current page size setting.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheSize--">getCacheSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the size of the shared memory buffer pool, that is, the cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheTableSize--">getCacheTableSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the environment's current table size setting.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCDBLockAllDatabases--">getCDBLockAllDatabases</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCreateDir--">getCreateDir</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the path of a directory to be used as the location to create the
|
|
access method database files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code>java.io.File[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDataDirs--">getDataDirs</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the array of data directories.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirectDatabaseIO--">getDirectDatabaseIO</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment has been configured to not buffer
|
|
database files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirectLogIO--">getDirectLogIO</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment has been configured to not buffer
|
|
log files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDsyncDatabases--">getDsyncDatabases</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment has been configured to flush database
|
|
writes to the backing disk before returning from the write system call.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDsyncLog--">getDsyncLog</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment has been configured to flush log
|
|
writes to the backing disk before returning from the write system
|
|
call.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEncrypted--">getEncrypted</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment has been configured to perform
|
|
encryption.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorHandler--">getErrorHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the function to be called if an error occurs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorPrefix--">getErrorPrefix</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the prefix string that appears before error messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>java.io.OutputStream</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorStream--">getErrorStream</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the OutputStream for displaying error messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="EventHandler.html" title="interface in com.sleepycat.db">EventHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventHandler--">getEventHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the object's methods to be called when a triggered event occurs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExternalFileDir--">getExternalFileDir</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the path of a directory where external files are stored.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExternalFileThreshold--">getExternalFileThreshold</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the environment wide default external file threshold value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFeedbackHandler--">getFeedbackHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the object's methods to be called to provide feedback.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHotbackupInProgress--">getHotbackupInProgress</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if a "hot backup" is in progress.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitializeCache--">getInitializeCache</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured with a shared
|
|
memory buffer pool.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitializeCDB--">getInitializeCDB</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured for the Concurrent
|
|
Data Store product.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitializeLocking--">getInitializeLocking</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured for locking.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitializeLogging--">getInitializeLogging</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured for logging.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitializeRegions--">getInitializeRegions</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment has been configured to page-fault
|
|
shared regions into memory when initially creating or joining a
|
|
database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitializeReplication--">getInitializeReplication</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured for replication.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInitialMutexes--">getInitialMutexes</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the number of mutexes allocated when an environment is created.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i39" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJoinEnvironment--">getJoinEnvironment</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the handle is configured to join an existing environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i40" class="altColor">
|
|
<td class="colFirst"><code>byte[][]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockConflicts--">getLockConflicts</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the locking conflicts matrix.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i41" class="rowColor">
|
|
<td class="colFirst"><code><a href="LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockDetectMode--">getLockDetectMode</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the deadlock detector is configured to run whenever a lock
|
|
conflict occurs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i42" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockDown--">getLockDown</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to lock shared
|
|
environment files and memory-mapped databases into memory.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i43" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockPartitions--">getLockPartitions</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the number of lock table partitions in the Berkeley DB environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i44" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockTableSize--">getLockTableSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the lock hash table size.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i45" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockTimeout--">getLockTimeout</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment lock timeout value, in microseconds;
|
|
a timeout of 0 means no timeout is set.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i46" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogAutoRemove--">getLogAutoRemove</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to to automatically remove log
|
|
files that are no longer needed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i47" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogBlobContent--">getLogBlobContent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#getLogExternalFileContent--"><code>getLogExternalFileContent()</code></a>.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i48" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogBufferSize--">getLogBufferSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the size of the in-memory log buffer, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i49" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogDirectory--">getLogDirectory</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the path of a directory to be used as the location of logging files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i50" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogExternalFileContent--">getLogExternalFileContent</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if full logging of external file data is enabled.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i51" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogFileMode--">getLogFileMode</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the absolute file mode for created log files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i52" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogInMemory--">getLogInMemory</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to maintain transaction logs
|
|
in memory rather than on disk.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i53" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogNoSync--">getLogNoSync</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to avoid fsync() calls during
|
|
log files during flushes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i54" class="altColor">
|
|
<td class="colFirst"><code><a href="LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogRecordHandler--">getLogRecordHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the handler for application-specific log records.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i55" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogRegionSize--">getLogRegionSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the size of the underlying logging subsystem region.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i56" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogZero--">getLogZero</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to zero all pages of
|
|
new log files upon their creation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i57" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxLockers--">getMaxLockers</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum number of lockers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i58" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxLockObjects--">getMaxLockObjects</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum number of locked objects.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i59" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxLocks--">getMaxLocks</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum number of locks.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i60" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxLogFileSize--">getMaxLogFileSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum size of a single file in the log, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i61" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxMutexes--">getMaxMutexes</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the total number of mutexes allocated.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i62" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxOpenFiles--">getMaxOpenFiles</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum number of file descriptors that will be opened concurrently..</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i63" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxWrite--">getMaxWrite</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum number of sequential write operations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i64" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxWriteSleep--">getMaxWriteSleep</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the microseconds to pause before scheduling further write operations.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i65" class="rowColor">
|
|
<td class="colFirst"><code><a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageHandler--">getMessageHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the function to be called with an informational message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i66" class="altColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagePrefix--">getMessagePrefix</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the prefix string that appears before informational messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i67" class="rowColor">
|
|
<td class="colFirst"><code>java.io.OutputStream</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageStream--">getMessageStream</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the OutputStream for displaying informational messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i68" class="altColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMetadataDir--">getMetadataDir</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the path of a directory to be used as the location to store the
|
|
persistent metadata.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i69" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMMapSize--">getMMapSize</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i70" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMode--">getMode</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the mode to use when creating underlying files and shared
|
|
memory segments.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i71" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMultiversion--">getMultiversion</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the handle is configured to open all databases for multiversion
|
|
concurrency control.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i72" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMutexAlignment--">getMutexAlignment</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the mutex alignment, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i73" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMutexIncrement--">getMutexIncrement</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the number of additional mutexes to allocate.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i74" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMutexTestAndSetSpins--">getMutexTestAndSetSpins</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the test-and-set spin count.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i75" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNoLocking--">getNoLocking</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to grant all requested mutual
|
|
exclusion mutexes and database locks without regard for their actual
|
|
availability.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i76" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNoMMap--">getNoMMap</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i77" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNoPanic--">getNoPanic</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to ignore any panic state in
|
|
the database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i78" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOverwrite--">getOverwrite</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to overwrite files stored in
|
|
encrypted formats before deleting them.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i79" class="rowColor">
|
|
<td class="colFirst"><code><a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPanicHandler--">getPanicHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the function to be called if the database environment panics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i80" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrivate--">getPrivate</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to only be accessed
|
|
by a single process.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i81" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRegionDirectory--">getRegionDirectory</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the path of a directory to be used as the location of region files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i82" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRegionMemoryInitialSize-com.sleepycat.db.RegionResourceType-">getRegionMemoryInitialSize</a></span>​(<a href="RegionResourceType.html" title="class in com.sleepycat.db">RegionResourceType</a> resource)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the inital memory configuration for a region resource.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i83" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRegionMemoryMax--">getRegionMemoryMax</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the maximum amount of memory that can be used by shared structures
|
|
in the main environment region.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i84" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRegister--">getRegister</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the check for process failure when the environment is opened.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i85" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationClockskewFast--">getReplicationClockskewFast</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the current clock skew value for the fastest clock in the group of sites.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i86" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationClockskewSlow--">getReplicationClockskewSlow</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the current clock skew value for the slowest clock in the group of sites.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i87" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationInMemory--">getReplicationInMemory</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if internal replication information is stored in memory only.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i88" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationLimit--">getReplicationLimit</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the transmit limit in bytes for a single call to
|
|
<a href="Environment.html#processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-"><code>Environment.processReplicationMessage</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i89" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerAckPolicy--">getReplicationManagerAckPolicy</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the network Ack policy used by the replication manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i90" class="altColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerIncomingQueueMax--">getReplicationManagerIncomingQueueMax</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the maximum amount of dynamic memory used by the Replication Manager
|
|
incoming queue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i91" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationNumSites--">getReplicationNumSites</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the total number of sites configured in this EnvironmentConfig object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i92" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationPriority--">getReplicationPriority</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the current environment's priority.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i93" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationRequestMax--">getReplicationRequestMax</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the threshold for the maximum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i94" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationRequestMin--">getReplicationRequestMin</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the threshold for the minimum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i95" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationTransport--">getReplicationTransport</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the replication callback function used to transmit data using
|
|
the replication application's communication infrastructure.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i96" class="altColor">
|
|
<td class="colFirst"><code><a href="ReplicationViewHandler.html" title="interface in com.sleepycat.db">ReplicationViewHandler</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationViewHandler--">getReplicationViewHandler</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the function name used by replication views to determine whether
|
|
a database file is replicated to the local site.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i97" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunFatalRecovery--">getRunFatalRecovery</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the handle is configured to run catastrophic recovery on
|
|
the database environment before opening it for use.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i98" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunRecovery--">getRunRecovery</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the handle is configured to run normal recovery on the
|
|
database environment before opening it for use.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i99" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSegmentId--">getSegmentId</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the base segment ID.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i100" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSystemMemory--">getSystemMemory</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to allocate memory
|
|
from system shared memory instead of from memory backed by the
|
|
filesystem.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i101" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTemporaryDirectory--">getTemporaryDirectory</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the path of a directory to be used as the location of
|
|
temporary files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i102" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTestAndSetSpins--">getTestAndSetSpins</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getMutexTestAndSetSpins--"><code>getMutexTestAndSetSpins()</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i103" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getThreaded--">getThreaded</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the handle is configured to be <em>free-threaded</em>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i104" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactional--">getTransactional</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured for transactions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i105" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnMaxActive--">getTxnMaxActive</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the minimum number of simultaneously active transactions supported
|
|
by the database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i106" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnNoSync--">getTxnNoSync</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to not write or synchronously
|
|
flush the log on transaction commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i107" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnNoWait--">getTxnNoWait</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the transactions have been configured to not wait for locks by default.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i108" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnSnapshot--">getTxnSnapshot</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the handle is configured to run all transactions at snapshot
|
|
isolation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i109" class="rowColor">
|
|
<td class="colFirst"><code>long</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnTimeout--">getTxnTimeout</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment transaction timeout value, in
|
|
microseconds; a timeout of 0 means no timeout is set.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i110" class="altColor">
|
|
<td class="colFirst"><code>java.util.Date</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnTimestamp--">getTxnTimestamp</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the time to which recovery will be done, or 0 if recovery will
|
|
be done to the most current possible date.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i111" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTxnWriteNoSync--">getTxnWriteNoSync</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to write, but not synchronously
|
|
flush, the log on transaction commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i112" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUseEnvironment--">getUseEnvironment</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to accept information
|
|
from the process environment when naming files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i113" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUseEnvironmentRoot--">getUseEnvironmentRoot</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the database environment is configured to accept information
|
|
from the process environment when naming files if the process has
|
|
appropriate permissions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i114" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVerbose-com.sleepycat.db.VerboseConfig-">getVerbose</a></span>​(<a href="VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</a> flag)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return if the database environment is configured to display
|
|
a given type of verbose information.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i115" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVerboseDeadlock--">getVerboseDeadlock</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i116" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVerboseRecovery--">getVerboseRecovery</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i117" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVerboseRegister--">getVerboseRegister</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i118" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVerboseReplication--">getVerboseReplication</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i119" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVerboseWaitsFor--">getVerboseWaitsFor</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i120" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getYieldCPU--">getYieldCPU</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return true if the system has been configured to yield the processor
|
|
immediately after each page or mutex acquisition.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i121" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllowCreate-boolean-">setAllowCreate</a></span>​(boolean allowCreate)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to create any underlying files,
|
|
as necessary.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i122" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBackupHandler-com.sleepycat.db.BackupHandler-">setBackupHandler</a></span>​(<a href="BackupHandler.html" title="interface in com.sleepycat.db">BackupHandler</a> backupHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a>
|
|
interface to be used when performing hot backups.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i123" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBackupReadCount-int-">setBackupReadCount</a></span>​(int count)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configures the number of pages to read during a hot backup before pausing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i124" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBackupReadSleep-int-">setBackupReadSleep</a></span>​(int sleep)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configures the number of microseconds to sleep between batches of reads during
|
|
a hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i125" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBackupSize-int-">setBackupSize</a></span>​(int size)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configures the size of the buffer, in bytes, to read from the database
|
|
during a hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i126" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBackupWriteDirect-boolean-">setBackupWriteDirect</a></span>​(boolean writeDirect)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configures whether direct I/O is used when writing pages to the disk during a
|
|
hot backup.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i127" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBlobDir-java.io.File-">setBlobDir</a></span>​(java.io.File dir)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#setExternalFileDir-java.io.File-"><code>setExternalFileDir(java.io.File)</code></a>.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i128" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBlobThreshold-int-">setBlobThreshold</a></span>​(int value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#setExternalFileThreshold-int-"><code>setExternalFileThreshold(int)</code></a>.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i129" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheCount-int-">setCacheCount</a></span>​(int cacheCount)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the number of shared memory buffer pools, that is, the number of
|
|
caches.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i130" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheMax-long-">setCacheMax</a></span>​(long cacheMax)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum cache size in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i131" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCachePageSize-int-">setCachePageSize</a></span>​(int mpPageSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the page size used to allocate the hash table and the number of mutexes
|
|
expected to be needed by the buffer pool.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i132" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheSize-long-">setCacheSize</a></span>​(long cacheSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the size of the shared memory buffer pool, that is, the size of the
|
|
cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i133" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheTableSize-int-">setCacheTableSize</a></span>​(int mpTableSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Overrides the calculated hash table size.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i134" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCDBLockAllDatabases-boolean-">setCDBLockAllDatabases</a></span>​(boolean cdbLockAllDatabases)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure Concurrent Data Store applications to perform locking on
|
|
an environment-wide basis rather than on a per-database basis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i135" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCreateDir-java.io.File-">setCreateDir</a></span>​(java.io.File dir)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the path of a directory to be used as the location to create the
|
|
access method database files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i136" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDirectDatabaseIO-boolean-">setDirectDatabaseIO</a></span>​(boolean directDatabaseIO)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to not buffer database files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i137" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDirectLogIO-boolean-">setDirectLogIO</a></span>​(boolean directLogIO)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to not buffer log files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i138" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDsyncDatabases-boolean-">setDsyncDatabases</a></span>​(boolean dsyncDatabases)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i139" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDsyncLog-boolean-">setDsyncLog</a></span>​(boolean dsyncLog)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i140" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEncrypted-java.lang.String-">setEncrypted</a></span>​(java.lang.String password)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the password used to perform encryption and decryption.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i141" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setErrorHandler-com.sleepycat.db.ErrorHandler-">setErrorHandler</a></span>​(<a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a> errorHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the function to be called if an error occurs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i142" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setErrorPrefix-java.lang.String-">setErrorPrefix</a></span>​(java.lang.String errorPrefix)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the prefix string that appears before error messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i143" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setErrorStream-java.io.OutputStream-">setErrorStream</a></span>​(java.io.OutputStream errorStream)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set an OutputStream for displaying error messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i144" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEventHandler-com.sleepycat.db.EventHandler-">setEventHandler</a></span>​(<a href="EventHandler.html" title="interface in com.sleepycat.db">EventHandler</a> eventHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set an object whose methods are to be called when a triggered event occurs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i145" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExternalFileDir-java.io.File-">setExternalFileDir</a></span>​(java.io.File dir)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the path of a directory where external files are stored.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i146" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExternalFileThreshold-int-">setExternalFileThreshold</a></span>​(int value)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the default external file threshold for databases opened in this
|
|
environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i147" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFeedbackHandler-com.sleepycat.db.FeedbackHandler-">setFeedbackHandler</a></span>​(<a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a> feedbackHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set an object whose methods are called to provide feedback.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i148" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHotbackupInProgress-boolean-">setHotbackupInProgress</a></span>​(boolean hotbackup)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">When a "hot backup" copy of a database environment is taken, this
|
|
attribute should be configured in the environment prior to copying.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i149" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitializeCache-boolean-">setInitializeCache</a></span>​(boolean initializeCache)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure a shared memory buffer pool in the database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i150" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitializeCDB-boolean-">setInitializeCDB</a></span>​(boolean initializeCDB)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment for the Concurrent Data Store
|
|
product.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i151" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitializeLocking-boolean-">setInitializeLocking</a></span>​(boolean initializeLocking)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment for locking.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i152" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitializeLogging-boolean-">setInitializeLogging</a></span>​(boolean initializeLogging)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment for logging.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i153" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitializeRegions-boolean-">setInitializeRegions</a></span>​(boolean initializeRegions)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to page-fault shared regions into
|
|
memory when initially creating or joining a database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i154" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitializeReplication-boolean-">setInitializeReplication</a></span>​(boolean initializeReplication)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment for replication.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i155" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setInitialMutexes-int-">setInitialMutexes</a></span>​(int initMutexes)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the number of mutexes to allocate when an environment is created.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i156" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setJoinEnvironment-boolean-">setJoinEnvironment</a></span>​(boolean joinEnvironment)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the handle to join an existing environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i157" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockConflicts-byte:A:A-">setLockConflicts</a></span>​(byte[][] lockConflicts)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the locking conflicts matrix.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i158" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockDetectMode-com.sleepycat.db.LockDetectMode-">setLockDetectMode</a></span>​(<a href="LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> lockDetectMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure if the deadlock detector is to be run whenever a lock
|
|
conflict occurs.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i159" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockDown-boolean-">setLockDown</a></span>​(boolean lockDown)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to lock shared environment files
|
|
and memory-mapped databases into memory.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i160" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockPartitions-int-">setLockPartitions</a></span>​(int partitions)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the number of lock table partitions in the Berkeley DB environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i161" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockTableSize-int-">setLockTableSize</a></span>​(int lockTableSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the size for the hash table that contains references to locks.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i162" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockTimeout-long-">setLockTimeout</a></span>​(long lockTimeout)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the timeout value for the database environment
|
|
locks.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i163" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogAutoRemove-boolean-">setLogAutoRemove</a></span>​(boolean logAutoRemove)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to automatically remove log files that are no
|
|
longer needed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i164" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogBlobContent-boolean-">setLogBlobContent</a></span>​(boolean logExternalFileContent)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#setLogExternalFileContent-boolean-"><code>setLogExternalFileContent(boolean)</code></a>.</div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i165" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogBufferSize-int-">setLogBufferSize</a></span>​(int logBufferSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the size of the in-memory log buffer, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i166" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogDirectory-java.io.File-">setLogDirectory</a></span>​(java.io.File logDirectory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the path of a directory to be used as the location of logging files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i167" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogExternalFileContent-boolean-">setLogExternalFileContent</a></span>​(boolean logExternalFileContent)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Enable full logging of external file data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i168" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogFileMode-int-">setLogFileMode</a></span>​(int logFileMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the absolute file mode for created log files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i169" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogInMemory-boolean-">setLogInMemory</a></span>​(boolean logInMemory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If set, maintain transaction logs in memory rather than on disk.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i170" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogNoSync-boolean-">setLogNoSync</a></span>​(boolean logNoSync)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to avoid fsync() calls during log file flushes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i171" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogRecordHandler-com.sleepycat.db.LogRecordHandler-">setLogRecordHandler</a></span>​(<a href="LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</a> logRecordHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set a function to process application-specific log records.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i172" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogRegionSize-int-">setLogRegionSize</a></span>​(int logRegionSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the size of the underlying logging area of the database
|
|
environment, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i173" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogZero-boolean-">setLogZero</a></span>​(boolean logZero)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If set, zero all pages of a log file when that log file is created.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i174" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxLockers-int-">setMaxLockers</a></span>​(int maxLockers)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum number of locking entities supported by the database
|
|
environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i175" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxLockObjects-int-">setMaxLockObjects</a></span>​(int maxLockObjects)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum number of locked objects supported by the database
|
|
environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i176" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxLocks-int-">setMaxLocks</a></span>​(int maxLocks)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum number of locks supported by the database
|
|
environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i177" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxLogFileSize-int-">setMaxLogFileSize</a></span>​(int maxLogFileSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum size of a single file in the log, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i178" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxMutexes-int-">setMaxMutexes</a></span>​(int maxMutexes)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the total number of mutexes to allocate.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i179" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxOpenFiles-int-">setMaxOpenFiles</a></span>​(int maxOpenFiles)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Limit the number of file descriptors the library will open concurrently
|
|
when flushing dirty pages from the cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i180" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxWrite-int-long-">setMaxWrite</a></span>​(int maxWrite,
|
|
long maxWriteSleep)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Limit the number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i181" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageHandler-com.sleepycat.db.MessageHandler-">setMessageHandler</a></span>​(<a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a> messageHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set a function to be called with an informational message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i182" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessagePrefix-java.lang.String-">setMessagePrefix</a></span>​(java.lang.String messagePrefix)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the prefix string that appears before informational messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i183" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageStream-java.io.OutputStream-">setMessageStream</a></span>​(java.io.OutputStream messageStream)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set an OutputStream for displaying informational messages.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i184" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMetadataDir-java.io.File-">setMetadataDir</a></span>​(java.io.File dir)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the path of a directory to be used as the location to store the
|
|
persistent metadata files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i185" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMMapSize-long-">setMMapSize</a></span>​(long mmapSize)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i186" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMode-int-">setMode</a></span>​(int mode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to use a specific mode when
|
|
creating underlying files and shared memory segments.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i187" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMsgfile-java.io.File-">setMsgfile</a></span>​(java.io.File file)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the path of a file to store statistical information.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i188" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMultiversion-boolean-">setMultiversion</a></span>​(boolean multiversion)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to open all databases that are not
|
|
using the queue access method for multiversion concurrency control.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i189" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMutexAlignment-int-">setMutexAlignment</a></span>​(int mutexAlignment)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the mutex alignment, in bytes.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i190" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMutexIncrement-int-">setMutexIncrement</a></span>​(int mutexIncrement)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Increase the number of mutexes to allocate.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i191" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMutexTestAndSetSpins-int-">setMutexTestAndSetSpins</a></span>​(int mutexTestAndSetSpins)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specify the number of times that test-and-set mutexes should spin
|
|
without blocking.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i192" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNoLocking-boolean-">setNoLocking</a></span>​(boolean noLocking)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to grant all requested mutual exclusion mutexes
|
|
and database locks without regard for their actual availability.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i193" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNoMMap-boolean-">setNoMMap</a></span>​(boolean noMMap)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to copy read-only database files into the local
|
|
cache instead of potentially mapping them into process memory.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i194" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNoPanic-boolean-">setNoPanic</a></span>​(boolean noPanic)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to ignore any panic state in the database
|
|
environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i195" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOverwrite-boolean-">setOverwrite</a></span>​(boolean overwrite)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to overwrite files stored in encrypted formats
|
|
before deleting them.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i196" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPanicHandler-com.sleepycat.db.PanicHandler-">setPanicHandler</a></span>​(<a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a> panicHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the function to be called if the database environment panics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i197" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPrivate-boolean-">setPrivate</a></span>​(boolean isPrivate)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to only be accessed by a single
|
|
process (although that process may be multithreaded).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i198" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRegionDirectory-java.io.File-">setRegionDirectory</a></span>​(java.io.File regionDirectory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the path of a directory to be used as the location of region files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i199" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRegionMemoryInitialSize-com.sleepycat.db.RegionResourceType-int-">setRegionMemoryInitialSize</a></span>​(<a href="RegionResourceType.html" title="class in com.sleepycat.db">RegionResourceType</a> resource,
|
|
int count)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Assign an initial count for a particular resource within the shared region
|
|
of Berkeley DB.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i200" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRegionMemoryMax-long-">setRegionMemoryMax</a></span>​(long regionMemoryMax)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">This method sets the maximum amount of memory to be used by shared
|
|
structures in the main environment region.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i201" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRegister-boolean-">setRegister</a></span>​(boolean register)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Check if a process has failed while using the database environment, that
|
|
is, if a process has exited with an open <a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i202" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationClockskew-int-int-">setReplicationClockskew</a></span>​(int replicationClockskewFast,
|
|
int replicationClockskewSlow)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the clock skew ratio among replication group members based on the
|
|
fastest and slowest measurements among the group for use with master leases.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i203" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationInMemory-boolean-">setReplicationInMemory</a></span>​(boolean replicationInMemory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If set, store internal replication information in memory only.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i204" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationLimit-long-">setReplicationLimit</a></span>​(long replicationLimit)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Impose a byte-count limit on the amount of data that will be
|
|
transmitted from a site in a single call to <a href="Environment.html#processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-"><code>Environment.processReplicationMessage</code></a>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i205" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationManagerAckPolicy-com.sleepycat.db.ReplicationManagerAckPolicy-">setReplicationManagerAckPolicy</a></span>​(<a href="ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</a> repmgrAckPolicy)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the network Ack policy used by the replication manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i206" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationManagerIncomingQueueMax-long-">setReplicationManagerIncomingQueueMax</a></span>​(long repmgrIncomingQueueMax)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the maximum amount of dynamic memory used by the Replication Manager
|
|
incoming queue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i207" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationManagerSSLconfiguration-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">setReplicationManagerSSLconfiguration</a></span>​(java.lang.String repmgrCACert,
|
|
java.lang.String repmgrCADir,
|
|
java.lang.String repmgrNodeCert,
|
|
java.lang.String repmgrNodePKey,
|
|
java.lang.String repmgrPKeyPassword,
|
|
int repmgrVerifyDepth)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the ssl configuration used by the replication manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i208" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationManagerSSLdisabled-boolean-">setReplicationManagerSSLdisabled</a></span>​(boolean repmgrDisableSSL)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Enable or disable the SSL for Replication Manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i209" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationNumSites-int-">setReplicationNumSites</a></span>​(int replicationNumSites)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the total number of sites the replication group is configured for.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i210" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationPriority-int-">setReplicationPriority</a></span>​(int replicationPriority)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the current environment's priority.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i211" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationRequestMax-int-">setReplicationRequestMax</a></span>​(int replicationRequestMax)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set a threshold for the maximum time that a client waits before requesting
|
|
retransmission of a missing message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i212" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationRequestMin-int-">setReplicationRequestMin</a></span>​(int replicationRequestMin)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set a threshold for the minimum time that a client waits before requesting
|
|
retransmission of a missing message.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i213" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationTransport-int-com.sleepycat.db.ReplicationTransport-">setReplicationTransport</a></span>​(int envid,
|
|
<a href="ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</a> replicationTransport)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Initialize the communication infrastructure for a database environment
|
|
participating in a replicated application.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i214" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationView-com.sleepycat.db.ReplicationViewHandler-">setReplicationView</a></span>​(<a href="ReplicationViewHandler.html" title="interface in com.sleepycat.db">ReplicationViewHandler</a> repViewHandler)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the function to be used by replication views to determine whether a
|
|
database file is replicated to the local site.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i215" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRunFatalRecovery-boolean-">setRunFatalRecovery</a></span>​(boolean runFatalRecovery)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure to run catastrophic recovery on this environment before opening it for
|
|
normal use.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i216" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRunRecovery-boolean-">setRunRecovery</a></span>​(boolean runRecovery)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure to run normal recovery on this environment before opening it for
|
|
normal use.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i217" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSegmentId-long-">setSegmentId</a></span>​(long segmentId)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">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.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i218" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSystemMemory-boolean-">setSystemMemory</a></span>​(boolean systemMemory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to allocate memory from system
|
|
shared memory instead of from memory backed by the filesystem.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i219" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTemporaryDirectory-java.io.File-">setTemporaryDirectory</a></span>​(java.io.File temporaryDirectory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the path of a directory to be used as the location of temporary
|
|
files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i220" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTemporaryDirectory-java.lang.String-">setTemporaryDirectory</a></span>​(java.lang.String temporaryDirectory)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setTemporaryDirectory-java.io.File-"><code>setTemporaryDirectory(java.io.File)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i221" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTestAndSetSpins-int-">setTestAndSetSpins</a></span>​(int mutexTestAndSetSpins)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setMutexTestAndSetSpins-int-"><code>setMutexTestAndSetSpins(int)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i222" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setThreaded-boolean-">setThreaded</a></span>​(boolean threaded)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the handle to be <em>free-threaded</em>; that is, usable
|
|
by multiple threads within a single address space.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i223" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactional-boolean-">setTransactional</a></span>​(boolean transactional)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment for transactions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i224" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnMaxActive-int-">setTxnMaxActive</a></span>​(int txnMaxActive)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to support at least txnMaxActive
|
|
active transactions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i225" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnNoSync-boolean-">setTxnNoSync</a></span>​(boolean txnNoSync)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to not write or synchronously flush the log
|
|
on transaction commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i226" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnNoWait-boolean-">setTxnNoWait</a></span>​(boolean txnNoWait)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If a lock is unavailable for any Berkeley DB operation performed in the
|
|
context of a transaction, cause the operation to throw <a href="LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a> without waiting for the lock.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i227" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnSnapshot-boolean-">setTxnSnapshot</a></span>​(boolean txnSnapshot)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to run transactions at snapshot
|
|
isolation by default.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i228" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnTimeout-long-">setTxnTimeout</a></span>​(long txnTimeout)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the timeout value for the database environment
|
|
transactions.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i229" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnTimestamp-java.util.Date-">setTxnTimestamp</a></span>​(java.util.Date txnTimestamp)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Recover to the specified time rather than to the most current
|
|
possible date.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i230" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTxnWriteNoSync-boolean-">setTxnWriteNoSync</a></span>​(boolean txnWriteNoSync)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to write, but not synchronously flush, the log on
|
|
transaction commit.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i231" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUseEnvironment-boolean-">setUseEnvironment</a></span>​(boolean useEnvironment)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment to accept information from the
|
|
process environment when naming files, regardless of the status of
|
|
the process.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i232" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUseEnvironmentRoot-boolean-">setUseEnvironmentRoot</a></span>​(boolean useEnvironmentRoot)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">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).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i233" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-">setVerbose</a></span>​(<a href="VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</a> flag,
|
|
boolean enable)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Display verbose information.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i234" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVerboseDeadlock-boolean-">setVerboseDeadlock</a></span>​(boolean verboseDeadlock)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i235" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVerboseRecovery-boolean-">setVerboseRecovery</a></span>​(boolean verboseRecovery)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i236" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVerboseRegister-boolean-">setVerboseRegister</a></span>​(boolean verboseRegister)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i237" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVerboseReplication-boolean-">setVerboseReplication</a></span>​(boolean verboseReplication)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i238" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setVerboseWaitsFor-boolean-">setVerboseWaitsFor</a></span>​(boolean verboseWaitsFor)</code></th>
|
|
<td class="colLast">
|
|
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i239" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setYieldCPU-boolean-">setYieldCPU</a></span>​(boolean yieldCPU)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the system to yield the processor immediately after each
|
|
page or mutex acquisition.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="DEFAULT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>DEFAULT</h4>
|
|
<pre>public static final <a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> DEFAULT</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="EnvironmentConfig--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>EnvironmentConfig</h4>
|
|
<pre>public EnvironmentConfig()</pre>
|
|
<div class="block">Create an EnvironmentConfig initialized with the system default settings.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="setAllowCreate-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setAllowCreate</h4>
|
|
<pre class="methodSignature">public void setAllowCreate​(boolean allowCreate)</pre>
|
|
<div class="block">Configure the database environment to create any underlying files,
|
|
as necessary.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>allowCreate</code> - If true, configure the database environment to create any underlying
|
|
files, as necessary.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAllowCreate--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAllowCreate</h4>
|
|
<pre class="methodSignature">public boolean getAllowCreate()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to create any
|
|
underlying files, as necessary.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBlobDir-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBlobDir</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setBlobDir​(java.io.File dir)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#setExternalFileDir-java.io.File-"><code>setExternalFileDir(java.io.File)</code></a>.
|
|
<p></div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dir</code> - The path of a directory where external files are stored.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBlobDir--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBlobDir</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public java.io.File getBlobDir()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#getExternalFileDir--"><code>getExternalFileDir()</code></a>
|
|
<p></div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The path of a directory where external files are stored.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBlobThreshold-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBlobThreshold</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setBlobThreshold​(int value)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#setExternalFileThreshold-int-"><code>setExternalFileThreshold(int)</code></a>.</div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The size in bytes which is used to determine when a data item will
|
|
be stored as an external file. If 0, databases opened in the environment
|
|
will default to never using external files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBlobThreshold--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBlobThreshold</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public int getBlobThreshold()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#getExternalFileThreshold--"><code>getExternalFileThreshold()</code></a>.</div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The size in bytes which is used to determine when a data item will
|
|
be stored as an external file. If 0, databases opened in the environment
|
|
will default to never using external files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCacheSize-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCacheSize</h4>
|
|
<pre class="methodSignature">public void setCacheSize​(long cacheSize)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>cacheSize</code> - The size of the shared memory buffer pool, that is, the size of the
|
|
cache.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheSize</h4>
|
|
<pre class="methodSignature">public long getCacheSize()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The size of the shared memory buffer pool, that is, the cache.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCacheMax-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCacheMax</h4>
|
|
<pre class="methodSignature">public void setCacheMax​(long cacheMax)</pre>
|
|
<div class="block">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="#setCacheCount-int-"><code>setCacheCount(int)</code></a>. If no
|
|
value is specified, it defaults to the initial cache size.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>cacheMax</code> - the maximum size of the cache</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheMax--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheMax</h4>
|
|
<pre class="methodSignature">public long getCacheMax()</pre>
|
|
<div class="block">Return the maximum size of the cache.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum size of the cache.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCacheCount-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCacheCount</h4>
|
|
<pre class="methodSignature">public void setCacheCount​(int cacheCount)</pre>
|
|
<div class="block">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>
|
|
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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>cacheCount</code> - The number of shared memory buffer pools, that is, the number of caches.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheCount--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheCount</h4>
|
|
<pre class="methodSignature">public int getCacheCount()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of shared memory buffer pools, that is, the number
|
|
of cache regions.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCDBLockAllDatabases-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCDBLockAllDatabases</h4>
|
|
<pre class="methodSignature">public void setCDBLockAllDatabases​(boolean cdbLockAllDatabases)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCDBLockAllDatabases--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCDBLockAllDatabases</h4>
|
|
<pre class="methodSignature">public boolean getCDBLockAllDatabases()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCreateDir-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCreateDir</h4>
|
|
<pre class="methodSignature">public void setCreateDir​(java.io.File dir)</pre>
|
|
<div class="block">Set the path of a directory to be used as the location to create the
|
|
access method database files. When the open function is used to create a file
|
|
it will be created relative to this path. Note that this path must first be
|
|
added by <a href="#addDataDir-java.io.File-"><code>java.io.File</code></a></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dir</code> - the path of a directory to be used as the location to create
|
|
the access method database files</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCreateDir--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCreateDir</h4>
|
|
<pre class="methodSignature">public java.io.File getCreateDir()</pre>
|
|
<div class="block">Return the path of a directory to be used as the location to create the
|
|
access method database files.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The path of a directory to be used as the location to create the access method
|
|
database files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addDataDir-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addDataDir</h4>
|
|
<pre class="methodSignature">public void addDataDir​(java.io.File dataDir)</pre>
|
|
<div class="block">Add the path of a directory to be used as the location of the access method database files.
|
|
<p>
|
|
Paths specified to <a href="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="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. Call <a href="#setCreateDir-java.io.File-"><code>java.io.File</code></a>
|
|
to set the directory where access method database files will be created.
|
|
<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 configured using the environment's
|
|
DB_CONFIG file. The syntax of the entry in that file is a single line
|
|
with the string "add_data_dir", one or more whitespace characters, and the directory name.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dataDir</code> - the path to a directory to be used as the location of
|
|
the access method database files
|
|
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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addDataDir-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addDataDir</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void addDataDir​(java.lang.String dataDir)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#addDataDir-java.io.File-"><code>addDataDir(java.io.File)</code></a></div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dataDir</code> - the data directory</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDataDirs--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDataDirs</h4>
|
|
<pre class="methodSignature">public java.io.File[] getDataDirs()</pre>
|
|
<div class="block">Return the array of data directories.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The array of data directories.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setDirectDatabaseIO-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDirectDatabaseIO</h4>
|
|
<pre class="methodSignature">public void setDirectDatabaseIO​(boolean directDatabaseIO)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>directDatabaseIO</code> - If true, configure the database environment to not buffer database files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDirectDatabaseIO--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDirectDatabaseIO</h4>
|
|
<pre class="methodSignature">public boolean getDirectDatabaseIO()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment has been configured to not buffer
|
|
database files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setDirectLogIO-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDirectLogIO</h4>
|
|
<pre class="methodSignature">public void setDirectLogIO​(boolean directLogIO)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>directLogIO</code> - If true, configure the database environment to not buffer log files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDirectLogIO--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDirectLogIO</h4>
|
|
<pre class="methodSignature">public boolean getDirectLogIO()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment has been configured to not buffer
|
|
log files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setDsyncDatabases-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDsyncDatabases</h4>
|
|
<pre class="methodSignature">public void setDsyncDatabases​(boolean dsyncDatabases)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDsyncDatabases--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDsyncDatabases</h4>
|
|
<pre class="methodSignature">public boolean getDsyncDatabases()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment has been configured to flush database
|
|
writes to the backing disk before returning from the write system call.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setDsyncLog-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setDsyncLog</h4>
|
|
<pre class="methodSignature">public void setDsyncLog​(boolean dsyncLog)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDsyncLog--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDsyncLog</h4>
|
|
<pre class="methodSignature">public boolean getDsyncLog()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment has been configured to flush log
|
|
writes to the backing disk before returning from the write system
|
|
call.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setEncrypted-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setEncrypted</h4>
|
|
<pre class="methodSignature">public void setEncrypted​(java.lang.String password)</pre>
|
|
<div class="block">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.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>password</code> - the password used to perform encryption and decryption</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEncrypted--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEncrypted</h4>
|
|
<pre class="methodSignature">public boolean getEncrypted()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment has been configured to perform
|
|
encryption.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setErrorHandler-com.sleepycat.db.ErrorHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setErrorHandler</h4>
|
|
<pre class="methodSignature">public void setErrorHandler​(<a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a> errorHandler)</pre>
|
|
<div class="block">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="#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>EnvironmentConfig.setErrorHandler</code></a> and <a href="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="#setErrorStream-java.io.OutputStream-"><code>EnvironmentConfig.setErrorStream</code></a> and <a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>errorHandler</code> - The function to be called if an error occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getErrorHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getErrorHandler</h4>
|
|
<pre class="methodSignature">public <a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a> getErrorHandler()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The function to be called if an error occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setErrorPrefix-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setErrorPrefix</h4>
|
|
<pre class="methodSignature">public void setErrorPrefix​(java.lang.String errorPrefix)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>errorPrefix</code> - The prefix string that appears before error messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getErrorPrefix--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getErrorPrefix</h4>
|
|
<pre class="methodSignature">public java.lang.String getErrorPrefix()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The prefix string that appears before error messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setErrorStream-java.io.OutputStream-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setErrorStream</h4>
|
|
<pre class="methodSignature">public void setErrorStream​(java.io.OutputStream errorStream)</pre>
|
|
<div class="block">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="#setErrorStream-java.io.OutputStream-"><code>EnvironmentConfig.setErrorStream</code></a> and
|
|
<a href="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="#setErrorPrefix-java.lang.String-"><code>EnvironmentConfig.setErrorPrefix</code></a> or <a href="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="#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>EnvironmentConfig.setErrorHandler</code></a> and <a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>errorStream</code> - The application-specified OutputStream for error messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getErrorStream--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getErrorStream</h4>
|
|
<pre class="methodSignature">public java.io.OutputStream getErrorStream()</pre>
|
|
<div class="block">Return the OutputStream for displaying error messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The OutputStream for displaying error messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setExternalFileDir-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setExternalFileDir</h4>
|
|
<pre class="methodSignature">public void setExternalFileDir​(java.io.File dir)</pre>
|
|
<div class="block">Sets the path of a directory where external files are stored.
|
|
<p>
|
|
The external files of each <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> opened
|
|
within this <a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> are
|
|
stored under this directory.
|
|
<p>
|
|
This path can not be set after opening the environment.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dir</code> - The path of a directory where external files are stored.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getExternalFileDir--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getExternalFileDir</h4>
|
|
<pre class="methodSignature">public java.io.File getExternalFileDir()</pre>
|
|
<div class="block">Returns the path of a directory where external files are stored.
|
|
<p>
|
|
The external files of each <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> opened
|
|
within this <a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> are
|
|
stored under this directory.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The path of a directory where external files are stored.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setExternalFileThreshold-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setExternalFileThreshold</h4>
|
|
<pre class="methodSignature">public void setExternalFileThreshold​(int value)</pre>
|
|
<div class="block">Set the default external file threshold for databases opened in this
|
|
environment. The external file threshold is the size in bytes which is
|
|
used to determine when a data item will be stored as an external file.
|
|
<p>
|
|
Any data item that is equal to or larger in size than the
|
|
threshold value will automatically be stored as an external file.
|
|
<p>
|
|
It is illegal to enable external files in the environment if any of
|
|
<a href="#setTxnSnapshot-boolean-"><code>EnvironmentConfig.setTxnSnapshot</code></a>,
|
|
and <a href="#setMultiversion-boolean-"><code>EnvironmentConfig.setMultiversion</code></a>
|
|
is called with true value.
|
|
<p>
|
|
This threshold value can be set any time before and after opening the
|
|
environment.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The size in bytes which is used to determine when a data item will
|
|
be stored as an external file. If 0, databases opened in the environment
|
|
will default to never using external files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getExternalFileThreshold--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getExternalFileThreshold</h4>
|
|
<pre class="methodSignature">public int getExternalFileThreshold()</pre>
|
|
<div class="block">Return the environment wide default external file threshold value. The
|
|
external file threshold is the size in bytes which is used to determine
|
|
when a record will be stored as an external file.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The external file threshold value in bytes beyond which data items are
|
|
stored as external files. If 0, databases opened in the environment will
|
|
default to never using external files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBackupReadCount--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBackupReadCount</h4>
|
|
<pre class="methodSignature">public int getBackupReadCount()</pre>
|
|
<div class="block">Return the number of pages to read before pausing during the hot backup.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of pages to read before pausing.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBackupReadCount-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBackupReadCount</h4>
|
|
<pre class="methodSignature">public void setBackupReadCount​(int count)</pre>
|
|
<div class="block">Configures the number of pages to read during a hot backup before pausing.
|
|
<p>
|
|
Increasing this value increases the amount of I/O the backup process
|
|
performs for any given time interval. If your application is already
|
|
heavily I/O bound, setting this value to a lower number may help to improve
|
|
your overall data throughput by reducing the I/O demands placed on your
|
|
system. By default, all pages are read without a pause.
|
|
<p>
|
|
This method configures the behavior of the
|
|
<a href="Environment.html#backup-java.lang.String-com.sleepycat.db.BackupOptions-"><code>Environment.backup</code></a>
|
|
and
|
|
<a href="Environment.html#backupDatabase-java.lang.String-java.lang.String-boolean-"><code>Environment.backupDatabase</code></a>
|
|
methods. It may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>count</code> - The number of pages to read before pausing.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBackupReadSleep--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBackupReadSleep</h4>
|
|
<pre class="methodSignature">public int getBackupReadSleep()</pre>
|
|
<div class="block">Return the number of microseconds to sleep between batches of reads during
|
|
a hot backup.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of microseconds to sleep.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBackupReadSleep-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBackupReadSleep</h4>
|
|
<pre class="methodSignature">public void setBackupReadSleep​(int sleep)</pre>
|
|
<div class="block">Configures the number of microseconds to sleep between batches of reads during
|
|
a hot backup.
|
|
<p>
|
|
Increasing this value decreases the amount of I/O the backup process
|
|
performs for any given time interval. If your application is already
|
|
heavily I/O bound, setting this value to a higher number may help to
|
|
improve your overall data throughput by reducing the I/O demands placed on
|
|
your system.
|
|
<p>
|
|
This method configures the behavior of the
|
|
<a href="Environment.html#backup-java.lang.String-com.sleepycat.db.BackupOptions-"><code>Environment.backup</code></a>
|
|
and
|
|
<a href="Environment.html#backupDatabase-java.lang.String-java.lang.String-boolean-"><code>Environment.backupDatabase</code></a>
|
|
methods. It may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>sleep</code> - The number of microseconds to sleep.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBackupSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBackupSize</h4>
|
|
<pre class="methodSignature">public int getBackupSize()</pre>
|
|
<div class="block">Return the size of the buffer, in megabytes, to read from the database
|
|
during a hot backup.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The size of the buffer in megabytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBackupSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBackupSize</h4>
|
|
<pre class="methodSignature">public void setBackupSize​(int size)</pre>
|
|
<div class="block">Configures the size of the buffer, in bytes, to read from the database
|
|
during a hot backup.
|
|
<p>
|
|
This method configures the behavior of the
|
|
<a href="Environment.html#backup-java.lang.String-com.sleepycat.db.BackupOptions-"><code>Environment.backup</code></a>
|
|
and
|
|
<a href="Environment.html#backupDatabase-java.lang.String-java.lang.String-boolean-"><code>Environment.backupDatabase</code></a>
|
|
methods. It may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>size</code> - The size of the buffer in bytes. Default is 1 megabyte.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBackupWriteDirect--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBackupWriteDirect</h4>
|
|
<pre class="methodSignature">public boolean getBackupWriteDirect()</pre>
|
|
<div class="block">Return return true if direct I/O is used when writing pages to the disk
|
|
during a hot backup.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The environment's current direct I/O for hot backup setting.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBackupWriteDirect-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBackupWriteDirect</h4>
|
|
<pre class="methodSignature">public void setBackupWriteDirect​(boolean writeDirect)</pre>
|
|
<div class="block">Configures whether direct I/O is used when writing pages to the disk during a
|
|
hot backup.
|
|
<p>
|
|
For some environments, direct I/O can provide faster write throughput, but
|
|
usually it is slower because the OS buffer pool offers asynchronous
|
|
activity.
|
|
<p>
|
|
This method configures the behavior of the
|
|
<a href="Environment.html#backup-java.lang.String-com.sleepycat.db.BackupOptions-"><code>Environment.backup</code></a>
|
|
and
|
|
<a href="Environment.html#backupDatabase-java.lang.String-java.lang.String-boolean-"><code>Environment.backupDatabase</code></a>
|
|
methods. It may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>writeDirect</code> - If true, use direct I/O when writing database pages; if false, do not use
|
|
direct I/O.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setBackupHandler-com.sleepycat.db.BackupHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setBackupHandler</h4>
|
|
<pre class="methodSignature">public void setBackupHandler​(<a href="BackupHandler.html" title="interface in com.sleepycat.db">BackupHandler</a> backupHandler)</pre>
|
|
<div class="block">Sets the <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a>
|
|
interface to be used when performing hot backups.
|
|
<p>
|
|
The <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> interface is used
|
|
to override the default behavior used by the
|
|
<a href="Environment.html#backup-java.lang.String-com.sleepycat.db.BackupOptions-"><code>Environment.backup</code></a>
|
|
and
|
|
<a href="Environment.html#backupDatabase-java.lang.String-java.lang.String-boolean-"><code>Environment.backupDatabase</code></a>
|
|
methods.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
This method configures operations performed using the Environment handle,
|
|
not all operations performed on the underlying database environment.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>backupHandler</code> - The <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a>
|
|
interface to use when performing hot backups.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getBackupHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getBackupHandler</h4>
|
|
<pre class="methodSignature">public <a href="BackupHandler.html" title="interface in com.sleepycat.db">BackupHandler</a> getBackupHandler()</pre>
|
|
<div class="block">Return the <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a>
|
|
used to override default hot backup behavior.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The <a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a>
|
|
interface to use when performing hot backups.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setEventHandler-com.sleepycat.db.EventHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setEventHandler</h4>
|
|
<pre class="methodSignature">public void setEventHandler​(<a href="EventHandler.html" title="interface in com.sleepycat.db">EventHandler</a> eventHandler)</pre>
|
|
<div class="block">Set an object whose methods are to be called when a triggered event occurs.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>eventHandler</code> - An object whose methods are called when event callbacks are initiated from
|
|
within Berkeley DB.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getEventHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getEventHandler</h4>
|
|
<pre class="methodSignature">public <a href="EventHandler.html" title="interface in com.sleepycat.db">EventHandler</a> getEventHandler()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The object's methods to be called when a triggered event occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setFeedbackHandler-com.sleepycat.db.FeedbackHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setFeedbackHandler</h4>
|
|
<pre class="methodSignature">public void setFeedbackHandler​(<a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a> feedbackHandler)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>feedbackHandler</code> - An object whose methods are called to provide feedback.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFeedbackHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFeedbackHandler</h4>
|
|
<pre class="methodSignature">public <a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a> getFeedbackHandler()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The object's methods to be called to provide feedback.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setHotbackupInProgress-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setHotbackupInProgress</h4>
|
|
<pre class="methodSignature">public void setHotbackupInProgress​(boolean hotbackup)</pre>
|
|
<div class="block">When a "hot backup" copy of a database environment is taken, this
|
|
attribute should be configured in the environment prior to copying.
|
|
If any transactions with the bulk insert optimization enabled (i.e.,
|
|
started with the Bulk configuration attribute) are in progress,
|
|
setting the HotBackupInProgress attribute will force a checkpoint in
|
|
the environment. After this attribute is set, the bulk insert
|
|
optimization is disabled, until the attribute is reset. Using this
|
|
protocol allows a hot backup procedure to make a consistent copy of
|
|
the database even when bulk transactions are ongoing. Please see the
|
|
discussion of hot backups in the <i>Getting Started With Transactions
|
|
Guide</i>, and the description of the Bulk attribute in
|
|
<a href="TransactionConfig.html" title="class in com.sleepycat.db"><code>TransactionConfig</code></a>
|
|
for more information.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>hotbackup</code> - If true, set the HotBackupInProgress attribute; if false, reset it.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getHotbackupInProgress--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHotbackupInProgress</h4>
|
|
<pre class="methodSignature">public boolean getHotbackupInProgress()</pre>
|
|
<div class="block">Return true if a "hot backup" is in progress.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The environment's current HotBackupInProgress setting.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitializeCache-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitializeCache</h4>
|
|
<pre class="methodSignature">public void setInitializeCache​(boolean initializeCache)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>initializeCache</code> - If true, configure a shared memory buffer pool in the database
|
|
environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitializeCache--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitializeCache</h4>
|
|
<pre class="methodSignature">public boolean getInitializeCache()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured with a shared
|
|
memory buffer pool.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitializeCDB-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitializeCDB</h4>
|
|
<pre class="methodSignature">public void setInitializeCDB​(boolean initializeCDB)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>initializeCDB</code> - If true, configure the database environment for the Concurrent Data
|
|
Store product.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitializeCDB--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitializeCDB</h4>
|
|
<pre class="methodSignature">public boolean getInitializeCDB()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured for the Concurrent
|
|
Data Store product.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitializeLocking-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitializeLocking</h4>
|
|
<pre class="methodSignature">public void setInitializeLocking​(boolean initializeLocking)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>initializeLocking</code> - If true, configure the database environment for locking.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitializeLocking--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitializeLocking</h4>
|
|
<pre class="methodSignature">public boolean getInitializeLocking()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured for locking.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitializeLogging-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitializeLogging</h4>
|
|
<pre class="methodSignature">public void setInitializeLogging​(boolean initializeLogging)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>initializeLogging</code> - If true, configure the database environment for logging.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitializeLogging--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitializeLogging</h4>
|
|
<pre class="methodSignature">public boolean getInitializeLogging()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured for logging.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitializeRegions-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitializeRegions</h4>
|
|
<pre class="methodSignature">public void setInitializeRegions​(boolean initializeRegions)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitializeRegions--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitializeRegions</h4>
|
|
<pre class="methodSignature">public boolean getInitializeRegions()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment has been configured to page-fault
|
|
shared regions into memory when initially creating or joining a
|
|
database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitializeReplication-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitializeReplication</h4>
|
|
<pre class="methodSignature">public void setInitializeReplication​(boolean initializeReplication)</pre>
|
|
<div class="block">Configure the database environment for replication.
|
|
<p>
|
|
Replication requires both locking and transactions.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>initializeReplication</code> - If true, configure the database environment for replication.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitializeReplication--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitializeReplication</h4>
|
|
<pre class="methodSignature">public boolean getInitializeReplication()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured for replication.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setJoinEnvironment-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setJoinEnvironment</h4>
|
|
<pre class="methodSignature">public void setJoinEnvironment​(boolean joinEnvironment)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>joinEnvironment</code> - If true, configure the handle to join an existing environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getJoinEnvironment--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getJoinEnvironment</h4>
|
|
<pre class="methodSignature">public boolean getJoinEnvironment()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The handle is configured to join an existing environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockConflicts-byte:A:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockConflicts</h4>
|
|
<pre class="methodSignature">public void setLockConflicts​(byte[][] lockConflicts)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockConflicts--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockConflicts</h4>
|
|
<pre class="methodSignature">public byte[][] getLockConflicts()</pre>
|
|
<div class="block">Return the locking conflicts matrix.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The locking conflicts matrix.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockDetectMode-com.sleepycat.db.LockDetectMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockDetectMode</h4>
|
|
<pre class="methodSignature">public void setLockDetectMode​(<a href="LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> lockDetectMode)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockDetectMode--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockDetectMode</h4>
|
|
<pre class="methodSignature">public <a href="LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> getLockDetectMode()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the deadlock detector is configured to run whenever a lock
|
|
conflict occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockDown-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockDown</h4>
|
|
<pre class="methodSignature">public void setLockDown​(boolean lockDown)</pre>
|
|
<div class="block">Configure the database environment to lock shared environment files
|
|
and memory-mapped databases into memory.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>lockDown</code> - If true, configure the database environment to lock shared
|
|
environment files and memory-mapped databases into memory.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockDown--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockDown</h4>
|
|
<pre class="methodSignature">public boolean getLockDown()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to lock shared
|
|
environment files and memory-mapped databases into memory.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockTimeout-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockTimeout</h4>
|
|
<pre class="methodSignature">public void setLockTimeout​(long lockTimeout)</pre>
|
|
<div class="block">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="Environment.html#lockVector-int-boolean-com.sleepycat.db.LockRequest:A-"><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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockTimeout--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockTimeout</h4>
|
|
<pre class="methodSignature">public long getLockTimeout()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment lock timeout value, in microseconds;
|
|
a timeout of 0 means no timeout is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogAutoRemove-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogAutoRemove</h4>
|
|
<pre class="methodSignature">public void setLogAutoRemove​(boolean logAutoRemove)</pre>
|
|
<div class="block">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>
|
|
Replication Manager applications operate in a group-aware manner for log file
|
|
removal, and automatic log file removal simplifies the application.
|
|
<p>
|
|
Replication Base API applications will rarely want to configure automatic log
|
|
file removal as it increases the likelihood a master will be unable to
|
|
satisfy a client's request for a recent log record.
|
|
<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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logAutoRemove</code> - If true, configure the system to automatically remove log files that
|
|
are no longer needed.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogAutoRemove--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogAutoRemove</h4>
|
|
<pre class="methodSignature">public boolean getLogAutoRemove()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to to automatically remove log
|
|
files that are no longer needed.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogBlobContent-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogBlobContent</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setLogBlobContent​(boolean logExternalFileContent)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#setLogExternalFileContent-boolean-"><code>setLogExternalFileContent(boolean)</code></a>.
|
|
<p></div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logExternalFileContent</code> - If true, enable full logging of external file data.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogBlobContent--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogBlobContent</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public boolean getLogBlobContent()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">Replaced with <a href="#getLogExternalFileContent--"><code>getLogExternalFileContent()</code></a>.
|
|
<p></div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if full logging of external file data is enabled.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogExternalFileContent-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogExternalFileContent</h4>
|
|
<pre class="methodSignature">public void setLogExternalFileContent​(boolean logExternalFileContent)</pre>
|
|
<div class="block">Enable full logging of external file data. Required for HA and the
|
|
hotbackup utility.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logExternalFileContent</code> - If true, enable full logging of external file data.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogExternalFileContent--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogExternalFileContent</h4>
|
|
<pre class="methodSignature">public boolean getLogExternalFileContent()</pre>
|
|
<div class="block">Return true if full logging of external file data is enabled.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if full logging of external file data is enabled.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogInMemory-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogInMemory</h4>
|
|
<pre class="methodSignature">public void setLogInMemory​(boolean logInMemory)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logInMemory</code> - If true, maintain transaction logs in memory rather than on disk.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogInMemory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogInMemory</h4>
|
|
<pre class="methodSignature">public boolean getLogInMemory()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to maintain transaction logs
|
|
in memory rather than on disk.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogNoSync-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogNoSync</h4>
|
|
<pre class="methodSignature">public void setLogNoSync​(boolean logNoSync)</pre>
|
|
<div class="block">Configure the system to avoid fsync() calls during log file flushes.
|
|
<p>
|
|
Log nosync is only safe when recovery is not needed after a system crash.
|
|
If the system remains alive and the application crashes, the database will
|
|
be recoverable in that situation.
|
|
<p>
|
|
This method may not be called after the environment has been opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logNoSync</code> - If true, configure the system to avoid fsync() calls during log file flushes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogNoSync--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogNoSync</h4>
|
|
<pre class="methodSignature">public boolean getLogNoSync()</pre>
|
|
<div class="block">Return true if the system has been configured to avoid fsync() calls during
|
|
log files during flushes.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to avoid fsync() calls during log
|
|
files flushes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogRecordHandler-com.sleepycat.db.LogRecordHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogRecordHandler</h4>
|
|
<pre class="methodSignature">public void setLogRecordHandler​(<a href="LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</a> logRecordHandler)</pre>
|
|
<div class="block">Set a function to process application-specific log records.
|
|
<p>
|
|
This method configures only operations performed using a single a
|
|
<a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logRecordHandler</code> - The handler for application-specific log records.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogRecordHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogRecordHandler</h4>
|
|
<pre class="methodSignature">public <a href="LogRecordHandler.html" title="interface in com.sleepycat.db">LogRecordHandler</a> getLogRecordHandler()</pre>
|
|
<div class="block">Return the handler for application-specific log records.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The handler for application-specific log records.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogZero-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogZero</h4>
|
|
<pre class="methodSignature">public void setLogZero​(boolean logZero)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logZero</code> - If true, zero all pages of new log files upon their creation.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogZero--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogZero</h4>
|
|
<pre class="methodSignature">public boolean getLogZero()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to pre-zero log pages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRegionMemoryInitialSize-com.sleepycat.db.RegionResourceType-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRegionMemoryInitialSize</h4>
|
|
<pre class="methodSignature">public int getRegionMemoryInitialSize​(<a href="RegionResourceType.html" title="class in com.sleepycat.db">RegionResourceType</a> resource)</pre>
|
|
<div class="block">Return the inital memory configuration for a region resource.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>resource</code> - The resource type to get initial sizing for.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The initial amount of memory allocated for the requested resource.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRegionMemoryInitialSize-com.sleepycat.db.RegionResourceType-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRegionMemoryInitialSize</h4>
|
|
<pre class="methodSignature">public void setRegionMemoryInitialSize​(<a href="RegionResourceType.html" title="class in com.sleepycat.db">RegionResourceType</a> resource,
|
|
int count)</pre>
|
|
<div class="block">Assign an initial count for a particular resource within the shared region
|
|
of Berkeley DB. The shared region is used to hold resources that are
|
|
shared amongst processes in Berkeley DB.
|
|
The default values are generally satisfactory.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>resource</code> - The resource type to configure.</dd>
|
|
<dd><code>count</code> - The initial number of objects of a particular type to allocate.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRegionMemoryMax--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRegionMemoryMax</h4>
|
|
<pre class="methodSignature">public long getRegionMemoryMax()</pre>
|
|
<div class="block">Return the maximum amount of memory that can be used by shared structures
|
|
in the main environment region.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum amount of memory that could be used by the main region.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRegionMemoryMax-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRegionMemoryMax</h4>
|
|
<pre class="methodSignature">public void setRegionMemoryMax​(long regionMemoryMax)</pre>
|
|
<div class="block">This method sets the maximum amount of memory to be used by shared
|
|
structures in the main environment region. These are the structures
|
|
other than mutexes and the page cache (memory pool). If the region files
|
|
are in memory mapped files, or if DB_PRIVATE is specified, the memory
|
|
specified by this method is not allocated completely at startup. As
|
|
memory is needed, the shared region will be extended or, in the case of
|
|
DB_PRIVATE, more memory will be allocated using the system malloc call.
|
|
For memory mapped files, a mapped region will be allocated to this size
|
|
but the underlying file will only be allocated sufficient memory to hold
|
|
the initial allocation of shared memory structures as set by
|
|
<a href="#setRegionMemoryInitialSize-com.sleepycat.db.RegionResourceType-int-"><code>EnvironmentConfig.setRegionMemoryInitialSize</code></a>.
|
|
<p>
|
|
If no memory maximum is specified then it is calculated from defaults,
|
|
initial settings or (deprecated) maximum settings of the various shared
|
|
structures. In the case of environments created with DB_PRIVATE, no
|
|
maximum need be set and the shared structure allocation will grow as
|
|
needed until the process memory limit is exhausted.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>regionMemoryMax</code> - The total amount of memory that can be used by the main region.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationInMemory-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationInMemory</h4>
|
|
<pre class="methodSignature">public void setReplicationInMemory​(boolean replicationInMemory)</pre>
|
|
<div class="block">If set, store internal replication information in memory only. By default,
|
|
replication creates files in the environment home directory to preserve
|
|
some internal information. If this configuration flag is turned on,
|
|
replication only stores this internal information in-memory and cannot
|
|
keep persistent state across a site crash or reboot.
|
|
<p>
|
|
This configuration flag can only be turned on before the environment is
|
|
opened. Its value cannot be changed while the environment is open.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationInMemory</code> - If true, store internal replication information in memory only.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationInMemory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationInMemory</h4>
|
|
<pre class="methodSignature">public boolean getReplicationInMemory()</pre>
|
|
<div class="block">Return true if internal replication information is stored in memory only.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if internal replication information is stored in memory only.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationManagerAckPolicy-com.sleepycat.db.ReplicationManagerAckPolicy-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationManagerAckPolicy</h4>
|
|
<pre class="methodSignature">public void setReplicationManagerAckPolicy​(<a href="ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</a> repmgrAckPolicy)</pre>
|
|
<div class="block">Set the network Ack policy used by the replication manager.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>repmgrAckPolicy</code> - The network Ack policy used by the replication manager.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationManagerSSLdisabled-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationManagerSSLdisabled</h4>
|
|
<pre class="methodSignature">public void setReplicationManagerSSLdisabled​(boolean repmgrDisableSSL)</pre>
|
|
<div class="block">Enable or disable the SSL for Replication Manager.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>repmgrDisableSSL</code> - True if SSL is to be disabled for replication manager.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationManagerSSLconfiguration-java.lang.String-java.lang.String-java.lang.String-java.lang.String-java.lang.String-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationManagerSSLconfiguration</h4>
|
|
<pre class="methodSignature">public void setReplicationManagerSSLconfiguration​(java.lang.String repmgrCACert,
|
|
java.lang.String repmgrCADir,
|
|
java.lang.String repmgrNodeCert,
|
|
java.lang.String repmgrNodePKey,
|
|
java.lang.String repmgrPKeyPassword,
|
|
int repmgrVerifyDepth)</pre>
|
|
<div class="block">Set the ssl configuration used by the replication manager.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>repmgrCACert</code> - The path to CA certificate used by replication manager.</dd>
|
|
<dd><code>repmgrCADir</code> - The path to directory containing all CA certificates.
|
|
(root/intermedicate CA)</dd>
|
|
<dd><code>repmgrNodeCert</code> - The path to SSL certificate used for autheticating this node.</dd>
|
|
<dd><code>repmgrNodePKey</code> - The path to private key file for this node.</dd>
|
|
<dd><code>repmgrPKeyPassword</code> - The password for the private key file.</dd>
|
|
<dd><code>repmgrVerifyDepth</code> - The depth of ssl verification in case of intermediary CA's.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerAckPolicy--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerAckPolicy</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationManagerAckPolicy.html" title="class in com.sleepycat.db">ReplicationManagerAckPolicy</a> getReplicationManagerAckPolicy()</pre>
|
|
<div class="block">Get the network Ack policy used by the replication manager.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The network Ack policy used by the replication manager.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationManagerIncomingQueueMax-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationManagerIncomingQueueMax</h4>
|
|
<pre class="methodSignature">public void setReplicationManagerIncomingQueueMax​(long repmgrIncomingQueueMax)</pre>
|
|
<div class="block">Set the maximum amount of dynamic memory used by the Replication Manager
|
|
incoming queue.
|
|
<p>
|
|
By default, the Replication Manager incoming queue size has a limit of 100MB.
|
|
If zero is specified, then the Replication Manager incoming queue size is
|
|
limited by available heap memory.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>repmgrIncomingQueueMax</code> - The maximum amount of dynamic memory used by the Replication Manager incoming queue.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerIncomingQueueMax--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerIncomingQueueMax</h4>
|
|
<pre class="methodSignature">public long getReplicationManagerIncomingQueueMax()</pre>
|
|
<div class="block">Get the maximum amount of dynamic memory used by the Replication Manager
|
|
incoming queue.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum amount of dynamic memory used by the Replication Manager incoming queue.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="addReplicationManagerSite-com.sleepycat.db.ReplicationManagerSiteConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>addReplicationManagerSite</h4>
|
|
<pre class="methodSignature">public void addReplicationManagerSite​(<a href="ReplicationManagerSiteConfig.html" title="class in com.sleepycat.db">ReplicationManagerSiteConfig</a> repmgrSiteConfig)</pre>
|
|
<div class="block">Configure a site in a replication group. This could be called more than once,
|
|
to set local site and remote sites.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>repmgrSiteConfig</code> - The configuration of a site site</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockPartitions-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockPartitions</h4>
|
|
<pre class="methodSignature">public void setLockPartitions​(int partitions)</pre>
|
|
<div class="block">Set the number of lock table partitions in the Berkeley DB environment.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>partitions</code> - the number of lock table partitions</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockPartitions--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockPartitions</h4>
|
|
<pre class="methodSignature">public int getLockPartitions()</pre>
|
|
<div class="block">Returns the number of lock table partitions in the Berkeley DB environment.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the number of lock table partitions</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxLocks-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxLocks</h4>
|
|
<pre class="methodSignature">public void setMaxLocks​(int maxLocks)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxLocks</code> - The maximum number of locks supported by the database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxLocks--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxLocks</h4>
|
|
<pre class="methodSignature">public int getMaxLocks()</pre>
|
|
<div class="block">Return the maximum number of locks.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum number of locks.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockTableSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockTableSize</h4>
|
|
<pre class="methodSignature">public void setLockTableSize​(int lockTableSize)</pre>
|
|
<div class="block">Set the size for the hash table that contains references to locks. It's
|
|
important to make this large enough so that there is not increased
|
|
contention in the system as it grows.
|
|
<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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>lockTableSize</code> - The size of the hash table to allocate.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockTableSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockTableSize</h4>
|
|
<pre class="methodSignature">public int getLockTableSize()</pre>
|
|
<div class="block">Return the lock hash table size.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The lock hash table size.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxLockers-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxLockers</h4>
|
|
<pre class="methodSignature">public void setMaxLockers​(int maxLockers)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxLockers</code> - The maximum number simultaneous locking entities supported by the
|
|
database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxLockers--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxLockers</h4>
|
|
<pre class="methodSignature">public int getMaxLockers()</pre>
|
|
<div class="block">Return the maximum number of lockers.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum number of lockers.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxLockObjects-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxLockObjects</h4>
|
|
<pre class="methodSignature">public void setMaxLockObjects​(int maxLockObjects)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxLockObjects</code> - The maximum number of locked objects supported by the database
|
|
environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxLockObjects--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxLockObjects</h4>
|
|
<pre class="methodSignature">public int getMaxLockObjects()</pre>
|
|
<div class="block">Return the maximum number of locked objects.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum number of locked objects.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxLogFileSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxLogFileSize</h4>
|
|
<pre class="methodSignature">public void setMaxLogFileSize​(int maxLogFileSize)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxLogFileSize</code> - The maximum size of a single file in the log, in bytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxLogFileSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxLogFileSize</h4>
|
|
<pre class="methodSignature">public int getMaxLogFileSize()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum size of a single file in the log, in bytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogBufferSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogBufferSize</h4>
|
|
<pre class="methodSignature">public void setLogBufferSize​(int logBufferSize)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logBufferSize</code> - The size of the in-memory log buffer, in bytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogBufferSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogBufferSize</h4>
|
|
<pre class="methodSignature">public int getLogBufferSize()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The size of the in-memory log buffer, in bytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogDirectory-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogDirectory</h4>
|
|
<pre class="methodSignature">public void setLogDirectory​(java.io.File logDirectory)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogDirectory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogDirectory</h4>
|
|
<pre class="methodSignature">public java.io.File getLogDirectory()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The path of a directory to be used as the location of logging files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogFileMode-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogFileMode</h4>
|
|
<pre class="methodSignature">public void setLogFileMode​(int logFileMode)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logFileMode</code> - The absolute mode of the created log file.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogFileMode--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogFileMode</h4>
|
|
<pre class="methodSignature">public int getLogFileMode()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The absolute file mode for created log files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLogRegionSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLogRegionSize</h4>
|
|
<pre class="methodSignature">public void setLogRegionSize​(int logRegionSize)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logRegionSize</code> - The size of the logging area in the database environment, in bytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogRegionSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogRegionSize</h4>
|
|
<pre class="methodSignature">public int getLogRegionSize()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The size of the underlying logging subsystem region.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxOpenFiles-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxOpenFiles</h4>
|
|
<pre class="methodSignature">public void setMaxOpenFiles​(int maxOpenFiles)</pre>
|
|
<div class="block">Limit the number of file descriptors the library will open concurrently
|
|
when flushing dirty pages from the cache.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxOpenFiles--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxOpenFiles</h4>
|
|
<pre class="methodSignature">public int getMaxOpenFiles()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum number of file descriptors that will be opened concurrently..</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxWrite-int-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxWrite</h4>
|
|
<pre class="methodSignature">public void setMaxWrite​(int maxWrite,
|
|
long maxWriteSleep)</pre>
|
|
<div class="block">Limit the number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxWrite</code> - The maximum number of sequential write operations scheduled by the
|
|
library when flushing dirty pages from the cache.</dd>
|
|
<dd><code>maxWriteSleep</code> - The number of microseconds the thread of control should pause before
|
|
scheduling further write operations.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxWrite--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxWrite</h4>
|
|
<pre class="methodSignature">public int getMaxWrite()</pre>
|
|
<div class="block">Return the maximum number of sequential write operations.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum number of sequential write operations.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxWriteSleep--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxWriteSleep</h4>
|
|
<pre class="methodSignature">public long getMaxWriteSleep()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The microseconds to pause before scheduling further write operations.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMessageHandler-com.sleepycat.db.MessageHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMessageHandler</h4>
|
|
<pre class="methodSignature">public void setMessageHandler​(<a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a> messageHandler)</pre>
|
|
<div class="block">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="#setVerboseDeadlock-boolean-"><code>EnvironmentConfig.setVerboseDeadlock</code></a> for example.
|
|
<p>
|
|
The <a href="#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>EnvironmentConfig.setMessageHandler</code></a> and
|
|
<a href="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="#setMessageStream-java.io.OutputStream-"><code>EnvironmentConfig.setMessageStream</code></a>
|
|
and <a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>messageHandler</code> - The application-specified function for informational messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMessageHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMessageHandler</h4>
|
|
<pre class="methodSignature">public <a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a> getMessageHandler()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The function to be called with an informational message.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMessagePrefix-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMessagePrefix</h4>
|
|
<pre class="methodSignature">public void setMessagePrefix​(java.lang.String messagePrefix)</pre>
|
|
<div class="block">Set the prefix string that appears before informational messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>messagePrefix</code> - The prefix string that appears before informational messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMessagePrefix--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMessagePrefix</h4>
|
|
<pre class="methodSignature">public java.lang.String getMessagePrefix()</pre>
|
|
<div class="block">Return the prefix string that appears before informational messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The prefix string that appears before informational messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMessageStream-java.io.OutputStream-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMessageStream</h4>
|
|
<pre class="methodSignature">public void setMessageStream​(java.io.OutputStream messageStream)</pre>
|
|
<div class="block">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="#setVerboseDeadlock-boolean-"><code>EnvironmentConfig.setVerboseDeadlock</code></a> for example.
|
|
<p>
|
|
The <a href="#setMessageStream-java.io.OutputStream-"><code>EnvironmentConfig.setMessageStream</code></a> and
|
|
<a href="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>
|
|
The informational message will consist of the prefix string and a colon
|
|
("<b>:</b>") (if a prefix string was previously specified using
|
|
<a href="#setMessagePrefix-java.lang.String-"><code>EnvironmentConfig.setMessagePrefix</code></a> or <a href="DatabaseConfig.html#setMessagePrefix-java.lang.String-"><code>DatabaseConfig.setMessagePrefix</code></a>), an informational string, and a trailing newline character.
|
|
<p>
|
|
Setting messageStream to null unconfigures the interface.
|
|
<p>
|
|
Alternatively, you can use <a href="#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>EnvironmentConfig.setMessageHandler</code></a>
|
|
and <a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>messageStream</code> - The application-specified OutputStream for informational messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMessageStream--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMessageStream</h4>
|
|
<pre class="methodSignature">public java.io.OutputStream getMessageStream()</pre>
|
|
<div class="block">Return the OutputStream for displaying informational messages.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The an OutputStream for displaying informational messages.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMetadataDir-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMetadataDir</h4>
|
|
<pre class="methodSignature">public void setMetadataDir​(java.io.File dir)</pre>
|
|
<div class="block">Set the path of a directory to be used as the location to store the
|
|
persistent metadata files.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dir</code> - The path of metadata directory.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMetadataDir--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMetadataDir</h4>
|
|
<pre class="methodSignature">public java.io.File getMetadataDir()</pre>
|
|
<div class="block">Return the path of a directory to be used as the location to store the
|
|
persistent metadata.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The the path of metadata directory.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMMapSize-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMMapSize</h4>
|
|
<pre class="methodSignature">public void setMMapSize​(long mmapSize)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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="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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMMapSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMMapSize</h4>
|
|
<pre class="methodSignature">public long getMMapSize()</pre>
|
|
<div class="block">Return the maximum file size, in bytes, for a file to be mapped into
|
|
the process address space.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The maximum file size, in bytes, for a file to be mapped into the
|
|
process address space.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMsgfile-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMsgfile</h4>
|
|
<pre class="methodSignature">public void setMsgfile​(java.io.File file)</pre>
|
|
<div class="block">Sets the path of a file to store statistical information.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>file</code> - The path of a file to store statistical information.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCachePageSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCachePageSize</h4>
|
|
<pre class="methodSignature">public void setCachePageSize​(int mpPageSize)</pre>
|
|
<div class="block">Sets the page size used to allocate the hash table and the number of mutexes
|
|
expected to be needed by the buffer pool.
|
|
<p>
|
|
This method may be called only before the environment is opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mpPageSize</code> - The expected page size to use. Generally, it is set to the expected average
|
|
page size for all the data pages that are in the buffer pool.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCachePageSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCachePageSize</h4>
|
|
<pre class="methodSignature">public int getCachePageSize()</pre>
|
|
<div class="block">Returns the environment's current page size setting.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The current setting for the environment's expected page size use.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setCacheTableSize-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setCacheTableSize</h4>
|
|
<pre class="methodSignature">public void setCacheTableSize​(int mpTableSize)</pre>
|
|
<div class="block">Overrides the calculated hash table size.
|
|
<p>
|
|
The table size is then adjusted to a nearby prime number to enhance the
|
|
hashing algorithm.
|
|
<p>
|
|
This method may be called only before the environment is opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mpTableSize</code> - Specifies the size of the buffer pool hash table, which is then internally
|
|
adjusted to a nearby prime number.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheTableSize--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheTableSize</h4>
|
|
<pre class="methodSignature">public int getCacheTableSize()</pre>
|
|
<div class="block">Returns the environment's current table size setting.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The current setting for the environment's table size.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMode-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMode</h4>
|
|
<pre class="methodSignature">public void setMode​(int mode)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mode</code> - The mode to use when creating underlying files and shared memory
|
|
segments.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMode--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMode</h4>
|
|
<pre class="methodSignature">public long getMode()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The mode to use when creating underlying files and shared
|
|
memory segments.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMultiversion-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMultiversion</h4>
|
|
<pre class="methodSignature">public void setMultiversion​(boolean multiversion)</pre>
|
|
<div class="block">Configure the database environment to open all databases that are not
|
|
using the queue access method for multiversion concurrency control.
|
|
See <a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>multiversion</code> - If true, all databases that are not using the queue access method will be
|
|
opened for multiversion concurrency control.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMultiversion--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMultiversion</h4>
|
|
<pre class="methodSignature">public boolean getMultiversion()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the handle is configured to open all databases for multiversion
|
|
concurrency control.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setNoLocking-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setNoLocking</h4>
|
|
<pre class="methodSignature">public void setNoLocking​(boolean noLocking)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNoLocking--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNoLocking</h4>
|
|
<pre class="methodSignature">public boolean getNoLocking()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to grant all requested mutual
|
|
exclusion mutexes and database locks without regard for their actual
|
|
availability.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setNoMMap-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setNoMMap</h4>
|
|
<pre class="methodSignature">public void setNoMMap​(boolean noMMap)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNoMMap--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNoMMap</h4>
|
|
<pre class="methodSignature">public boolean getNoMMap()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setNoPanic-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setNoPanic</h4>
|
|
<pre class="methodSignature">public void setNoPanic​(boolean noPanic)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>noPanic</code> - If true, configure the system to ignore any panic state in the
|
|
database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNoPanic--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNoPanic</h4>
|
|
<pre class="methodSignature">public boolean getNoPanic()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to ignore any panic state in
|
|
the database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setOverwrite-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setOverwrite</h4>
|
|
<pre class="methodSignature">public void setOverwrite​(boolean overwrite)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>overwrite</code> - If true, configure the system to overwrite files stored in encrypted
|
|
formats before deleting them.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getOverwrite--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getOverwrite</h4>
|
|
<pre class="methodSignature">public boolean getOverwrite()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to overwrite files stored in
|
|
encrypted formats before deleting them.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setPanicHandler-com.sleepycat.db.PanicHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPanicHandler</h4>
|
|
<pre class="methodSignature">public void setPanicHandler​(<a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a> panicHandler)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>panicHandler</code> - The function to be called if the database environment panics.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPanicHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPanicHandler</h4>
|
|
<pre class="methodSignature">public <a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a> getPanicHandler()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The function to be called if the database environment panics.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRegionDirectory-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRegionDirectory</h4>
|
|
<pre class="methodSignature">public void setRegionDirectory​(java.io.File regionDirectory)</pre>
|
|
<div class="block">Set the path of a directory to be used as the location of region files.
|
|
<p>
|
|
Region files created by Berkeley DB will be created in this
|
|
directory. If no region directory is specified, regioin files are
|
|
created in the environment home directory.
|
|
<p>
|
|
The database environment's region 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_region_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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>regionDirectory</code> - The directory used to store the region files.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRegionDirectory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRegionDirectory</h4>
|
|
<pre class="methodSignature">public java.io.File getRegionDirectory()</pre>
|
|
<div class="block">Return the path of a directory to be used as the location of region files.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The path of a directory to be used as the location of region files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationView-com.sleepycat.db.ReplicationViewHandler-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationView</h4>
|
|
<pre class="methodSignature">public void setReplicationView​(<a href="ReplicationViewHandler.html" title="interface in com.sleepycat.db">ReplicationViewHandler</a> repViewHandler)</pre>
|
|
<div class="block">Set the function to be used by replication views to determine whether a
|
|
database file is replicated to the local site.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>repViewHandler</code> - The function name to determine whether a database file is replicated. If
|
|
null, the replication view is a full view and all database files are
|
|
replicated to the local site. Otherwise it is a partial view and only some
|
|
database files are replicated to the local site.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationViewHandler--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationViewHandler</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationViewHandler.html" title="interface in com.sleepycat.db">ReplicationViewHandler</a> getReplicationViewHandler()</pre>
|
|
<div class="block">Return the function name used by replication views to determine whether
|
|
a database file is replicated to the local site.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The function name used by replication views to determine whether a database
|
|
file is replicated to the local site. If null, the replication view is a
|
|
full view and all database files are replicated to the local site.
|
|
Otherwise it is a partial view and only some database files are replicated
|
|
to the local site.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setPrivate-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPrivate</h4>
|
|
<pre class="methodSignature">public void setPrivate​(boolean isPrivate)</pre>
|
|
<div class="block">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>
|
|
Use of this flag means that multiple handles cannot be simultaneously
|
|
opened for the environment, even within the same process. For example,
|
|
if both a server application and a Berkeley DB utility are expected to
|
|
access the environment at the same time, then do not configure the
|
|
database environment as private.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>isPrivate</code> - If true, configure the database environment to only be accessed by
|
|
a single process.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrivate--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrivate</h4>
|
|
<pre class="methodSignature">public boolean getPrivate()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to only be accessed
|
|
by a single process.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationClockskew-int-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationClockskew</h4>
|
|
<pre class="methodSignature">public void setReplicationClockskew​(int replicationClockskewFast,
|
|
int replicationClockskewSlow)</pre>
|
|
<div class="block">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="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="Environment.html#setReplicationTimeout-com.sleepycat.db.ReplicationTimeoutType-int-"><code>Environment.setReplicationTimeout(com.sleepycat.db.ReplicationTimeoutType, int)</code></a> method and, if using the base
|
|
replication API, 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="../../../../programmer_reference/rep_clock_skew.html">Clock skew</a>.
|
|
For a description of master leases, see
|
|
<a href="../../../../programmer_reference/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="../../../../programmer_reference/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="../../../../programmer_reference/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="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle.
|
|
<p>
|
|
This method may not be called after the <a href="Environment.html#replicationManagerStart-int-com.sleepycat.db.ReplicationManagerStartPolicy-"><code>Environment.replicationManagerStart(int, com.sleepycat.db.ReplicationManagerStartPolicy)</code></a> or <a href="Environment.html#startReplication-com.sleepycat.db.DatabaseEntry-boolean-"><code>Environment.startReplication(com.sleepycat.db.DatabaseEntry, boolean)</code></a> methods are called.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationClockskewFast</code> - The value, relative to the <code>replicationClockskewSlow</code>, of the fastest clock in the group of sites.</dd>
|
|
<dd><code>replicationClockskewSlow</code> - The value of the slowest clock in the group of sites.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationClockskewFast--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationClockskewFast</h4>
|
|
<pre class="methodSignature">public int getReplicationClockskewFast()</pre>
|
|
<div class="block">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.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The current clock skew value for the fastest clock in the group of sites.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationClockskewSlow--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationClockskewSlow</h4>
|
|
<pre class="methodSignature">public int getReplicationClockskewSlow()</pre>
|
|
<div class="block">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.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The current clock skew value for the slowest clock in the group of sites.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationLimit-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationLimit</h4>
|
|
<pre class="methodSignature">public void setReplicationLimit​(long replicationLimit)</pre>
|
|
<div class="block">Impose a byte-count limit on the amount of data that will be
|
|
transmitted from a site in a single call to <a href="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationLimit</code> - The maximum number of bytes that will be sent in a single call to
|
|
<a href="Environment.html#processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-"><code>Environment.processReplicationMessage</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationLimit--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationLimit</h4>
|
|
<pre class="methodSignature">public long getReplicationLimit()</pre>
|
|
<div class="block">Return the transmit limit in bytes for a single call to
|
|
<a href="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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The transmit limit in bytes for a single call to <a href="Environment.html#processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-"><code>Environment.processReplicationMessage</code></a>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationRequestMin-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationRequestMin</h4>
|
|
<pre class="methodSignature">public void setReplicationRequestMin​(int replicationRequestMin)</pre>
|
|
<div class="block">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="#setReplicationRequestMax-int-"><code>setReplicationRequestMax(int)</code></a>.
|
|
<p>
|
|
These values are thresholds only. Replication Manager applications use these
|
|
values to determine when to automatically request retransmission of missing
|
|
messages. For Base API applications, 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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationRequestMin</code> - The minimum amount of time the client waits before requesting retransmission
|
|
of a missing message.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationRequestMin--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationRequestMin</h4>
|
|
<pre class="methodSignature">public int getReplicationRequestMin()</pre>
|
|
<div class="block">Get the threshold for the minimum amount of time that a client waits before
|
|
requesting retransmission of a missed message.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The threshold for the minimum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationRequestMax-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationRequestMax</h4>
|
|
<pre class="methodSignature">public void setReplicationRequestMax​(int replicationRequestMax)</pre>
|
|
<div class="block">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="#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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationRequestMax</code> - The maximum amount of time the client waits before requesting retransmission
|
|
of a missing message.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationRequestMax--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationRequestMax</h4>
|
|
<pre class="methodSignature">public int getReplicationRequestMax()</pre>
|
|
<div class="block">Get the threshold for the maximum amount of time that a client waits before
|
|
requesting retransmission of a missed message.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The threshold for the maximum amount of time that a client waits before
|
|
requesting retransmission of a missed message.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationTransport-int-com.sleepycat.db.ReplicationTransport-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationTransport</h4>
|
|
<pre class="methodSignature">public void setReplicationTransport​(int envid,
|
|
<a href="ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</a> replicationTransport)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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>
|
|
<dd><code>replicationTransport</code> - The callback function is used to transmit data using the replication
|
|
application's communication infrastructure.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationTransport--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationTransport</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationTransport.html" title="interface in com.sleepycat.db">ReplicationTransport</a> getReplicationTransport()</pre>
|
|
<div class="block">Return the replication callback function used to transmit data using
|
|
the replication application's communication infrastructure.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The replication callback function used to transmit data using the
|
|
replication application's communication infrastructure.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRegister-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRegister</h4>
|
|
<pre class="methodSignature">public void setRegister​(boolean register)</pre>
|
|
<div class="block">Check if a process has failed while using the database environment, that
|
|
is, if a process has exited with an open <a href="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="#setRunRecovery-boolean-"><code>setRunRecovery(boolean)</code></a> or
|
|
<a href="#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="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="../../../../programmer_reference/transapp_app.html" target="_top">Architecting
|
|
Transactional Data Store applications</a>) for more information.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>register</code> - If true, check for process failure when the environment is opened.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRegister--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRegister</h4>
|
|
<pre class="methodSignature">public boolean getRegister()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the check for process failure when the environment is opened.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRunFatalRecovery-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRunFatalRecovery</h4>
|
|
<pre class="methodSignature">public void setRunFatalRecovery​(boolean runFatalRecovery)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>runFatalRecovery</code> - If true, configure to run catastrophic recovery on this environment
|
|
before opening it for normal use.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRunFatalRecovery--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRunFatalRecovery</h4>
|
|
<pre class="methodSignature">public boolean getRunFatalRecovery()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The handle is configured to run catastrophic recovery on
|
|
the database environment before opening it for use.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setRunRecovery-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setRunRecovery</h4>
|
|
<pre class="methodSignature">public void setRunRecovery​(boolean runRecovery)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>runRecovery</code> - If true, configure to run normal recovery on this environment
|
|
before opening it for normal use.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRunRecovery--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRunRecovery</h4>
|
|
<pre class="methodSignature">public boolean getRunRecovery()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The handle is configured to run normal recovery on the
|
|
database environment before opening it for use.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setSystemMemory-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setSystemMemory</h4>
|
|
<pre class="methodSignature">public void setSystemMemory​(boolean systemMemory)</pre>
|
|
<div class="block">Configure the database environment to allocate memory from system
|
|
shared memory instead of from memory backed by the filesystem.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSystemMemory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSystemMemory</h4>
|
|
<pre class="methodSignature">public boolean getSystemMemory()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to allocate memory
|
|
from system shared memory instead of from memory backed by the
|
|
filesystem.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setSegmentId-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setSegmentId</h4>
|
|
<pre class="methodSignature">public void setSegmentId​(long segmentId)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>segmentId</code> - The base segment ID for the database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSegmentId--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSegmentId</h4>
|
|
<pre class="methodSignature">public long getSegmentId()</pre>
|
|
<div class="block">Return the base segment ID.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The base segment ID.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTemporaryDirectory-java.io.File-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTemporaryDirectory</h4>
|
|
<pre class="methodSignature">public void setTemporaryDirectory​(java.io.File temporaryDirectory)</pre>
|
|
<div class="block">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="#setUseEnvironment-boolean-"><code>EnvironmentConfig.setUseEnvironment</code></a> or
|
|
<a href="#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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTemporaryDirectory-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTemporaryDirectory</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setTemporaryDirectory​(java.lang.String temporaryDirectory)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setTemporaryDirectory-java.io.File-"><code>setTemporaryDirectory(java.io.File)</code></a></div>
|
|
</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>temporaryDirectory</code> - the temporary directory</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTemporaryDirectory--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTemporaryDirectory</h4>
|
|
<pre class="methodSignature">public java.io.File getTemporaryDirectory()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The path of a directory to be used as the location of
|
|
temporary files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMutexAlignment-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMutexAlignment</h4>
|
|
<pre class="methodSignature">public void setMutexAlignment​(int mutexAlignment)</pre>
|
|
<div class="block">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="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.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mutexAlignment</code> - mutex alignment, in bytes. The mutex alignment must be a power-of-two.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMutexAlignment--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMutexAlignment</h4>
|
|
<pre class="methodSignature">public int getMutexAlignment()</pre>
|
|
<div class="block">Return the mutex alignment, in bytes.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The mutex alignment, in bytes.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMutexIncrement-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMutexIncrement</h4>
|
|
<pre class="methodSignature">public void setMutexIncrement​(int mutexIncrement)</pre>
|
|
<div class="block">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="#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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mutexIncrement</code> - The number of additional mutexes to allocate.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMutexIncrement--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMutexIncrement</h4>
|
|
<pre class="methodSignature">public int getMutexIncrement()</pre>
|
|
<div class="block">Return the number of additional mutexes to allocate.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of additional mutexes to allocate.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setInitialMutexes-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setInitialMutexes</h4>
|
|
<pre class="methodSignature">public void setInitialMutexes​(int initMutexes)</pre>
|
|
<div class="block">Set the number of mutexes to allocate when an environment is created.
|
|
<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 initial
|
|
mutexes to allocate.
|
|
<p>
|
|
Calling this method discards any value previously
|
|
set using the <a href="#setInitialMutexes-int-"><code>setInitialMutexes(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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>initMutexes</code> - The number of mutexes allocated when an environment is created.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getInitialMutexes--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getInitialMutexes</h4>
|
|
<pre class="methodSignature">public int getInitialMutexes()</pre>
|
|
<div class="block">Return the number of mutexes allocated when an environment is created.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of mutexes allocated when an environment is created.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMaxMutexes-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMaxMutexes</h4>
|
|
<pre class="methodSignature">public void setMaxMutexes​(int maxMutexes)</pre>
|
|
<div class="block">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="#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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>maxMutexes</code> - The absolute number of mutexes to allocate.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMaxMutexes--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMaxMutexes</h4>
|
|
<pre class="methodSignature">public int getMaxMutexes()</pre>
|
|
<div class="block">Return the total number of mutexes allocated.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The total number of mutexes allocated.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMutexTestAndSetSpins-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMutexTestAndSetSpins</h4>
|
|
<pre class="methodSignature">public void setMutexTestAndSetSpins​(int mutexTestAndSetSpins)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mutexTestAndSetSpins</code> - The number of spins test-and-set mutexes should execute before blocking.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMutexTestAndSetSpins--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMutexTestAndSetSpins</h4>
|
|
<pre class="methodSignature">public int getMutexTestAndSetSpins()</pre>
|
|
<div class="block">Return the test-and-set spin count.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The test-and-set spin count.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationNumSites-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationNumSites</h4>
|
|
<pre class="methodSignature">public void setReplicationNumSites​(int replicationNumSites)</pre>
|
|
<div class="block">Set the total number of sites the replication group is configured for.
|
|
<p>
|
|
This method cannot be called by replication manager applications.
|
|
<p>
|
|
Note that this value is not automatically populated via a call to
|
|
<a href="Environment.html#getConfig--"><code>Environment.getConfig()</code></a>, explicit initialization is required for all objects.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationNumSites</code> - The total number of sites in the replication group.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationNumSites--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationNumSites</h4>
|
|
<pre class="methodSignature">public int getReplicationNumSites()</pre>
|
|
<div class="block">Get the total number of sites configured in this EnvironmentConfig object.
|
|
<p>
|
|
This method cannot be called by replication manager applications.
|
|
<p>
|
|
Note that most applications will be looking for the <a href="Environment.html#getReplicationNumSites--"><code>Environment.getReplicationNumSites()</code></a> method
|
|
which returns the number of sites in the replication group as defined by
|
|
the underlying environment object.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The total number of sites configured in the EnvironmentConfig object.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationPriority-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationPriority</h4>
|
|
<pre class="methodSignature">public void setReplicationPriority​(int replicationPriority)</pre>
|
|
<div class="block">Set the current environment's priority. Priority is used to determine
|
|
which replicated site will be selected as master when an election occurs.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>replicationPriority</code> - The database environment priority.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationPriority--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationPriority</h4>
|
|
<pre class="methodSignature">public int getReplicationPriority()</pre>
|
|
<div class="block">Get the current environment's priority. Priority is used to determine
|
|
which replicated site will be selected as master when an election occurs.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment priority.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTestAndSetSpins-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTestAndSetSpins</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setTestAndSetSpins​(int mutexTestAndSetSpins)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setMutexTestAndSetSpins-int-"><code>setMutexTestAndSetSpins(int)</code></a></div>
|
|
</div>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mutexTestAndSetSpins</code> - The number of times test-and-set mutexes should spin before blocking.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTestAndSetSpins--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTestAndSetSpins</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public int getTestAndSetSpins()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getMutexTestAndSetSpins--"><code>getMutexTestAndSetSpins()</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of times test-and-set mutexes should spin before
|
|
blocking.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setThreaded-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setThreaded</h4>
|
|
<pre class="methodSignature">public void setThreaded​(boolean threaded)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>threaded</code> - If true, configure the handle to be <em>free-threaded</em>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getThreaded--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getThreaded</h4>
|
|
<pre class="methodSignature">public boolean getThreaded()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the handle is configured to be <em>free-threaded</em>.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTransactional-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTransactional</h4>
|
|
<pre class="methodSignature">public void setTransactional​(boolean transactional)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>transactional</code> - If true, configure the database environment for transactions.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTransactional--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTransactional</h4>
|
|
<pre class="methodSignature">public boolean getTransactional()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured for transactions.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnNoSync-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnNoSync</h4>
|
|
<pre class="methodSignature">public void setTxnNoSync​(boolean txnNoSync)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txnNoSync</code> - If true, configure the system to not write or synchronously flush
|
|
the log on transaction commit.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnNoSync--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnNoSync</h4>
|
|
<pre class="methodSignature">public boolean getTxnNoSync()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to not write or synchronously
|
|
flush the log on transaction commit.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnNoWait-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnNoWait</h4>
|
|
<pre class="methodSignature">public void setTxnNoWait​(boolean txnNoWait)</pre>
|
|
<div class="block">If a lock is unavailable for any Berkeley DB operation performed in the
|
|
context of a transaction, cause the operation to throw <a href="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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txnNoWait</code> - If true, configure transactions to not wait for locks by default.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnNoWait--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnNoWait</h4>
|
|
<pre class="methodSignature">public boolean getTxnNoWait()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the transactions have been configured to not wait for locks by default.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnSnapshot-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnSnapshot</h4>
|
|
<pre class="methodSignature">public void setTxnSnapshot​(boolean txnSnapshot)</pre>
|
|
<div class="block">Configure the database environment to run transactions at snapshot
|
|
isolation by default. See <a href="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txnSnapshot</code> - If true, configure the system to default to snapshot isolation.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnSnapshot--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnSnapshot</h4>
|
|
<pre class="methodSignature">public boolean getTxnSnapshot()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the handle is configured to run all transactions at snapshot
|
|
isolation.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnMaxActive-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnMaxActive</h4>
|
|
<pre class="methodSignature">public void setTxnMaxActive​(int txnMaxActive)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txnMaxActive</code> - The minimum number of simultaneously active transactions supported
|
|
by the database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnMaxActive--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnMaxActive</h4>
|
|
<pre class="methodSignature">public int getTxnMaxActive()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The minimum number of simultaneously active transactions supported
|
|
by the database environment.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnTimeout-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnTimeout</h4>
|
|
<pre class="methodSignature">public void setTxnTimeout​(long txnTimeout)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnTimeout--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnTimeout</h4>
|
|
<pre class="methodSignature">public long getTxnTimeout()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment transaction timeout value, in
|
|
microseconds; a timeout of 0 means no timeout is set.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnTimestamp-java.util.Date-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnTimestamp</h4>
|
|
<pre class="methodSignature">public void setTxnTimestamp​(java.util.Date txnTimestamp)</pre>
|
|
<div class="block">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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txnTimestamp</code> - The recovery timestamp.
|
|
Only the seconds (not the milliseconds) of the timestamp are used.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnTimestamp--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnTimestamp</h4>
|
|
<pre class="methodSignature">public java.util.Date getTxnTimestamp()</pre>
|
|
<div class="block">Return the time to which recovery will be done, or 0 if recovery will
|
|
be done to the most current possible date.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The time to which recovery will be done, or 0 if recovery will be
|
|
done to the most current possible date.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setTxnWriteNoSync-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setTxnWriteNoSync</h4>
|
|
<pre class="methodSignature">public void setTxnWriteNoSync​(boolean txnWriteNoSync)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txnWriteNoSync</code> - If true, configure the system to write, but not synchronously flush,
|
|
the log on transaction commit.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTxnWriteNoSync--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTxnWriteNoSync</h4>
|
|
<pre class="methodSignature">public boolean getTxnWriteNoSync()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to write, but not synchronously
|
|
flush, the log on transaction commit.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setUseEnvironment-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setUseEnvironment</h4>
|
|
<pre class="methodSignature">public void setUseEnvironment​(boolean useEnvironment)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>useEnvironment</code> - If true, configure the database environment to accept information
|
|
from the process environment when naming files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getUseEnvironment--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getUseEnvironment</h4>
|
|
<pre class="methodSignature">public boolean getUseEnvironment()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to accept information
|
|
from the process environment when naming files.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setUseEnvironmentRoot-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setUseEnvironmentRoot</h4>
|
|
<pre class="methodSignature">public void setUseEnvironmentRoot​(boolean useEnvironmentRoot)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<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.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getUseEnvironmentRoot--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getUseEnvironmentRoot</h4>
|
|
<pre class="methodSignature">public boolean getUseEnvironmentRoot()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the database environment is configured to accept information
|
|
from the process environment when naming files if the process has
|
|
appropriate permissions.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setVerbose-com.sleepycat.db.VerboseConfig-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVerbose</h4>
|
|
<pre class="methodSignature">public void setVerbose​(<a href="VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</a> flag,
|
|
boolean enable)</pre>
|
|
<div class="block">Display verbose information.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>flag</code> - The type of verbose information being configured.
|
|
<p></dd>
|
|
<dd><code>enable</code> - If true, display additional information.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVerbose-com.sleepycat.db.VerboseConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVerbose</h4>
|
|
<pre class="methodSignature">public boolean getVerbose​(<a href="VerboseConfig.html" title="class in com.sleepycat.db">VerboseConfig</a> flag)</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>flag</code> - The type of verbose information being queried.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the database environment is configured to display additional
|
|
information of the specified type.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setVerboseDeadlock-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVerboseDeadlock</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setVerboseDeadlock​(boolean verboseDeadlock)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
<div class="block">Display additional information when doing deadlock detection.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>verboseDeadlock</code> - If true, display additional information when doing deadlock
|
|
detection.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVerboseDeadlock--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVerboseDeadlock</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public boolean getVerboseDeadlock()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the database environment is configured to display additional
|
|
information when doing deadlock detection.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setVerboseRecovery-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVerboseRecovery</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setVerboseRecovery​(boolean verboseRecovery)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
<div class="block">Display additional information when performing recovery.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>verboseRecovery</code> - If true, display additional information when performing recovery.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVerboseRecovery--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVerboseRecovery</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public boolean getVerboseRecovery()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the database environment is configured to display additional
|
|
information when performing recovery.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setVerboseRegister-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVerboseRegister</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setVerboseRegister​(boolean verboseRegister)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
<div class="block">Display additional information concerning support for the
|
|
<a href="#setRegister-boolean-"><code>setRegister(boolean)</code></a> method.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>verboseRegister</code> - If true, display additional information concerning support for the
|
|
<a href="#setRegister-boolean-"><code>setRegister(boolean)</code></a> method
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVerboseRegister--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVerboseRegister</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public boolean getVerboseRegister()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
<div class="block">Return if the database environment is configured to display
|
|
additional information concerning support for the
|
|
<a href="#setRegister-boolean-"><code>setRegister(boolean)</code></a> method.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the database environment is configured to display additional
|
|
information concerning support for the
|
|
<a href="#setRegister-boolean-"><code>setRegister(boolean)</code></a> method.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setVerboseReplication-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVerboseReplication</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setVerboseReplication​(boolean verboseReplication)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>verboseReplication</code> - If true, display additional information when processing replication
|
|
messages.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVerboseReplication--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVerboseReplication</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public boolean getVerboseReplication()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the database environment is configured to display additional
|
|
information when processing replication messages.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setVerboseWaitsFor-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVerboseWaitsFor</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public void setVerboseWaitsFor​(boolean verboseWaitsFor)</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#setVerbose-com.sleepycat.db.VerboseConfig-boolean-"><code>setVerbose(com.sleepycat.db.VerboseConfig, boolean)</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>verboseWaitsFor</code> - If true, display the waits-for table when doing deadlock detection.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVerboseWaitsFor--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVerboseWaitsFor</h4>
|
|
<pre class="methodSignature">@Deprecated
|
|
public boolean getVerboseWaitsFor()</pre>
|
|
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
|
|
<div class="deprecationComment">replaced by <a href="#getVerbose-com.sleepycat.db.VerboseConfig-"><code>getVerbose(com.sleepycat.db.VerboseConfig)</code></a></div>
|
|
</div>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the database environment is configured to display the waits-for
|
|
table when doing deadlock detection.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setYieldCPU-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setYieldCPU</h4>
|
|
<pre class="methodSignature">public void setYieldCPU​(boolean yieldCPU)</pre>
|
|
<div class="block">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="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="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></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>yieldCPU</code> - If true, configure the system to yield the processor immediately
|
|
after each page or mutex acquisition.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getYieldCPU--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getYieldCPU</h4>
|
|
<pre class="methodSignature">public boolean getYieldCPU()</pre>
|
|
<div class="block">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></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>True if the system has been configured to yield the processor
|
|
immediately after each page or mutex acquisition.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/EnvironmentConfig.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
|
|
</body>
|
|
</html>
|