greg/stasis
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
stasis/je-7.5.11/docs/java/com/sleepycat/je/util/DbScavenger.html
Greg Burd 1d088e4a23 initial import
2019-06-25 16:12:40 -04:00

371 lines
16 KiB
HTML
Raw Blame History

<!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 (1.8.0_151) on Tue Oct 31 17:36:46 EDT 2017 -->
<title>DbScavenger (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../../style.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DbScavenger (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= 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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DbScavenger.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 Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/sleepycat/je/util/DbPrintLog.html" title="class in com.sleepycat.je.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/sleepycat/je/util/DbSpace.html" title="class in com.sleepycat.je.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/je/util/DbScavenger.html" target="_top">Frames</a></li>
<li><a href="DbScavenger.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.sleepycat.je.util.DbDump">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.je.util</div>
<h2 title="Class DbScavenger" class="title">Class DbScavenger</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../com/sleepycat/je/util/DbDump.html" title="class in com.sleepycat.je.util">com.sleepycat.je.util.DbDump</a></li>
<li>
<ul class="inheritance">
<li>com.sleepycat.je.util.DbScavenger</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DbScavenger</span>
extends <a href="../../../../com/sleepycat/je/util/DbDump.html" title="class in com.sleepycat.je.util">DbDump</a></pre>
<div class="block">Used to retrieve as much data as possible from a corrupted environment.
This utility is meant to be used programmatically, and is the equivalent
to the -R or -r options for <a href="../../../../com/sleepycat/je/util/DbDump.html" title="class in com.sleepycat.je.util"><code>DbDump</code></a>.
<p>
To scavenge a database:
<pre>
DbScavenger scavenger =
new DbScavenger(env, outputDirectory, <boolean>, <boolean>, <boolean>);
scavenger.dump();
</pre>
<p>
The recovered databases will put placed in the outputDirectory with ".dump"
file suffixes. The format of the .dump files will be suitable for use with
DbLoad.</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.sleepycat.je.util.DbDump">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.sleepycat.je.util.<a href="../../../../com/sleepycat/je/util/DbDump.html" title="class in com.sleepycat.je.util">DbDump</a></h3>
<code><a href="../../../../com/sleepycat/je/util/DbDump.html#dbName">dbName</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#doAggressiveScavengerRun">doAggressiveScavengerRun</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#doScavengerRun">doScavengerRun</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#env">env</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#envHome">envHome</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#formatUsingPrintable">formatUsingPrintable</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#outputDirectory">outputDirectory</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#outputFile">outputFile</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#verbose">verbose</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/util/DbScavenger.html#DbScavenger-com.sleepycat.je.Environment-java.lang.String-boolean-boolean-boolean-">DbScavenger</a></span>(<a href="../../../../com/sleepycat/je/Environment.html" title="class in com.sleepycat.je">Environment</a>&nbsp;env,
java.lang.String&nbsp;outputDirectory,
boolean&nbsp;formatUsingPrintable,
boolean&nbsp;doAggressiveScavengerRun,
boolean&nbsp;verbose)</code>
<div class="block">Create a DbScavenger object for a specific environment.</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" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/util/DbScavenger.html#dump--">dump</a></span>()</code>
<div class="block">Start the scavenger run.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/sleepycat/je/util/DbScavenger.html#setDumpCorruptedBounds-boolean-">setDumpCorruptedBounds</a></span>(boolean&nbsp;dumpCorruptedBounds)</code>
<div class="block">Set to true if corrupted boundaries should be dumped out.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.je.util.DbDump">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.sleepycat.je.util.<a href="../../../../com/sleepycat/je/util/DbDump.html" title="class in com.sleepycat.je.util">DbDump</a></h3>
<code><a href="../../../../com/sleepycat/je/util/DbDump.html#dumpOne-java.io.PrintStream-byte:A-boolean-">dumpOne</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#main-java.lang.String:A-">main</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#openEnv-boolean-">openEnv</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#parseArgs-java.lang.String:A-">parseArgs</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#printHeader-java.io.PrintStream-boolean-boolean-">printHeader</a>, <a href="../../../../com/sleepycat/je/util/DbDump.html#printUsage-java.lang.String-">printUsage</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DbScavenger-com.sleepycat.je.Environment-java.lang.String-boolean-boolean-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DbScavenger</h4>
<pre>public&nbsp;DbScavenger(<a href="../../../../com/sleepycat/je/Environment.html" title="class in com.sleepycat.je">Environment</a>&nbsp;env,
java.lang.String&nbsp;outputDirectory,
boolean&nbsp;formatUsingPrintable,
boolean&nbsp;doAggressiveScavengerRun,
boolean&nbsp;verbose)</pre>
<div class="block">Create a DbScavenger object for a specific environment.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - The Environment containing the database to dump.</dd>
<dd><code>outputDirectory</code> - The directory to create the .dump files in.</dd>
<dd><code>formatUsingPrintable</code> - true if the dump should use printable
characters.</dd>
<dd><code>doAggressiveScavengerRun</code> - true if true, then all data records are
dumped, regardless of whether they are the latest version or not.</dd>
<dd><code>verbose</code> - true if status output should be written to System.out
during scavenging.</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="setDumpCorruptedBounds-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDumpCorruptedBounds</h4>
<pre>public&nbsp;void&nbsp;setDumpCorruptedBounds(boolean&nbsp;dumpCorruptedBounds)</pre>
<div class="block">Set to true if corrupted boundaries should be dumped out.</div>
</li>
</ul>
<a name="dump--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dump</h4>
<pre>public&nbsp;void&nbsp;dump()
throws <a href="../../../../com/sleepycat/je/EnvironmentNotFoundException.html" title="class in com.sleepycat.je">EnvironmentNotFoundException</a>,
<a href="../../../../com/sleepycat/je/EnvironmentLockedException.html" title="class in com.sleepycat.je">EnvironmentLockedException</a>,
java.io.IOException</pre>
<div class="block">Start the scavenger run.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../com/sleepycat/je/util/DbDump.html#dump--">dump</a></code>&nbsp;in class&nbsp;<code><a href="../../../../com/sleepycat/je/util/DbDump.html" title="class in com.sleepycat.je.util">DbDump</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - in subclasses.</dd>
<dd><code><a href="../../../../com/sleepycat/je/EnvironmentNotFoundException.html" title="class in com.sleepycat.je">EnvironmentNotFoundException</a></code></dd>
<dd><code><a href="../../../../com/sleepycat/je/EnvironmentLockedException.html" title="class in com.sleepycat.je">EnvironmentLockedException</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="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DbScavenger.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 Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/sleepycat/je/util/DbPrintLog.html" title="class in com.sleepycat.je.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/sleepycat/je/util/DbSpace.html" title="class in com.sleepycat.je.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/sleepycat/je/util/DbScavenger.html" target="_top">Frames</a></li>
<li><a href="DbScavenger.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.sleepycat.je.util.DbDump">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>
Reference in a new issue View git blame Copy permalink