Files
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

575 lines
20 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>CompactConfig (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="CompactConfig (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};
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";
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/CompactConfig.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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 ========= -->
</div>
<div class="navPadding">&nbsp;</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>&nbsp;<a href="package-summary.html">com.sleepycat.db</a></div>
<h2 title="Class CompactConfig" class="title">Class CompactConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.CompactConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Cloneable</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">CompactConfig</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Configuration for <a href="Database.html#compact-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.CompactConfig-"><code>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</code></a> operations.</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">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th>
<td class="colLast">
<div class="block">Default configuration used if null is passed to methods that create a
cursor.</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">&nbsp;</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="#CompactConfig--">CompactConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">Construct a default configuration object for compact operations.</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">&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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFillPercent--">getFillPercent</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the the desired fill percentage.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFreeListOnly--">getFreeListOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the whether to skip page compaction.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFreeSpace--">getFreeSpace</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the whether to return pages to the filesystem.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxPages--">getMaxPages</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the the maximum number of pages to free.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimeout--">getTimeout</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the the lock timeout set for implicit transactions, in microseconds.</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="#setFillPercent-int-">setFillPercent</a></span>&#8203;(int&nbsp;fillpercent)</code></th>
<td class="colLast">
<div class="block">Set the desired fill percentage.</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="#setFreeListOnly-boolean-">setFreeListOnly</a></span>&#8203;(boolean&nbsp;freeListOnly)</code></th>
<td class="colLast">
<div class="block">Configure whether to skip page compaction, only returning pages
to the filesystem that are already free and at the end of the file.</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="#setFreeSpace-boolean-">setFreeSpace</a></span>&#8203;(boolean&nbsp;freeSpace)</code></th>
<td class="colLast">
<div class="block">Return pages to the filesystem if possible.</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="#setMaxPages-int-">setMaxPages</a></span>&#8203;(int&nbsp;maxPages)</code></th>
<td class="colLast">
<div class="block">Set the maximum number of pages to free.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTimeout-int-">setTimeout</a></span>&#8203;(int&nbsp;timeout)</code></th>
<td class="colLast">
<div class="block">Set the lock timeout for implicit transactions.</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&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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT</h4>
<pre>public static final&nbsp;<a href="CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</a> DEFAULT</pre>
<div class="block">Default configuration used if null is passed to methods that create a
cursor.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CompactConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompactConfig</h4>
<pre>public&nbsp;CompactConfig()</pre>
<div class="block">Construct a default configuration object for compact operations.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setFillPercent-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFillPercent</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFillPercent&#8203;(int&nbsp;fillpercent)</pre>
<div class="block">Set the desired fill percentage.
If non-zero, the goal for filling pages, specified as a percentage
between 1 and 100. Any page in a Btree or Recno databases not at or
above this percentage full will be considered for compaction. The
default behavior is to consider every page for compaction, regardless
of its page fill percentage.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fillpercent</code> - The desired fill percentage.</dd>
</dl>
</li>
</ul>
<a name="getFillPercent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFillPercent</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getFillPercent()</pre>
<div class="block">Return the the desired fill percentage.
<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 the desired fill percentage.</dd>
</dl>
</li>
</ul>
<a name="setFreeListOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFreeListOnly</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFreeListOnly&#8203;(boolean&nbsp;freeListOnly)</pre>
<div class="block">Configure whether to skip page compaction, only returning pages
to the filesystem that are already free and at the end of the file.
This flag must be set if the database is a Hash access method database.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>freeListOnly</code> - Whether to skip page compaction</dd>
</dl>
</li>
</ul>
<a name="getFreeListOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFreeListOnly</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getFreeListOnly()</pre>
<div class="block">Return true if the whether to skip page compaction.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the whether to skip page compaction.</dd>
</dl>
</li>
</ul>
<a name="setFreeSpace-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFreeSpace</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFreeSpace&#8203;(boolean&nbsp;freeSpace)</pre>
<div class="block">Return pages to the filesystem if possible. If this flag is not
specified, pages emptied as a result of compaction will be placed on the
free list for re-use, but not returned to the filesystem.
Note that only pages at the end of the file may be returned. Given the one
pass nature of the algorithm if a page near the end of the file is
logically near the begining of the btree it will inhibit returning pages to
the file system.
A second call to the method with a low fillfactor can be used to return
pages in such a situation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>freeSpace</code> - Whether to return pages to the filesystem</dd>
</dl>
</li>
</ul>
<a name="getFreeSpace--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFreeSpace</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getFreeSpace()</pre>
<div class="block">Return true if the whether to return pages to the filesystem.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the whether to return pages to the filesystem.</dd>
</dl>
</li>
</ul>
<a name="setMaxPages-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxPages</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMaxPages&#8203;(int&nbsp;maxPages)</pre>
<div class="block">Set the maximum number of pages to free.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxPages</code> - If non-zero, the call will return after that number of pages have been
freed.</dd>
</dl>
</li>
</ul>
<a name="getMaxPages--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxPages</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getMaxPages()</pre>
<div class="block">Return the the maximum number of pages to free.
<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 the maximum number of pages to free.</dd>
</dl>
</li>
</ul>
<a name="setTimeout-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTimeout</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTimeout&#8203;(int&nbsp;timeout)</pre>
<div class="block">Set the lock timeout for implicit transactions.
If non-zero, and no transaction parameter was specified to
<a href="Database.html#compact-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.CompactConfig-"><code>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</code></a>, the lock timeout set for implicit
transactions, in microseconds.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timeout</code> - the lock timeout set for implicit transactions, in microseconds.</dd>
</dl>
</li>
</ul>
<a name="getTimeout--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTimeout</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getTimeout()</pre>
<div class="block">Return the the lock timeout set for implicit transactions, in microseconds.
<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 the lock timeout set for implicit transactions, in microseconds.</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/CompactConfig.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&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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">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><a href="#field.detail">Field</a>&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) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>