mirror of
https://github.com/yasuhirokimura/db18
synced 2026-06-08 18:29:23 +00:00
Yasuhiro KIMURA
3622 lines
181 KiB
HTML
3622 lines
181 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>Environment (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="Environment (Oracle - Berkeley DB Java API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"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":9,"i39":9,"i40":9,"i41":9,"i42":9,"i43":9,"i44":9,"i45":10,"i46":10,"i47":10,"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":9,"i68":10,"i69":10,"i70":10,"i71":10,"i72":10,"i73":10,"i74":42,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":10,"i81":10,"i82":9,"i83":10,"i84":10,"i85":10,"i86":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Environment.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 Environment" class="title">Class Environment</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.db.Environment</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">Environment</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">A database environment. Environments include support for some or
|
|
all of caching, locking, logging and transactions.
|
|
<p>
|
|
To open an existing environment with default attributes the application
|
|
may use a default environment configuration object or null:
|
|
<blockquote><pre>
|
|
// Open an environment handle with default attributes.
|
|
Environment env = new Environment(home, new EnvironmentConfig());
|
|
</pre></blockquote>
|
|
<p>
|
|
or
|
|
<blockquote><pre>
|
|
Environment env = new Environment(home, null);
|
|
</pre></blockquote>
|
|
<p>
|
|
Note that many Environment objects may access a single environment.
|
|
<p>
|
|
To create an environment or customize attributes, the application should
|
|
customize the configuration class. For example:
|
|
<blockquote><pre>
|
|
EnvironmentConfig envConfig = new EnvironmentConfig();
|
|
envConfig.setTransactional(true);
|
|
envConfig.setAllowCreate(true);
|
|
envConfig.setCacheSize(1000000);
|
|
|
|
Environment newlyCreatedEnv = new Environment(home, envConfig);
|
|
</pre></blockquote>
|
|
<p>
|
|
Environment handles are free-threaded unless <a href="EnvironmentConfig.html#setThreaded-boolean-"><code>EnvironmentConfig.setThreaded</code></a> is called to disable this before the environment is opened.
|
|
<p>
|
|
An <em>environment handle</em> is an Environment instance. More than
|
|
one Environment instance may be created for the same physical directory,
|
|
which is the same as saying that more than one Environment handle may
|
|
be open at one time for a given environment.
|
|
<p>
|
|
The Environment handle should not be closed while any other handle
|
|
remains open that is using it as a reference (for example,
|
|
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> or <a href="Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a>. Once <a href="#close--"><code>Environment.close</code></a>
|
|
is called, this object may not be accessed again, regardless of
|
|
whether or not it throws an exception.</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 int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EID_MASTER">EID_MASTER</a></span></code></th>
|
|
<td class="colLast">
|
|
<div class="block">A special identifier for eid in
|
|
<a href="#openChannel-int-"><code>Environment.openChannel</code></a>
|
|
to create channel to send messages only to the master site.</div>
|
|
</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="#Environment-java.io.File-com.sleepycat.db.EnvironmentConfig-">Environment</a></span>​(java.io.File home,
|
|
<a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a database environment handle.</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="#backup-java.lang.String-com.sleepycat.db.BackupOptions-">backup</a></span>​(java.lang.String target,
|
|
<a href="BackupOptions.html" title="class in com.sleepycat.db">BackupOptions</a> opt)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Perform a hot back up of the open environment.</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="#backupDatabase-java.lang.String-java.lang.String-boolean-">backupDatabase</a></span>​(java.lang.String dbfile,
|
|
java.lang.String target,
|
|
boolean exclusiveCreate)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Perform a hot back up of a single database file contained within the environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beginCDSGroup--">beginCDSGroup</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allocate a locker ID in an environment configured for Berkeley DB
|
|
Concurrent Data Store applications.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beginTransaction-com.sleepycat.db.Transaction-com.sleepycat.db.TransactionConfig-">beginTransaction</a></span>​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> parent,
|
|
<a href="TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a new transaction in the database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkpoint-com.sleepycat.db.CheckpointConfig-">checkpoint</a></span>​(<a href="CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Synchronously checkpoint the database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close--">close</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeForceSync--">closeForceSync</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeForceSyncAndForceSyncEnv--">closeForceSyncAndForceSyncEnv</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closeForceSyncEnv--">closeForceSyncEnv</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createLockerID--">createLockerID</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allocate a locker ID.</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="#detectDeadlocks-com.sleepycat.db.LockDetectMode-">detectDeadlocks</a></span>​(<a href="LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> mode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Run one iteration of the deadlock detector.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#electReplicationMaster-int-int-">electReplicationMaster</a></span>​(int nsites,
|
|
int nvotes)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Hold an election for the master of a replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#flushReplication--">flushReplication</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Internal method: re-push the last log record to all clients, in case they've
|
|
lost messages and don't know it.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#freeLockerID-int-">freeLockerID</a></span>​(int id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Free a locker ID.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>java.io.File[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArchiveDatabases--">getArchiveDatabases</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database files that need to be archived in order to recover the
|
|
database from catastrophic failure.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArchiveLogFiles-boolean-">getArchiveLogFiles</a></span>​(boolean includeInUse)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return an array of log files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheFileStats-com.sleepycat.db.StatsConfig-">getCacheFileStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return statistics for individual files in the cache.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="CacheStats.html" title="class in com.sleepycat.db">CacheStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheStats-com.sleepycat.db.StatsConfig-">getCacheStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the memory pool (that is, the buffer cache) subsystem statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><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="#getConfig--">getConfig</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return this object's configuration.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHome--">getHome</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment home directory.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="Lock.html" title="class in com.sleepycat.db">Lock</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLock-int-boolean-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockRequestMode-">getLock</a></span>​(int locker,
|
|
boolean noWait,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> object,
|
|
<a href="LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Acquire a lock from the lock table returning information about it in the Lock parameter.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockerPriority-int-">getLockerPriority</a></span>​(int id)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the deadlock priority for the given locker.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="LockStats.html" title="class in com.sleepycat.db">LockStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLockStats-com.sleepycat.db.StatsConfig-">getLockStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment's locking statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogFileName-com.sleepycat.db.LogSequenceNumber-">getLogFileName</a></span>​(<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the name of the log file that contains the log record
|
|
specified by a LogSequenceNumber object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="LogStats.html" title="class in com.sleepycat.db">LogStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogStats-com.sleepycat.db.StatsConfig-">getLogStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment's logging statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="MutexStats.html" title="class in com.sleepycat.db">MutexStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMutexStats-com.sleepycat.db.StatsConfig-">getMutexStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment's mutex statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationConfig-com.sleepycat.db.ReplicationConfig-">getReplicationConfig</a></span>​(<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the configuration of the replication subsystem.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerLocalSite--">getReplicationManagerLocalSite</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a handle for the local replication site.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerSite-int-">getReplicationManagerSite</a></span>​(int eid)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a site known to the replication manager by its eid.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerSite-java.lang.String-long-">getReplicationManagerSite</a></span>​(java.lang.String host,
|
|
long port)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a site in the replication manager by its host and port.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerSiteList--">getReplicationManagerSiteList</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return an array of all the sites known to the replication manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationManagerStats-com.sleepycat.db.StatsConfig-">getReplicationManagerStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment's replication manager statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<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 number of sites in a replication group.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i33" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationStats-com.sleepycat.db.StatsConfig-">getReplicationStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment's replication statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i34" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReplicationTimeout-com.sleepycat.db.ReplicationTimeoutType-">getReplicationTimeout</a></span>​(<a href="ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the timeout applied to the specified timeout type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i35" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSliceCount--">getSliceCount</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the number of slices in the environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i36" class="altColor">
|
|
<td class="colFirst"><code><a href="Environment.html" title="class in com.sleepycat.db">Environment</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSlices--">getSlices</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Gets the Environment handles for the underlying slice environments.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i37" class="rowColor">
|
|
<td class="colFirst"><code><a href="TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactionStats-com.sleepycat.db.StatsConfig-">getTransactionStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the database environment's transactional statistics.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i38" class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionFamily--">getVersionFamily</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the release's Oracle family number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i39" class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionFullString--">getVersionFullString</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the full release version information, suitable for display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i40" class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionMajor--">getVersionMajor</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the release major number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i41" class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionMinor--">getVersionMinor</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the release minor number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i42" class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionPatch--">getVersionPatch</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the release patch number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i43" class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionRelease--">getVersionRelease</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the release's Oracle release number.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i44" class="altColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVersionString--">getVersionString</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the release version information, suitable for display.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i45" class="rowColor">
|
|
<td class="colFirst"><code><a href="TransactionStatus.html" title="class in com.sleepycat.db">TransactionStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isTransactionApplied-byte:A-int-">isTransactionApplied</a></span>​(byte[] token,
|
|
int maxwait)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return whether the transaction referred to by the commit token "token" has
|
|
been applied at the local replication environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i46" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lockVector-int-boolean-com.sleepycat.db.LockRequest:A-">lockVector</a></span>​(int locker,
|
|
boolean noWait,
|
|
<a href="LockRequest.html" title="class in com.sleepycat.db">LockRequest</a>[] list)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Atomically obtain and release one or more locks from the lock table.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i47" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logFlush-com.sleepycat.db.LogSequenceNumber-">logFlush</a></span>​(<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Flush log records to stable storage.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i48" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logPrint-com.sleepycat.db.Transaction-java.lang.String-">logPrint</a></span>​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String message)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Append an informational message to the Berkeley DB database environment log files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i49" class="rowColor">
|
|
<td class="colFirst"><code><a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logPut-com.sleepycat.db.DatabaseEntry-boolean-">logPut</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
boolean flush)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Append a record to the log.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i50" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#logVerify-com.sleepycat.db.LogVerifyConfig-">logVerify</a></span>​(<a href="LogVerifyConfig.html" title="class in com.sleepycat.db">LogVerifyConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Verify integrity of the log records of an environment and write both error and
|
|
normal messages to the environment's error report destination.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i51" class="rowColor">
|
|
<td class="colFirst"><code><a href="ReplicationChannel.html" title="class in com.sleepycat.db">ReplicationChannel</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openChannel-int-">openChannel</a></span>​(int eid)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Create a channel.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i52" class="altColor">
|
|
<td class="colFirst"><code><a href="Database.html" title="class in com.sleepycat.db">Database</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-">openDatabase</a></span>​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName,
|
|
<a href="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Open a database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i53" class="rowColor">
|
|
<td class="colFirst"><code><a href="LogCursor.html" title="class in com.sleepycat.db">LogCursor</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openLogCursor--">openLogCursor</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a log cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i54" class="altColor">
|
|
<td class="colFirst"><code><a href="SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openSecondaryDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.Database-com.sleepycat.db.SecondaryConfig-">openSecondaryDatabase</a></span>​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName,
|
|
<a href="Database.html" title="class in com.sleepycat.db">Database</a> primaryDatabase,
|
|
<a href="SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Open a database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i55" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#panic-boolean-">panic</a></span>​(boolean onoff)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the panic state for the database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i56" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#printLockStats-com.sleepycat.db.StatsConfig-">printLockStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the locking subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).</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="#printLogStats-com.sleepycat.db.StatsConfig-">printLogStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the logging subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).</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="#printMempStats-com.sleepycat.db.StatsConfig-">printMempStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the cache subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).</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="#printMutexStats-com.sleepycat.db.StatsConfig-">printMutexStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the mutex subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).</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="#printReplicationManagerStats-com.sleepycat.db.StatsConfig-">printReplicationManagerStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the Replication Manager subsystem statistical information to a
|
|
specified output channel (see the setMsgfile() method for more
|
|
information), or passed to an application callback function (see the
|
|
setMsgcall() method for more information).</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="#printReplicationStats-com.sleepycat.db.StatsConfig-">printReplicationStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the replication subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).</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="#printStats-com.sleepycat.db.StatsConfig-">printStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print environment statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).</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="#printTransactionStats-com.sleepycat.db.StatsConfig-">printTransactionStats</a></span>​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Print the transaction subsystem statistical information to a specified
|
|
output channel (see the setMsgfile() method for more information), or
|
|
passed to an application callback function (see the setMsgcall() method
|
|
for more information).</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i64" class="altColor">
|
|
<td class="colFirst"><code><a href="ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-">processReplicationMessage</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> control,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> rec,
|
|
int envid)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Process an incoming replication message sent by a member of the
|
|
replication group to the local database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i65" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putLock-com.sleepycat.db.Lock-">putLock</a></span>​(<a href="Lock.html" title="class in com.sleepycat.db">Lock</a> lock)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Release a lock.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i66" class="altColor">
|
|
<td class="colFirst"><code><a href="PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</a>[]</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#recover-int-boolean-">recover</a></span>​(int count,
|
|
boolean continued)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Environment recovery restores transactions that were prepared, but not yet
|
|
resolved at the time of the system shut down or crash, to their state prior
|
|
to the shut down or crash, including any locks previously held.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i67" class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove-java.io.File-boolean-com.sleepycat.db.EnvironmentConfig-">remove</a></span>​(java.io.File home,
|
|
boolean force,
|
|
<a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Destroy a database environment.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i68" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-">removeDatabase</a></span>​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">
|
|
Remove the database specified by the fileName and databaseName parameters.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i69" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeOldLogFiles--">removeOldLogFiles</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Remove log files that are no longer needed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i70" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#renameDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-java.lang.String-">renameDatabase</a></span>​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName,
|
|
java.lang.String newName)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">
|
|
Rename a database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i71" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#replicationManagerStart-int-com.sleepycat.db.ReplicationManagerStartPolicy-">replicationManagerStart</a></span>​(int nthreads,
|
|
<a href="ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</a> policy)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Starts the replication manager.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i72" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetFileID-java.lang.String-boolean-">resetFileID</a></span>​(java.lang.String filename,
|
|
boolean encrypted)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allows database files to be copied, and then the copy used in the same
|
|
database environment as the original.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i73" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetLogSequenceNumber-java.lang.String-boolean-">resetLogSequenceNumber</a></span>​(java.lang.String filename,
|
|
boolean encrypted)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Allows database files to be moved from one transactional database
|
|
environment to another.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i74" 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="i75" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setConfig-com.sleepycat.db.EnvironmentConfig-">setConfig</a></span>​(<a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Change the settings in an existing environment handle.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i76" 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 external file threshold size.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i77" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLockerPriority-int-int-">setLockerPriority</a></span>​(int id,
|
|
int priority)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Assign a deadlock priority to a locker.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i78" class="altColor">
|
|
<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="i79" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationConfig-com.sleepycat.db.ReplicationConfig-boolean-">setReplicationConfig</a></span>​(<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config,
|
|
boolean onoff)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the replication subsystem.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i80" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationManagerMessageDispatch-com.sleepycat.db.ReplicationManagerMessageDispatch-int-">setReplicationManagerMessageDispatch</a></span>​(<a href="ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db">ReplicationManagerMessageDispatch</a> dispatch,
|
|
int flags)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the message dispatch function.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i81" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReplicationTimeout-com.sleepycat.db.ReplicationTimeoutType-int-">setReplicationTimeout</a></span>​(<a href="ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type,
|
|
int replicationTimeout)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Sets the timeout applied to the specified timeout type.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i82" class="altColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#slices_enabled--">slices_enabled</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr id="i83" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startReplication-com.sleepycat.db.DatabaseEntry-boolean-">startReplication</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> cdata,
|
|
boolean master)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Configure the database environment as a client or master in a group
|
|
of replicated database environments.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i84" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#syncCache-com.sleepycat.db.LogSequenceNumber-">syncCache</a></span>​(<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> logSequenceNumber)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Ensure that all modified pages in the cache are flushed to their backing files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i85" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#syncReplication--">syncReplication</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Forces master synchronization to begin for this client.</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="#trickleCacheWrite-int-">trickleCacheWrite</a></span>​(int percent)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Ensure that a specified percent of the pages in the shared memory
|
|
pool are clean, by writing dirty pages to their backing files.</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="EID_MASTER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>EID_MASTER</h4>
|
|
<pre>public static final int EID_MASTER</pre>
|
|
<div class="block">A special identifier for eid in
|
|
<a href="#openChannel-int-"><code>Environment.openChannel</code></a>
|
|
to create channel to send messages only to the master site.</div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="../../../constant-values.html#com.sleepycat.db.Environment.EID_MASTER">Constant Field Values</a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="Environment-java.io.File-com.sleepycat.db.EnvironmentConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Environment</h4>
|
|
<pre>public Environment​(java.io.File home,
|
|
<a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
|
|
java.io.FileNotFoundException</pre>
|
|
<div class="block">Create a database environment handle.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>home</code> - The database environment's home directory.
|
|
The environment variable <code>DB_HOME</code> may be used as
|
|
the path of the database home.
|
|
For more information on <code>envHome</code> and filename
|
|
resolution in general, see
|
|
<a href="../../../../programmer_reference/env_naming.html" target="_top">File Naming</a>.
|
|
<p></dd>
|
|
<dd><code>config</code> - The database environment attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dd><code>java.io.FileNotFoundException</code> - if the environment home directory does not exist</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="close--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>close</h4>
|
|
<pre class="methodSignature">public void close()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.
|
|
<p>
|
|
When you call this method, all open database and cursor handles are closed automatically, and should not be reused.
|
|
<p>
|
|
The <a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle should not be closed while any other
|
|
handle that refers to it is not yet closed; for example, database
|
|
environment handles must not be closed while
|
|
transactions in the environment have not yet been committed
|
|
or aborted. Specifically, this includes
|
|
<a href="Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a>, and <a href="LogCursor.html" title="class in com.sleepycat.db"><code>LogCursor</code></a>
|
|
handles.
|
|
<p>
|
|
In multiple threads of control, each thread of control opens a database environment and the database handles within it. When you close each database handle using this method, by default, the database is not synchronized. To synchronize all open databases ensure that the last environment
|
|
object is closed using the Environment.CloseForceSync() method.
|
|
When the close operation fails, the method returns a non-zero error value for the
|
|
first instance of such error, and continues to close the rest of the environment objects.
|
|
<p>
|
|
Where the environment was initialized with a locking subsystem,
|
|
closing the environment does not release any locks still held by the
|
|
closing process, providing functionality for long-lived locks.
|
|
<p>
|
|
Where the environment was initialized with a transaction subsystem,
|
|
closing the environment aborts any unresolved transactions.
|
|
Applications should not depend on this behavior for transactions
|
|
involving databases; all such transactions should be explicitly
|
|
resolved. The problem with depending on this semantic is that
|
|
aborting an unresolved transaction involving database operations
|
|
requires a database handle. Because the database handles should
|
|
have been closed before closing the environment, it will not be
|
|
possible to abort the transaction, and recovery will have to be run
|
|
on the database environment before further operations are done.
|
|
<p>
|
|
Where log cursors were created, closing the environment does not
|
|
imply closing those cursors.
|
|
<p>
|
|
In multithreaded applications, only a single thread may call this
|
|
method.
|
|
<p>
|
|
After this method has been called, regardless of its return, the
|
|
<a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle may not be accessed again.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="closeForceSync--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>closeForceSync</h4>
|
|
<pre class="methodSignature">public void closeForceSync()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.
|
|
<p>
|
|
This function is similar to Environment.close(), except that
|
|
each open database is synchronized as it is closed.</div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="closeForceSyncEnv--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>closeForceSyncEnv</h4>
|
|
<pre class="methodSignature">public void closeForceSyncEnv()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.
|
|
<p>
|
|
This function is similar to Environment.close(), except that
|
|
all memory mapped environment regions are synchronized as the
|
|
environment is closed.</div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="closeForceSyncAndForceSyncEnv--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>closeForceSyncAndForceSyncEnv</h4>
|
|
<pre class="methodSignature">public void closeForceSyncAndForceSyncEnv()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Close the database environment, freeing any allocated resources and
|
|
closing any underlying subsystems.
|
|
<p>
|
|
This function is similar to Environment.close(), except that
|
|
it has the effect of both closeForceSync() and closeForceSyncEnv().</div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="remove-java.io.File-boolean-com.sleepycat.db.EnvironmentConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>remove</h4>
|
|
<pre class="methodSignature">public static void remove​(java.io.File home,
|
|
boolean force,
|
|
<a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
|
|
java.io.FileNotFoundException</pre>
|
|
<div class="block">Destroy a database environment.
|
|
<p>
|
|
If the environment is not in use, the environment regions, including
|
|
any backing files, are removed. Any log or database files and the
|
|
environment directory itself are not removed.
|
|
<p>
|
|
If there are processes currently using the database environment,
|
|
this method will fail without further action (unless the force
|
|
argument is true, in which case the environment will be removed,
|
|
regardless of any processes still using it).
|
|
<p>
|
|
The result of attempting to forcibly destroy the environment when
|
|
it is in use is unspecified. Processes using an environment often
|
|
maintain open file descriptors for shared regions within it. On
|
|
UNIX systems, the environment removal will usually succeed, and
|
|
processes that have already joined the region will continue to run
|
|
in that region without change. However, processes attempting to
|
|
join the environment will either fail or create new regions. On
|
|
other systems in which the unlink system call will fail if any
|
|
process has an open file descriptor for the file (for example
|
|
Windows/NT), the region removal will fail.
|
|
<p>
|
|
Calling this method should not be necessary for most applications
|
|
because the environment is cleaned up as part of normal
|
|
database recovery procedures. However, applications may want to call
|
|
this method as part of application shut down to free up system
|
|
resources. For example, if system shared memory was used to back
|
|
the database environment, it may be useful to call this method in
|
|
order to release system shared memory segments that have been
|
|
allocated. Or, on architectures in which mutexes require allocation
|
|
of underlying system resources, it may be useful to call
|
|
this method in order to release those resources. Alternatively, if
|
|
recovery is not required because no database state is maintained
|
|
across failures, and no system resources need to be released, it is
|
|
possible to clean up an environment by simply removing all the
|
|
Berkeley DB files in the database environment's directories.
|
|
<p>
|
|
In multithreaded applications, only a single thread may call this
|
|
method.
|
|
<p>
|
|
After this method has been called, regardless of its return, the
|
|
<a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle may not be
|
|
accessed again.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>home</code> - The database environment to be removed.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.
|
|
<p></dd>
|
|
<dd><code>force</code> - The environment is removed, regardless of any processes that may
|
|
still using it, and no locks are acquired during this process.
|
|
(Generally, the force argument is specified only when applications
|
|
were unable to shut down cleanly, and there is a risk that an
|
|
application may have died holding a Berkeley DB mutex or lock.
|
|
<p></dd>
|
|
<dd><code>config</code> - The database environment attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dd><code>java.io.FileNotFoundException</code> - if the database file does not exist</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setConfig-com.sleepycat.db.EnvironmentConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setConfig</h4>
|
|
<pre class="methodSignature">public void setConfig​(<a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Change the settings in an existing environment handle.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The database environment attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getConfig--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getConfig</h4>
|
|
<pre class="methodSignature">public <a href="EnvironmentConfig.html" title="class in com.sleepycat.db">EnvironmentConfig</a> getConfig()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return this object's configuration.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This object's configuration.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>openDatabase</h4>
|
|
<pre class="methodSignature">public <a href="Database.html" title="class in com.sleepycat.db">Database</a> openDatabase​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName,
|
|
<a href="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
|
|
java.io.FileNotFoundException</pre>
|
|
<div class="block">Open a database.
|
|
<p>
|
|
The database is represented by the file and database parameters.
|
|
<p>
|
|
The currently supported database file formats (or <em>access
|
|
methods</em>) are Btree, Hash, Queue, and Recno. The Btree format is a
|
|
representation of a sorted, balanced tree structure. The Hash format
|
|
is an extensible, dynamic hashing scheme. The Queue format supports
|
|
fast access to fixed-length records accessed sequentially or by logical
|
|
record number. The Recno format supports fixed- or variable-length
|
|
records, accessed sequentially or by logical record number, and
|
|
optionally backed by a flat text file.
|
|
<p>
|
|
Storage and retrieval are based on key/data pairs; see <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>
|
|
for more information.
|
|
<p>
|
|
Opening a database is a relatively expensive operation, and maintaining
|
|
a set of open databases will normally be preferable to repeatedly
|
|
opening and closing the database for each new query.
|
|
<p>
|
|
In-memory databases never intended to be preserved on disk may be
|
|
created by setting both the fileName and databaseName parameters to
|
|
null. Note that in-memory databases can only ever be shared by sharing
|
|
the single database handle that created them, in circumstances where
|
|
doing so is safe. The environment variable <code>TMPDIR</code> may
|
|
be used as a directory in which to create temporary backing files.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txn</code> - For a transactional database, an explicit transaction may be specified, or null
|
|
may be specified to use auto-commit. For a non-transactional database, null
|
|
must be specified.
|
|
Note that transactionally protected operations on a Database handle
|
|
require that the Database handle itself be transactionally protected
|
|
during its open, either with a non-null transaction handle, or by calling
|
|
<a href="DatabaseConfig.html#setTransactional-boolean-"><code>DatabaseConfig.setTransactional</code></a> on the configuration object.
|
|
<p></dd>
|
|
<dd><code>fileName</code> - The name of an underlying file that will be used to back the database.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.
|
|
<p></dd>
|
|
<dd><code>databaseName</code> - An optional parameter that allows applications to have multiple
|
|
databases in a single file. Although no databaseName parameter needs
|
|
to be specified, it is an error to attempt to open a second database in
|
|
a physical file that was not initially created using a databaseName
|
|
parameter. Further, the databaseName parameter is not supported by the
|
|
Queue format.
|
|
<p></dd>
|
|
<dd><code>config</code> - The database open attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a Database handle</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dd><code>java.io.FileNotFoundException</code> - if the database file does not exist</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="openSecondaryDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.Database-com.sleepycat.db.SecondaryConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>openSecondaryDatabase</h4>
|
|
<pre class="methodSignature">public <a href="SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> openSecondaryDatabase​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName,
|
|
<a href="Database.html" title="class in com.sleepycat.db">Database</a> primaryDatabase,
|
|
<a href="SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
|
|
java.io.FileNotFoundException</pre>
|
|
<div class="block">Open a database.
|
|
<p>
|
|
The database is represented by the file and database parameters.
|
|
<p>
|
|
The currently supported database file formats (or <em>access
|
|
methods</em>) are Btree, Hash, Queue, and Recno. The Btree format is a
|
|
representation of a sorted, balanced tree structure. The Hash format
|
|
is an extensible, dynamic hashing scheme. The Queue format supports
|
|
fast access to fixed-length records accessed sequentially or by logical
|
|
record number. The Recno format supports fixed- or variable-length
|
|
records, accessed sequentially or by logical record number, and
|
|
optionally backed by a flat text file.
|
|
<p>
|
|
Storage and retrieval are based on key/data pairs; see <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>
|
|
for more information.
|
|
<p>
|
|
Opening a database is a relatively expensive operation, and maintaining
|
|
a set of open databases will normally be preferable to repeatedly
|
|
opening and closing the database for each new query.
|
|
<p>
|
|
In-memory databases never intended to be preserved on disk may be
|
|
created by setting both the fileName and databaseName parameters to
|
|
null. Note that in-memory databases can only ever be shared by sharing
|
|
the single database handle that created them, in circumstances where
|
|
doing so is safe. The environment variable <code>TMPDIR</code> may
|
|
be used as a directory in which to create temporary backing files.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txn</code> - For a transactional database, an explicit transaction may be specified, or null
|
|
may be specified to use auto-commit. For a non-transactional database, null
|
|
must be specified.
|
|
Note that transactionally protected operations on a Database handle
|
|
require that the Database handle itself be transactionally protected
|
|
during its open, either with a non-null transaction handle, or by calling
|
|
<a href="DatabaseConfig.html#setTransactional-boolean-"><code>DatabaseConfig.setTransactional</code></a> on the configuration object.
|
|
<p></dd>
|
|
<dd><code>fileName</code> - The name of an underlying file that will be used to back the database.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.
|
|
<p></dd>
|
|
<dd><code>databaseName</code> - An optional parameter that allows applications to have multiple
|
|
databases in a single file. Although no databaseName parameter needs
|
|
to be specified, it is an error to attempt to open a second database in
|
|
a physical file that was not initially created using a databaseName
|
|
parameter. Further, the databaseName parameter is not supported by the
|
|
Queue format.
|
|
<p></dd>
|
|
<dd><code>primaryDatabase</code> - a database handle for the primary database that is to be indexed.
|
|
<p></dd>
|
|
<dd><code>config</code> - The secondary database open attributes. If null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a SecondaryDatabase handle</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dd><code>java.io.FileNotFoundException</code> - if the database file does not exist</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeDatabase</h4>
|
|
<pre class="methodSignature">public void removeDatabase​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
|
|
java.io.FileNotFoundException</pre>
|
|
<div class="block"><p>
|
|
Remove the database specified by the fileName and databaseName parameters.
|
|
<p>
|
|
If no database is specified, the underlying file specified is removed, incidentally removing all of the databases it contained.
|
|
<p>
|
|
Applications should never remove databases with open <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a>
|
|
handles, or in the case of removing a file, when any database in the
|
|
file has an open handle. For example, some architectures do not permit
|
|
the removal of files with open system handles. On these architectures,
|
|
attempts to remove databases currently in use by any thread of control
|
|
in the system may fail.
|
|
<p>
|
|
The
|
|
environment variable DB_HOME may be used as the path of the database
|
|
environment home.
|
|
<p>
|
|
This method is affected by any database directory specified with
|
|
<a href="EnvironmentConfig.html#addDataDir-java.io.File-"><code>EnvironmentConfig.addDataDir</code></a>, or by setting the "set_data_dir"
|
|
string in the database environment's DB_CONFIG file.
|
|
<p>
|
|
The <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle may not be accessed
|
|
again after this method is called, regardless of this method's success
|
|
or failure.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txn</code> - If the operation is part of an application-specified transaction, the txn
|
|
parameter is a Transaction object returned from the
|
|
<a href="#beginTransaction-com.sleepycat.db.Transaction-com.sleepycat.db.TransactionConfig-"><code>Environment.beginTransaction</code></a> method; if the operation is part of a Berkeley DB
|
|
Concurrent Data Store group, the txn parameter is a Transaction object returned
|
|
from the <a href="#beginCDSGroup--"><code>Environment.beginCDSGroup</code></a> method; otherwise null.
|
|
For a transactional database, an explicit transaction may be specified, or null
|
|
may be specified to use auto-commit. For a non-transactional database, null
|
|
must be specified.
|
|
<p></dd>
|
|
<dd><code>fileName</code> - The physical file which contains the database to be removed.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.
|
|
<p></dd>
|
|
<dd><code>databaseName</code> - The database to be removed.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dd><code>java.io.FileNotFoundException</code> - if the database file does not exist</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="renameDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>renameDatabase</h4>
|
|
<pre class="methodSignature">public void renameDatabase​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String fileName,
|
|
java.lang.String databaseName,
|
|
java.lang.String newName)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
|
|
java.io.FileNotFoundException</pre>
|
|
<div class="block"><p>
|
|
Rename a database.
|
|
<p>
|
|
If no database name is specified, the underlying file specified is
|
|
renamed, incidentally renaming all of the databases it contains.
|
|
<p>
|
|
Applications should never rename databases that are currently in use.
|
|
If an underlying file is being renamed and logging is currently enabled
|
|
in the database environment, no database in the file may be open when
|
|
this method is called. In particular, some architectures do not permit
|
|
renaming files with open handles. On these architectures, attempts to
|
|
rename databases that are currently in use by any thread of control in
|
|
the system may fail.
|
|
<p>
|
|
The
|
|
environment variable DB_HOME may be used as the path of the database
|
|
environment home.
|
|
<p>
|
|
This method is affected by any database directory specified with
|
|
<a href="EnvironmentConfig.html#addDataDir-java.io.File-"><code>EnvironmentConfig.addDataDir</code></a>, or by setting the "set_data_dir"
|
|
string in the database environment's DB_CONFIG file.
|
|
<p>
|
|
The <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle may not be accessed
|
|
again after this method is called, regardless of this method's success
|
|
or failure.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txn</code> - If the operation is part of an application-specified transaction, the txn
|
|
parameter is a Transaction object returned from the
|
|
<a href="#beginTransaction-com.sleepycat.db.Transaction-com.sleepycat.db.TransactionConfig-"><code>Environment.beginTransaction</code></a> method; if the operation is part of a Berkeley DB
|
|
Concurrent Data Store group, the txn parameter is a Transaction object returned
|
|
from the <a href="#beginCDSGroup--"><code>Environment.beginCDSGroup</code></a> method; otherwise null.
|
|
For a transactional database, an explicit transaction may be specified, or null
|
|
may be specified to use auto-commit. For a non-transactional database, null
|
|
must be specified.
|
|
<p></dd>
|
|
<dd><code>fileName</code> - The physical file which contains the database to be renamed.
|
|
On Windows platforms, this argument will be interpreted as a UTF-8
|
|
string, which is equivalent to ASCII for Latin characters.
|
|
<p></dd>
|
|
<dd><code>databaseName</code> - The database to be renamed.
|
|
<p></dd>
|
|
<dd><code>newName</code> - The new name of the database or file.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dd><code>java.io.FileNotFoundException</code> - if the database file does not exist</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getHome--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getHome</h4>
|
|
<pre class="methodSignature">public java.io.File getHome()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment home directory. This directory is normally
|
|
identified in the <a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> constructor.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment home directory.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="trickleCacheWrite-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>trickleCacheWrite</h4>
|
|
<pre class="methodSignature">public int trickleCacheWrite​(int percent)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Ensure that a specified percent of the pages in the shared memory
|
|
pool are clean, by writing dirty pages to their backing files.
|
|
<p>
|
|
The purpose of this method is to enable a memory pool manager to ensure
|
|
that a page is always available for reading in new information
|
|
without having to wait for a write.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>percent</code> - The percent of the pages in the cache that should be clean.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of pages that were written to reach the specified
|
|
percentage.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="detectDeadlocks-com.sleepycat.db.LockDetectMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>detectDeadlocks</h4>
|
|
<pre class="methodSignature">public int detectDeadlocks​(<a href="LockDetectMode.html" title="class in com.sleepycat.db">LockDetectMode</a> mode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Run one iteration of the deadlock detector.
|
|
<p>
|
|
The deadlock detector traverses the lock table and marks one of the
|
|
participating lock requesters for rejection in each deadlock it finds.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>mode</code> - Which lock request(s) to reject.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of lock requests that were rejected.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLock-int-boolean-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockRequestMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLock</h4>
|
|
<pre class="methodSignature">public <a href="Lock.html" title="class in com.sleepycat.db">Lock</a> getLock​(int locker,
|
|
boolean noWait,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> object,
|
|
<a href="LockRequestMode.html" title="class in com.sleepycat.db">LockRequestMode</a> mode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Acquire a lock from the lock table returning information about it in the Lock parameter.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>locker</code> - An unsigned 32-bit integer quantity representing the entity
|
|
requesting the lock.
|
|
<p></dd>
|
|
<dd><code>mode</code> - The lock mode.
|
|
<p></dd>
|
|
<dd><code>noWait</code> - If a lock cannot be granted because the requested lock conflicts
|
|
with an existing lock, throw a <a href="LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a>
|
|
immediately instead of waiting for the lock to become available.
|
|
<p></dd>
|
|
<dd><code>object</code> - An untyped byte string that specifies the object to be locked.
|
|
Applications using the locking subsystem directly while also doing
|
|
locking via the Berkeley DB access methods must take care not to
|
|
inadvertently lock objects that happen to be equal to the unique
|
|
file IDs used to lock files.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a lock
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putLock-com.sleepycat.db.Lock-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putLock</h4>
|
|
<pre class="methodSignature">public void putLock​(<a href="Lock.html" title="class in com.sleepycat.db">Lock</a> lock)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Release a lock.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>lock</code> - The lock to be released.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="createLockerID--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>createLockerID</h4>
|
|
<pre class="methodSignature">public int createLockerID()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Allocate a locker ID.
|
|
<p>
|
|
The locker ID is guaranteed to be unique for the database environment.
|
|
<p>
|
|
Call <a href="#freeLockerID-int-"><code>Environment.freeLockerID</code></a> to return the locker ID to
|
|
the environment when it is no longer needed.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A locker ID.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="freeLockerID-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>freeLockerID</h4>
|
|
<pre class="methodSignature">public void freeLockerID​(int id)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Free a locker ID.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The locker id to be freed.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockerPriority-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockerPriority</h4>
|
|
<pre class="methodSignature">public int getLockerPriority​(int id)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the deadlock priority for the given locker.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The locker id
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the deadlock priority</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setLockerPriority-int-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setLockerPriority</h4>
|
|
<pre class="methodSignature">public void setLockerPriority​(int id,
|
|
int priority)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Assign a deadlock priority to a locker. This value is used when resolving deadlocks. The deadlock resolution algorithm will reject a
|
|
lock request from a locker with a lower priority before a request from a locker with a higher
|
|
priority.
|
|
By default, all lockers are created with a priority of 100.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>id</code> - The locker id to configure</dd>
|
|
<dd><code>priority</code> - The priority to assign to the locker.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="lockVector-int-boolean-com.sleepycat.db.LockRequest:A-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>lockVector</h4>
|
|
<pre class="methodSignature">public void lockVector​(int locker,
|
|
boolean noWait,
|
|
<a href="LockRequest.html" title="class in com.sleepycat.db">LockRequest</a>[] list)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Atomically obtain and release one or more locks from the lock table.
|
|
This method is intended to support acquisition or trading of
|
|
multiple locks under one lock table semaphore, as is needed for lock
|
|
coupling or in multigranularity locking for lock escalation.
|
|
<p>
|
|
If any of the requested locks cannot be acquired, or any of the locks to
|
|
be released cannot be released, the operations before the failing
|
|
operation are guaranteed to have completed successfully, and
|
|
the method throws an exception.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>noWait</code> - If a lock cannot be granted because the requested lock conflicts
|
|
with an existing lock, throw a <a href="LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a>
|
|
immediately instead of waiting for the lock to become available.
|
|
The index of the request that was not granted will be returned by
|
|
<a href="LockNotGrantedException.html#getIndex--"><code>LockNotGrantedException.getIndex</code></a>.
|
|
<p></dd>
|
|
<dd><code>locker</code> - An unsigned 32-bit integer quantity representing the entity
|
|
requesting the lock.
|
|
<p></dd>
|
|
<dd><code>list</code> - An array of <a href="LockRequest.html" title="class in com.sleepycat.db"><code>LockRequest</code></a> objects, listing the requested lock
|
|
operations.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="openLogCursor--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>openLogCursor</h4>
|
|
<pre class="methodSignature">public <a href="LogCursor.html" title="class in com.sleepycat.db">LogCursor</a> openLogCursor()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a log cursor.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A log cursor.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogFileName-com.sleepycat.db.LogSequenceNumber-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogFileName</h4>
|
|
<pre class="methodSignature">public java.lang.String getLogFileName​(<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the name of the log file that contains the log record
|
|
specified by a LogSequenceNumber object.
|
|
<p>
|
|
This mapping of LogSequenceNumber objects to files is needed for
|
|
database administration. For example, a transaction manager
|
|
typically records the earliest LogSequenceNumber object needed for
|
|
restart, and the database administrator may want to archive log
|
|
files to tape when they contain only log records before the earliest
|
|
one needed for restart.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>lsn</code> - The LogSequenceNumber object for which a filename is wanted.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The name of the log file that contains the log record specified by a
|
|
LogSequenceNumber object.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="logVerify-com.sleepycat.db.LogVerifyConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>logVerify</h4>
|
|
<pre class="methodSignature">public int logVerify​(<a href="LogVerifyConfig.html" title="class in com.sleepycat.db">LogVerifyConfig</a> config)</pre>
|
|
<div class="block">Verify integrity of the log records of an environment and write both error and
|
|
normal messages to the environment's error report destination.
|
|
This method does not perform the locking function, even in Berkeley DB environments
|
|
that are configured with a locking subsystem.
|
|
Because this function does not access any database files, you can call it even
|
|
when the environment has other threads of control attached and running
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The LogVerifyConfig object which contains configurations for the log
|
|
verification.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>If the verification succeeds, return 0; otherwise non-zero.
|
|
Error, warning and report messages are written to the environment's
|
|
error report destination.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="startReplication-com.sleepycat.db.DatabaseEntry-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>startReplication</h4>
|
|
<pre class="methodSignature">public void startReplication​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> cdata,
|
|
boolean master)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Configure the database environment as a client or master in a group
|
|
of replicated database environments. This method is not called by most replication applications.
|
|
It should only be called by Base API applications implementing their
|
|
own network transport layer, explicitly holding replication group elections and
|
|
handling replication messages outside of the Replication Manager framework.
|
|
<p>
|
|
Replication master
|
|
environments are the only database environments where replicated
|
|
databases may be modified. Replication client environments are
|
|
read-only as long as they are clients. Replication client
|
|
environments may be upgraded to be replication master environments
|
|
in the case that the current master fails or there is no master
|
|
present. If master leases are in use, this method cannot be used to
|
|
appoint a master, and should only be used to configure a database
|
|
environment as a master as the result of an election.
|
|
<p>
|
|
The enclosing database environment must already have been configured
|
|
to send replication messages by calling
|
|
<a href="EnvironmentConfig.html#setReplicationTransport-int-com.sleepycat.db.ReplicationTransport-"><code>EnvironmentConfig.setReplicationTransport</code></a>.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>cdata</code> - An opaque data item that is sent over the communication infrastructure
|
|
when the client or master comes online. If no such information is
|
|
useful, cdata should be null.
|
|
<p></dd>
|
|
<dd><code>master</code> - Configure the environment as a replication master. If false, the
|
|
environment will be configured as as a replication client.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="electReplicationMaster-int-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>electReplicationMaster</h4>
|
|
<pre class="methodSignature">public void electReplicationMaster​(int nsites,
|
|
int nvotes)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Hold an election for the master of a replication group. This method is not called
|
|
by most replication applications. It should only be called by Base API applications
|
|
implementing their own network transport layer, explicitly holding replication group
|
|
elections and handling replication messages outside of the Replication Manager framework.
|
|
<p>
|
|
If the election is successful, the new master's ID may be the ID of the
|
|
previous master, or the ID of the current environment. The application
|
|
is responsible for adjusting its usage of the other environments in the
|
|
replication group, including directing all database updates to the newly
|
|
selected master, in accordance with the results of this election.
|
|
<p>
|
|
The thread of control that calls this method must not be the thread
|
|
of control that processes incoming messages; processing the incoming
|
|
messages is necessary to successfully complete an election.
|
|
<p>
|
|
Before calling this method do the following:
|
|
<ul>
|
|
<li>open the database environment.
|
|
<li>configure the database environment to send replication messages.
|
|
<li>configure the database environment as a client or a master.
|
|
</ul>
|
|
<h3>How Elections are Held</h3>
|
|
<p>
|
|
Elections are done in two parts: first, replication sites collect information from the
|
|
other replication sites they know about, and second, replication sites cast their votes for a new master.
|
|
The second phase is triggered by one of two things: either the replication site gets election
|
|
information from nsites sites, or the election timeout expires. Once the second phase is triggered,
|
|
the replication site will cast a vote for the new master of its choice if, and only if,
|
|
the site has election information from at least nvotes sites. If a site receives nvotes votes
|
|
for it to become the new master, then it will become the new master.
|
|
We recommend nvotes be set to at least:
|
|
<p>
|
|
(sites participating in the election / 2) + 1
|
|
<p>
|
|
to ensure there are never more than two masters active at the same time even in the case of a network partition.
|
|
When a network partitions, the side of the partition with more than half the environments will elect
|
|
a new master and continue, while the environments communicating with fewer than half of the
|
|
environments will fail to find a new master, as no site can get nvotes votes.
|
|
We recommend nsites be set to:
|
|
<p>
|
|
number of sites in the replication group - 1
|
|
<p>
|
|
when choosing a new master after a current master fails. This allows the group to reach a consensus without having to wait for the timeout to expire.
|
|
<p>
|
|
When choosing a master from among a group of client sites all restarting at the same time, it makes more sense to set nsites to the total number of sites in the group, since there is no known missing site. Furthermore, in order to ensure the best choice from among sites that may take longer to boot than the local site, setting nvotes also to this same total number of sites will guarantee that every site in the group is considered. Alternatively, using the special timeout for full elections allows full participation on restart but allows election of a master if one site does not reboot and rejoin the group in a reasonable amount of time. (See the Elections section in the Berkeley DB Programmer's Reference Guide for more information.)
|
|
<p>
|
|
Setting nsites to lower values can increase the speed of an election, but can also result in election failure, and is usually not recommended.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>nsites</code> - The number of environments that the application believes are in the
|
|
replication group. This number is used by Berkeley DB to avoid
|
|
having two masters active simultaneously, even in the case of a
|
|
network partition. During an election, a new master cannot be
|
|
elected unless more than half of nsites agree on the new master.
|
|
Thus, in the face of a network partition, the side of the partition
|
|
with more than half the environments will elect a new master and
|
|
continue, while the environments communicating with fewer than half
|
|
the other environments will fail to find a new master.
|
|
<p></dd>
|
|
<dd><code>nvotes</code> - The number of votes required by the application to successfully
|
|
elect a new master. It must be a positive integer, no greater than
|
|
nsites, or 0 if the election should use a simple majority of the
|
|
nsites value as the requirement. A warning is given if half or
|
|
fewer votes are required to win an election as that can potentially
|
|
lead to multiple masters in the face of a network partition.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="flushReplication--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>flushReplication</h4>
|
|
<pre class="methodSignature">public void flushReplication()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Internal method: re-push the last log record to all clients, in case they've
|
|
lost messages and don't know it.
|
|
<p>
|
|
This method may not be called before the database environment is opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="processReplicationMessage-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>processReplicationMessage</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationStatus.html" title="class in com.sleepycat.db">ReplicationStatus</a> processReplicationMessage​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> control,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> rec,
|
|
int envid)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Process an incoming replication message sent by a member of the
|
|
replication group to the local database environment. This method is not called
|
|
by most replication applications. It should only be called by Base API applications
|
|
implementing their own network transport layer, explicitly holding replication
|
|
group elections and handling replication messages outside of the Replication Manager framework.
|
|
<p>
|
|
For implementation reasons, all incoming replication messages must
|
|
be processed using the same <a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle. It is not
|
|
required that a single thread of control process all messages, only
|
|
that all threads of control processing messages use the same handle.
|
|
<p>
|
|
Before calling this method, the enclosing database environment must already
|
|
have been opened and must already have been configured to send replication messages.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>control</code> - A copy of the control parameter specified by Berkeley DB on the
|
|
sending environment.
|
|
<p></dd>
|
|
<dd><code>envid</code> - The local identifier that corresponds to the environment that sent
|
|
the message to be processed.
|
|
<p></dd>
|
|
<dd><code>rec</code> - A copy of the rec parameter specified by Berkeley DB on the sending
|
|
environment.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A <a href="ReplicationStatus.html" title="class in com.sleepycat.db"><code>ReplicationStatus</code></a> object.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationConfig-com.sleepycat.db.ReplicationConfig-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationConfig</h4>
|
|
<pre class="methodSignature">public void setReplicationConfig​(<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config,
|
|
boolean onoff)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Configure the replication subsystem.
|
|
<p>
|
|
The database environment's replication subsystem may also be set using the environment's
|
|
DB_CONFIG file. The syntax of the entry in that file is a single line
|
|
with the string "rep_set_config", one or more whitespace characters, and the method configuration parameter as a string; for example,
|
|
"rep_set_config REP_CONF_NOWAIT".
|
|
Because the DB_CONFIG file is read when the database environment is
|
|
opened, it will silently overrule configuration done before that time.
|
|
<p>
|
|
This method configures a database environment, including all threads
|
|
of control accessing the database environment, not only the operations
|
|
performed using a specified <a href="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>config</code> - A replication feature to be configured.</dd>
|
|
<dd><code>onoff</code> - If true, the feature is enabled, otherwise it is disabled.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationConfig-com.sleepycat.db.ReplicationConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationConfig</h4>
|
|
<pre class="methodSignature">public boolean getReplicationConfig​(<a href="ReplicationConfig.html" title="class in com.sleepycat.db">ReplicationConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Get the configuration of the replication subsystem.
|
|
This method may be called at any time during the life of the application.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - the feature to be checked</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>Whether the specified feature is enabled or disabled.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationNumSites--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationNumSites</h4>
|
|
<pre class="methodSignature">public int getReplicationNumSites()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Get the number of sites in a replication group.
|
|
Applications using the replication manager API may only call this method
|
|
after replication has been started.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of sites in the replication group</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationTimeout-com.sleepycat.db.ReplicationTimeoutType-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationTimeout</h4>
|
|
<pre class="methodSignature">public void setReplicationTimeout​(<a href="ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type,
|
|
int replicationTimeout)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Sets the timeout applied to the specified timeout type.
|
|
This method may be called at any time during the life of the application.
|
|
<p>
|
|
The database environment's replication subsystem 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 "rep_set_timeout", one or more whitespace characters,
|
|
and the which parameter specified as a string and the timeout specified as two parts.
|
|
Because the DB_CONFIG file is read when the database environment is opened,
|
|
it will silently overrule configuration done before that time.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>type</code> - The type of timeout to set.
|
|
<p></dd>
|
|
<dd><code>replicationTimeout</code> - The time in microseconds of the desired timeout.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationTimeout-com.sleepycat.db.ReplicationTimeoutType-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationTimeout</h4>
|
|
<pre class="methodSignature">public int getReplicationTimeout​(<a href="ReplicationTimeoutType.html" title="class in com.sleepycat.db">ReplicationTimeoutType</a> type)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Gets the timeout applied to the specified timeout type.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>type</code> - The type of timeout to retrieve.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The timeout applied to the specified timout type, in microseconds.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="syncReplication--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>syncReplication</h4>
|
|
<pre class="methodSignature">public void syncReplication()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Forces master synchronization to begin for this client. This method is the other
|
|
half of setting <a href="ReplicationConfig.html#DELAYCLIENT"><code>ReplicationConfig.DELAYCLIENT</code></a> with
|
|
<a href="#setReplicationConfig-com.sleepycat.db.ReplicationConfig-boolean-"><code>setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean)</code></a>.
|
|
<p>
|
|
When a new master is elected and the application has configured delayed
|
|
synchronization, the application must choose when to perform
|
|
synchronization by using this method. Otherwise the client will remain
|
|
unsynchronized and will ignore all new incoming log messages.
|
|
This method may be called any time after the client application learns
|
|
that the new master has been established.
|
|
<p>
|
|
Before calling this method, the enclosing database environment must
|
|
already have been opened and must already have been configured to send replication messages.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="replicationManagerStart-int-com.sleepycat.db.ReplicationManagerStartPolicy-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>replicationManagerStart</h4>
|
|
<pre class="methodSignature">public void replicationManagerStart​(int nthreads,
|
|
<a href="ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db">ReplicationManagerStartPolicy</a> policy)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Starts the replication manager.
|
|
<p>
|
|
The replication manager is implemented inside the Berkeley DB library,
|
|
it is designed to manage a replication group. This includes network
|
|
transport, all replication message processing and acknowledgment, and
|
|
group elections.
|
|
<p>
|
|
For more information on building replication manager applications,
|
|
please see the "Replication Manager Getting Started Guide" included in
|
|
the Berkeley DB documentation.
|
|
<p>
|
|
This method may not be called before the database environment is opened.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>nthreads</code> - Specify the number of threads of control created and dedicated to
|
|
processing replication messages. In addition to these message processing
|
|
threads, the replication manager creates and manages a few of its own
|
|
threads of control.
|
|
<p></dd>
|
|
<dd><code>policy</code> - The policy defines the startup characteristics of a replication group.
|
|
See <a href="ReplicationManagerStartPolicy.html" title="class in com.sleepycat.db"><code>ReplicationManagerStartPolicy</code></a> for more information.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerLocalSite--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerLocalSite</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a> getReplicationManagerLocalSite()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a handle for the local replication site.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a handle for the local replication site</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerSiteList--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerSiteList</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationManagerSiteInfo.html" title="class in com.sleepycat.db">ReplicationManagerSiteInfo</a>[] getReplicationManagerSiteList()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return an array of all the sites known to the replication manager.
|
|
This method may only be called after replication has been started
|
|
using the <a href="#replicationManagerStart-int-com.sleepycat.db.ReplicationManagerStartPolicy-"><code>replicationManagerStart</code></a> method.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>an array of all the sites known to the replication manager</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerSite-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerSite</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a> getReplicationManagerSite​(int eid)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a site known to the replication manager by its eid.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>eid</code> - the site's environment id</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a replication site</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerSite-java.lang.String-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerSite</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationManagerSite.html" title="class in com.sleepycat.db">ReplicationManagerSite</a> getReplicationManagerSite​(java.lang.String host,
|
|
long port)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a site in the replication manager by its host and port.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>host</code> - the site's host name</dd>
|
|
<dd><code>port</code> - the site's port</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a replication site</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="openChannel-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>openChannel</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationChannel.html" title="class in com.sleepycat.db">ReplicationChannel</a> openChannel​(int eid)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Create a channel.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>eid</code> - the environment id of a remote site</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a replication channel</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setReplicationManagerMessageDispatch-com.sleepycat.db.ReplicationManagerMessageDispatch-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setReplicationManagerMessageDispatch</h4>
|
|
<pre class="methodSignature">public void setReplicationManagerMessageDispatch​(<a href="ReplicationManagerMessageDispatch.html" title="interface in com.sleepycat.db">ReplicationManagerMessageDispatch</a> dispatch,
|
|
int flags)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Set the message dispatch function.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dispatch</code> - Application-specific function used to handle messages sent over Replication
|
|
Manager message channels.</dd>
|
|
<dd><code>flags</code> - This flag is DB_REPMGR_NEED_RESPONSE if the message requires a response.
|
|
Otherwise, it is 0.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheStats</h4>
|
|
<pre class="methodSignature">public <a href="CacheStats.html" title="class in com.sleepycat.db">CacheStats</a> getCacheStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Returns the memory pool (that is, the buffer cache) subsystem statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the memory pool (that is, the buffer cache) subsystem statistics.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCacheFileStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCacheFileStats</h4>
|
|
<pre class="methodSignature">public <a href="CacheFileStats.html" title="class in com.sleepycat.db">CacheFileStats</a>[] getCacheFileStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return statistics for individual files in the cache.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>statistics for individual files in the cache.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLogStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLogStats</h4>
|
|
<pre class="methodSignature">public <a href="LogStats.html" title="class in com.sleepycat.db">LogStats</a> getLogStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment's logging statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment's logging statistics.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationStats</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationStats.html" title="class in com.sleepycat.db">ReplicationStats</a> getReplicationStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment's replication statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment's replication statistics.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getReplicationManagerStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getReplicationManagerStats</h4>
|
|
<pre class="methodSignature">public <a href="ReplicationManagerStats.html" title="class in com.sleepycat.db">ReplicationManagerStats</a> getReplicationManagerStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment's replication manager statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment's replication manager statistics.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLockStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLockStats</h4>
|
|
<pre class="methodSignature">public <a href="LockStats.html" title="class in com.sleepycat.db">LockStats</a> getLockStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment's locking statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The locking statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment's locking statistics.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMutexStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMutexStats</h4>
|
|
<pre class="methodSignature">public <a href="MutexStats.html" title="class in com.sleepycat.db">MutexStats</a> getMutexStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment's mutex statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment's mutex statistics.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getTransactionStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getTransactionStats</h4>
|
|
<pre class="methodSignature">public <a href="TransactionStats.html" title="class in com.sleepycat.db">TransactionStats</a> getTransactionStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database environment's transactional statistics.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The transactional statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The database environment's transactional statistics.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printMempStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printMempStats</h4>
|
|
<pre class="methodSignature">public int printMempStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the cache subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printLogStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printLogStats</h4>
|
|
<pre class="methodSignature">public int printLogStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the logging subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printReplicationStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printReplicationStats</h4>
|
|
<pre class="methodSignature">public int printReplicationStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the replication subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printReplicationManagerStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printReplicationManagerStats</h4>
|
|
<pre class="methodSignature">public int printReplicationManagerStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the Replication Manager subsystem statistical information to a
|
|
specified output channel (see the setMsgfile() method for more
|
|
information), or passed to an application callback function (see the
|
|
setMsgcall() method for more information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printLockStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printLockStats</h4>
|
|
<pre class="methodSignature">public int printLockStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the locking subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printMutexStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printMutexStats</h4>
|
|
<pre class="methodSignature">public int printMutexStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the mutex subsystem statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printStats</h4>
|
|
<pre class="methodSignature">public int printStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print environment statistical information to a specified output
|
|
channel (see the setMsgfile() method for more information), or passed to an
|
|
application callback function (see the setMsgcall() method for more
|
|
information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="printTransactionStats-com.sleepycat.db.StatsConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>printTransactionStats</h4>
|
|
<pre class="methodSignature">public int printTransactionStats​(<a href="StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Print the transaction subsystem statistical information to a specified
|
|
output channel (see the setMsgfile() method for more information), or
|
|
passed to an application callback function (see the setMsgcall() method
|
|
for more information).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The statistics attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A non-zero error value on failure and 0 on success.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="beginCDSGroup--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>beginCDSGroup</h4>
|
|
<pre class="methodSignature">public <a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> beginCDSGroup()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Allocate a locker ID in an environment configured for Berkeley DB
|
|
Concurrent Data Store applications. Returns a <a href="Transaction.html" title="class in com.sleepycat.db"><code>Transaction</code></a> object
|
|
that uniquely identifies the locker ID. Calling the <a href="Transaction.html#commit--"><code>Transaction.commit()</code></a> method will discard the allocated locker ID.
|
|
<p>
|
|
See
|
|
<a href="../../../../programmer_reference/cam.html#cam_intro" target="_top">Berkeley DB Concurrent Data Store applications</a>
|
|
for more information about when this is required.
|
|
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>A transaction handle that wraps a CDS locker ID.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="beginTransaction-com.sleepycat.db.Transaction-com.sleepycat.db.TransactionConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>beginTransaction</h4>
|
|
<pre class="methodSignature">public <a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> beginTransaction​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> parent,
|
|
<a href="TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Create a new transaction in the database environment.
|
|
<p>
|
|
Transactions may only span threads if they do so serially; that is,
|
|
each transaction must be active in only a single thread of control
|
|
at a time.
|
|
<p>
|
|
This restriction holds for parents of nested transactions as well;
|
|
no two children may be concurrently active in more than one thread
|
|
of control at any one time.
|
|
<p>
|
|
Cursors may not span transactions; that is, each cursor must be opened
|
|
and closed within a single transaction.
|
|
<p>
|
|
A parent transaction may not issue any Berkeley DB operations --
|
|
except for <a href="#beginTransaction-com.sleepycat.db.Transaction-com.sleepycat.db.TransactionConfig-"><code>Environment.beginTransaction</code></a>,
|
|
<a href="Transaction.html#abort--"><code>Transaction.abort</code></a> and <a href="Transaction.html#commit--"><code>Transaction.commit</code></a> --
|
|
while it has active child transactions (child transactions that have
|
|
not yet been committed or aborted).
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>parent</code> - If the parent parameter is non-null, the new transaction will be a
|
|
nested transaction, with the transaction indicated by parent as its
|
|
parent. Transactions may be nested to any level. In the presence
|
|
of distributed transactions and two-phase commit, only the parental
|
|
transaction, that is a transaction without a parent specified,
|
|
should be passed as an parameter to <a href="Transaction.html#prepare-byte:A-"><code>Transaction.prepare</code></a>.
|
|
<p></dd>
|
|
<dd><code>config</code> - The transaction attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The newly created transaction's handle.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="checkpoint-com.sleepycat.db.CheckpointConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>checkpoint</h4>
|
|
<pre class="methodSignature">public void checkpoint​(<a href="CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Synchronously checkpoint the database environment.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The checkpoint attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="logFlush-com.sleepycat.db.LogSequenceNumber-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>logFlush</h4>
|
|
<pre class="methodSignature">public void logFlush​(<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> lsn)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Flush log records to stable storage.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>lsn</code> - All log records with LogSequenceNumber values less than or equal to
|
|
the lsn parameter are written to stable storage. If lsn is null,
|
|
all records in the log are flushed.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="logPut-com.sleepycat.db.DatabaseEntry-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>logPut</h4>
|
|
<pre class="methodSignature">public <a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> logPut​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
boolean flush)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Append a record to the log.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>data</code> - The record to append to the log.
|
|
<p>
|
|
The caller is responsible for providing any necessary structure to
|
|
data. (For example, in a write-ahead logging protocol, the
|
|
application must understand what part of data is an operation code,
|
|
what part is redo information, and what part is undo information.
|
|
In addition, most transaction managers will store in data the
|
|
LogSequenceNumber of the previous log record for the same
|
|
transaction, to support chaining back through the transaction's log
|
|
records during undo.)
|
|
<p></dd>
|
|
<dd><code>flush</code> - The log is forced to disk after this record is written, guaranteeing
|
|
that all records with LogSequenceNumber values less than or equal
|
|
to the one being "put" are on disk before this method returns.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The LogSequenceNumber of the put record.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="logPrint-com.sleepycat.db.Transaction-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>logPrint</h4>
|
|
<pre class="methodSignature">public void logPrint​(<a href="Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
|
|
java.lang.String message)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Append an informational message to the Berkeley DB database environment log files.
|
|
<p>
|
|
This method allows applications to include information in
|
|
the database environment log files, for later review using the
|
|
<a href="../../../../api_reference/C/db_printlog.html" target="_top">db_printlog</a>
|
|
utility. This method is intended for debugging and performance tuning.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>txn</code> - If the logged message refers to an application-specified transaction,
|
|
the <code>txn</code> parameter is a transaction handle, otherwise
|
|
<code>null</code>.
|
|
<p></dd>
|
|
<dd><code>message</code> - the message
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getArchiveLogFiles-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getArchiveLogFiles</h4>
|
|
<pre class="methodSignature">public java.io.File[] getArchiveLogFiles​(boolean includeInUse)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return an array of log files.
|
|
<p>
|
|
When Replication Manager is in use, log archiving is performed in a
|
|
replication group-aware manner such that the log file status of other sites
|
|
in the group is considered to determine if a log file is in use.
|
|
<p>
|
|
Log cursor handles (returned by the
|
|
<a href="#openLogCursor--"><code>openLogCursor() method</code></a> may
|
|
have open file descriptors for log files in the database environment. Also,
|
|
the Berkeley DB interfaces to the database environment logging subsystem (for
|
|
example, <a href="#logPut-com.sleepycat.db.DatabaseEntry-boolean-"><code>logPut</code></a> and
|
|
<a href="Transaction.html#abort--"><code>Transaction.abort</code></a> may allocate log
|
|
cursors and have open file descriptors for log files as well. On operating
|
|
systems where filesystem related system calls (for example, rename and unlink
|
|
on Windows/NT) can fail if a process has an open file descriptor for the
|
|
affected file, attempting to move or remove returned log files may fail. All
|
|
Berkeley DB internal use of log cursors operates on active log files only and
|
|
furthermore, is short-lived in nature. So, an application seeing such a
|
|
failure should be restructured to close any open log cursors it may have, and
|
|
otherwise to retry the operation until it succeeds. (Although the latter is
|
|
not likely to be necessary; it is hard to imagine a reason to move or rename
|
|
a log file in which transactions are being logged or aborted.)
|
|
<p>
|
|
See
|
|
<a href="../../../../api_reference/C/db_archive.html" target="_top">db_archive</a>
|
|
for more information on database archival procedures.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>includeInUse</code> - if true, all log files, regardless of whether or not they
|
|
are in use, are returned. Otherwise, the log files that are no longer in use
|
|
(for example, that are no longer involved in active transactions), and that
|
|
may safely be archived for catastrophic recovery and then removed from the
|
|
system.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>An array of log files</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getArchiveDatabases--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getArchiveDatabases</h4>
|
|
<pre class="methodSignature">public java.io.File[] getArchiveDatabases()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the database files that need to be archived in order to recover the
|
|
database from catastrophic failure. If any of the database files have not
|
|
been accessed during the lifetime of the current log files, they will not be
|
|
returned. It is also possible that some of the files referred to by the log
|
|
have since been deleted from the system.
|
|
<p>
|
|
When Replication Manager is in use, log archiving is performed in a
|
|
replication group-aware manner such that the log file status of other sites
|
|
in the group is considered to determine if a log file is in use.
|
|
<p>
|
|
See
|
|
<a href="../../../../api_reference/C/db_archive.html" target="_top">db_archive</a>
|
|
for more information on database archival procedures.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>An array of database files</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="removeOldLogFiles--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>removeOldLogFiles</h4>
|
|
<pre class="methodSignature">public void removeOldLogFiles()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Remove log files that are no longer needed.
|
|
<p>
|
|
Automatic log file removal is likely to make catastrophic recovery
|
|
impossible.
|
|
<p>
|
|
When Replication Manager is in use, log archiving is performed in a
|
|
replication group-aware manner such that the log file status of other sites
|
|
in the group is considered to determine if a log file is in use.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="recover-int-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>recover</h4>
|
|
<pre class="methodSignature">public <a href="PreparedTransaction.html" title="class in com.sleepycat.db">PreparedTransaction</a>[] recover​(int count,
|
|
boolean continued)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Environment recovery restores transactions that were prepared, but not yet
|
|
resolved at the time of the system shut down or crash, to their state prior
|
|
to the shut down or crash, including any locks previously held. This method
|
|
returns a list of those prepared transactions.
|
|
<p>
|
|
This method should only be called after the environment has been recovered.
|
|
<p>
|
|
Multiple threads of control may call this method, but only one thread of
|
|
control may resolve each returned transaction, that is, only one thread of
|
|
control may call
|
|
<a href="Transaction.html#commit--"><code>Transaction.commit()</code></a> or
|
|
<a href="Transaction.html#abort--"><code>Transaction.abort()</code></a> each returned
|
|
transaction. Callers must call
|
|
<a href="Transaction.html#discard--"><code>Transaction.discard()</code></a> to discard
|
|
each transaction they do not resolve.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>count</code> - the number of transactions returned</dd>
|
|
<dd><code>continued</code> - if set to false, return the first count number of transactions;
|
|
if set to true, continue to return the next count number of transactions</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a list of <a href="PreparedTransaction.html" title="class in com.sleepycat.db"><code>transactions</code></a>
|
|
that must be resolved by the application (committed, aborted or discarded).</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="resetFileID-java.lang.String-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>resetFileID</h4>
|
|
<pre class="methodSignature">public void resetFileID​(java.lang.String filename,
|
|
boolean encrypted)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Allows database files to be copied, and then the copy used in the same
|
|
database environment as the original.
|
|
<p>
|
|
All databases contain an ID string used to identify the database in the
|
|
database environment cache. If a physical database file is copied, and
|
|
used in the same environment as another file with the same ID strings,
|
|
corruption can occur. This method creates new ID strings for all of
|
|
the databases in the physical file.
|
|
<p>
|
|
This method modifies the physical file, in-place.
|
|
Applications should not reset IDs in files that are currently in use.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>filename</code> - The name of the physical file in which the LSNs are to be cleared.</dd>
|
|
<dd><code>encrypted</code> - Whether the file contains encrypted databases.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="resetLogSequenceNumber-java.lang.String-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>resetLogSequenceNumber</h4>
|
|
<pre class="methodSignature">public void resetLogSequenceNumber​(java.lang.String filename,
|
|
boolean encrypted)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Allows database files to be moved from one transactional database
|
|
environment to another.
|
|
<p>
|
|
Database pages in transactional database environments contain references
|
|
to the environment's log files (that is, log sequence numbers, or LSNs).
|
|
Copying or moving a database file from one database environment to
|
|
another, and then modifying it, can result in data corruption if the
|
|
LSNs are not first cleared.
|
|
<p>
|
|
Note that LSNs should be reset before moving or copying the database
|
|
file into a new database environment, rather than moving or copying the
|
|
database file and then resetting the LSNs. Berkeley DB has consistency checks
|
|
that may be triggered if an application calls this method
|
|
on a database in a new environment when the database LSNs still reflect
|
|
the old environment.
|
|
<p>
|
|
This method modifies the physical file, in-place.
|
|
Applications should not reset LSNs in files that are currently in use.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>filename</code> - The name of the physical file in which the LSNs are to be cleared.</dd>
|
|
<dd><code>encrypted</code> - Whether the file contains encrypted databases.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="panic-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>panic</h4>
|
|
<pre class="methodSignature">public void panic​(boolean onoff)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Set the panic state for the database environment.
|
|
Database environments in a panic state normally refuse all attempts to
|
|
call library functions, throwing a
|
|
<a href="RunRecoveryException.html" title="class in com.sleepycat.db"><code>RunRecoveryException</code></a>.
|
|
<p>
|
|
This method configures a database environment, including all threads of
|
|
control accessing the database environment, not only the operations
|
|
performed using a specified
|
|
<a href="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>onoff</code> - If true, set the panic state for the database environment.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="backup-java.lang.String-com.sleepycat.db.BackupOptions-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>backup</h4>
|
|
<pre class="methodSignature">public void backup​(java.lang.String target,
|
|
<a href="BackupOptions.html" title="class in com.sleepycat.db">BackupOptions</a> opt)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Perform a hot back up of the open environment.
|
|
<p>
|
|
All files used by the environment are backed up, so long as the normal
|
|
rules for file placement are followed. For information on how files
|
|
are normally placed relative to the environment directory, see the
|
|
<a href="../../../../programmer_reference/env_naming.html" target="_top">
|
|
Berkeley DB File Naming
|
|
</a> section in the <i>Berkeley DB Reference Guide</i>.
|
|
<p>
|
|
By default, data directories and the log directory specified relative
|
|
to the home directory will be recreated relative to the target
|
|
directory. If absolute path names are used, then
|
|
use the <a href="BackupOptions.html#setSingleDir-boolean-"><code>BackupOptions.setSingleDir</code></a>
|
|
method.
|
|
<p>
|
|
This method provides the same functionality as the
|
|
<a href="../../../../api_reference/C/db_hotbackup.html" target="_top">db_hotbackup</a>
|
|
utility. However, this method does not perform the housekeeping
|
|
actions performed by that utility. In particular, you may
|
|
want to run a checkpoint before calling this method. To run a
|
|
checkpoint, use the
|
|
<a href="#checkpoint-com.sleepycat.db.CheckpointConfig-"><code>Environment.checkpoint</code></a>
|
|
method. For more information on checkpoints, see the
|
|
<a href="../../../../programmer_reference/transapp_checkpoint.html" target="_top">Checkpoint</a>
|
|
section in the Berkeley DB Reference Guide.
|
|
<p>
|
|
To back up a single database file within the environment, use the
|
|
<a href="#backupDatabase-java.lang.String-java.lang.String-boolean-"><code>Environment.backupDatabase</code></a>
|
|
method.
|
|
<p>
|
|
In addition to the configuration options available using the
|
|
<a href="BackupOptions.html" title="class in com.sleepycat.db"><code>BackupOptions</code></a>
|
|
class, additional tuning modifications can be made using the
|
|
<a href="EnvironmentConfig.html#setBackupReadCount-int-"><code>EnvironmentConfig.setBackupReadCount</code></a>,
|
|
<a href="EnvironmentConfig.html#setBackupReadSleep-int-"><code>EnvironmentConfig.setBackupReadSleep</code></a>,
|
|
<a href="EnvironmentConfig.html#setBackupSize-int-"><code>EnvironmentConfig.setBackupSize</code></a>, and
|
|
<a href="EnvironmentConfig.html#setBackupWriteDirect-boolean-"><code>EnvironmentConfig.setBackupWriteDirect</code></a>
|
|
methods. Alternatively, you can write your own custom hot back up facility using the
|
|
<a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> interface.
|
|
<p>
|
|
This method may only be called after the environment has been opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>target</code> - Identifies the directory in which the back up will be placed. Any
|
|
subdirectories required to contain the back up must be placed relative
|
|
to this directory. Note that if a
|
|
<a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> is configured for the
|
|
environment, then the
|
|
value specified to this parameter is passed on to the
|
|
<a href="BackupHandler.html#open-java.lang.String-java.lang.String-"><code>BackupHandler.open</code></a>
|
|
method.
|
|
If this parameter is null, then the target must be specified
|
|
to the
|
|
<a href="BackupHandler.html#open-java.lang.String-java.lang.String-"><code>BackupHandler.open</code></a>
|
|
method.
|
|
<p>
|
|
This directory, and any required subdirectories, will be created for
|
|
you if you specify true for the
|
|
<a href="BackupOptions.html#setAllowCreate-boolean-"><code>BackupOptions.setAllowCreate</code></a>
|
|
method. Otherwise, if the target does not exist, this method
|
|
throws a
|
|
<a href="DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> exception.
|
|
<p></dd>
|
|
<dd><code>opt</code> - The <a href="BackupOptions.html" title="class in com.sleepycat.db"><code>BackupOptions</code></a> instance used to
|
|
configure the hot back up.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs at any point during the back up.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="backupDatabase-java.lang.String-java.lang.String-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>backupDatabase</h4>
|
|
<pre class="methodSignature">public void backupDatabase​(java.lang.String dbfile,
|
|
java.lang.String target,
|
|
boolean exclusiveCreate)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Perform a hot back up of a single database file contained within the environment.
|
|
<p>
|
|
To back up the entire environment, use the
|
|
<a href="#backup-java.lang.String-com.sleepycat.db.BackupOptions-"><code>Environment.backup</code></a>
|
|
method.
|
|
<p>
|
|
You can make some tuning modifications to the backup process using the
|
|
<a href="EnvironmentConfig.html#setBackupReadCount-int-"><code>EnvironmentConfig.setBackupReadCount</code></a>,
|
|
<a href="EnvironmentConfig.html#setBackupReadSleep-int-"><code>EnvironmentConfig.setBackupReadSleep</code></a>,
|
|
<a href="EnvironmentConfig.html#setBackupSize-int-"><code>EnvironmentConfig.setBackupSize</code></a>, and
|
|
<a href="EnvironmentConfig.html#setBackupWriteDirect-boolean-"><code>EnvironmentConfig.setBackupWriteDirect</code></a>
|
|
methods. Alternatively, you can write your own custom hot back up facility using the
|
|
<a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> interface.
|
|
<p>
|
|
This method may only be called after the environment has been opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>dbfile</code> - The database file that you want to back up.
|
|
<p></dd>
|
|
<dd><code>target</code> - Identifies the directory in which the back up will be placed.
|
|
The target must exist; otherwise this method throws a
|
|
<a href="DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> exception.
|
|
Note that if a
|
|
<a href="BackupHandler.html" title="interface in com.sleepycat.db"><code>BackupHandler</code></a> is configured for the
|
|
environment, then the
|
|
value specified to this parameter is passed on to the
|
|
<a href="BackupHandler.html#open-java.lang.String-java.lang.String-"><code>BackupHandler.open</code></a>
|
|
method.
|
|
If this parameter is null, then the target must be specified
|
|
to the
|
|
<a href="BackupHandler.html#open-java.lang.String-java.lang.String-"><code>BackupHandler.open</code></a>
|
|
method.
|
|
<p></dd>
|
|
<dd><code>exclusiveCreate</code> - If true, then if the target file exists, this method throws a
|
|
<a href="DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> exception.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs at any point during the back up.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionString--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionString</h4>
|
|
<pre class="methodSignature">public static java.lang.String getVersionString()</pre>
|
|
<div class="block">Return the release version information, suitable for display.
|
|
<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 release version information, suitable for display.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionFullString--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionFullString</h4>
|
|
<pre class="methodSignature">public static java.lang.String getVersionFullString()</pre>
|
|
<div class="block">Return the full release version information, suitable for display.
|
|
<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 full release version information, suitable for display.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionFamily--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionFamily</h4>
|
|
<pre class="methodSignature">public static int getVersionFamily()</pre>
|
|
<div class="block">Return the release's Oracle family number.
|
|
<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 release's Oracle family number.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionRelease--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionRelease</h4>
|
|
<pre class="methodSignature">public static int getVersionRelease()</pre>
|
|
<div class="block">Return the release's Oracle release number.
|
|
<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 release's Oracle release number.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionMajor--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionMajor</h4>
|
|
<pre class="methodSignature">public static int getVersionMajor()</pre>
|
|
<div class="block">Return the release major number.
|
|
<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 release major number.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="syncCache-com.sleepycat.db.LogSequenceNumber-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>syncCache</h4>
|
|
<pre class="methodSignature">public void syncCache​(<a href="LogSequenceNumber.html" title="class in com.sleepycat.db">LogSequenceNumber</a> logSequenceNumber)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Ensure that all modified pages in the cache are flushed to their backing files.
|
|
<p>
|
|
Pages in the cache that cannot be immediately written back to disk (for example
|
|
pages that are currently in use by another thread of control) are waited for
|
|
and written to disk as soon as it is possible to do so.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>logSequenceNumber</code> - The purpose of the logSequenceNumber parameter is to enable a transaction
|
|
manager to ensure, as part of a checkpoint, that all pages modified by a
|
|
certain time have been written to disk.
|
|
<p>
|
|
All modified pages with a log sequence number less than the logSequenceNumber
|
|
parameter are written to disk. If logSequenceNumber is null, all modified
|
|
pages in the cache are written to disk.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="isTransactionApplied-byte:A-int-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>isTransactionApplied</h4>
|
|
<pre class="methodSignature">public <a href="TransactionStatus.html" title="class in com.sleepycat.db">TransactionStatus</a> isTransactionApplied​(byte[] token,
|
|
int maxwait)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return whether the transaction referred to by the commit token "token" has
|
|
been applied at the local replication environment.
|
|
<p>
|
|
This method may not be called before the database environment is opened.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>token</code> - the commit token
|
|
<p></dd>
|
|
<dd><code>maxwait</code> - The maximum time to wait for the transaction to arrive by replication,
|
|
expressed in microseconds. To check the status of the transaction
|
|
without waiting, the timeout may be specified as 0.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>TransactionStatus indicating the status of the applicaton of the transaction.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionMinor--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionMinor</h4>
|
|
<pre class="methodSignature">public static int getVersionMinor()</pre>
|
|
<div class="block">Return the release minor number.
|
|
<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 release minor number.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getVersionPatch--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVersionPatch</h4>
|
|
<pre class="methodSignature">public static int getVersionPatch()</pre>
|
|
<div class="block">Return the release patch number.
|
|
<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 release patch number.</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)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></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 external file threshold size.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</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)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Set the external file threshold size.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The external file threshold size.
|
|
<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></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</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)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Sets the path of a file to store statistical information.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>file</code> - The path of a file to store statistical information.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSliceCount--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSliceCount</h4>
|
|
<pre class="methodSignature">public int getSliceCount()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Get the number of slices in the environment.
|
|
<p>
|
|
Returns the number of slice environments configured for this
|
|
environment.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The number of slice environments.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSlices--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSlices</h4>
|
|
<pre class="methodSignature">public <a href="Environment.html" title="class in com.sleepycat.db">Environment</a>[] getSlices()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Gets the Environment handles for the underlying slice environments.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>An array of the Environment handles. There is one handle for each slice.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="slices_enabled--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>slices_enabled</h4>
|
|
<pre class="methodSignature">public static boolean slices_enabled()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></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/Environment.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>
|