632 lines
26 KiB
HTML
632 lines
26 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 (1.8.0_151) on Tue Oct 31 17:36:45 EDT 2017 -->
|
||
|
<title>PreloadConfig (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="PreloadConfig (Oracle - Berkeley DB Java Edition API)";
|
||
|
}
|
||
|
}
|
||
|
catch(err) {
|
||
|
}
|
||
|
//-->
|
||
|
var methods = {"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};
|
||
|
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/PreloadConfig.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/PartialComparator.html" title="interface in com.sleepycat.je"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
<li><a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../index.html?com/sleepycat/je/PreloadConfig.html" target="_top">Frames</a></li>
|
||
|
<li><a href="PreloadConfig.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
<li><a href="../../../allclasses-noframe.html">All 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: </li>
|
||
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
||
|
<li>Field | </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>Field | </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 ========= -->
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<div class="header">
|
||
|
<div class="subTitle">com.sleepycat.je</div>
|
||
|
<h2 title="Class PreloadConfig" class="title">Class PreloadConfig</h2>
|
||
|
</div>
|
||
|
<div class="contentContainer">
|
||
|
<ul class="inheritance">
|
||
|
<li>java.lang.Object</li>
|
||
|
<li>
|
||
|
<ul class="inheritance">
|
||
|
<li>com.sleepycat.je.PreloadConfig</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<div class="description">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<dl>
|
||
|
<dt>All Implemented Interfaces:</dt>
|
||
|
<dd>java.lang.Cloneable</dd>
|
||
|
</dl>
|
||
|
<hr>
|
||
|
<br>
|
||
|
<pre>public class <span class="typeNameLabel">PreloadConfig</span>
|
||
|
extends java.lang.Object
|
||
|
implements java.lang.Cloneable</pre>
|
||
|
<div class="block">Specifies the attributes of an application invoked preload operation.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="summary">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="nested.class.summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Nested Class Summary</h3>
|
||
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
|
||
|
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colLast" scope="col">Class and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>static class </code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je">PreloadConfig.Phases</a></span></code>
|
||
|
<div class="block">Preload progress listeners report this phase value, along with a
|
||
|
count of the number if times that the preload has fetched from disk.</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" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||
|
<caption><span>Constructors</span><span class="tabEnd"> </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/PreloadConfig.html#PreloadConfig--">PreloadConfig</a></span>()</code>
|
||
|
<div class="block">Default configuration used if null is passed to <a href="../../../com/sleepycat/je/Database.html#preload-long-"><code>Database.preload</code></a>.</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"> </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></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><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#clone--">clone</a></span>()</code>
|
||
|
<div class="block">Returns a copy of this configuration object.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i1" class="rowColor">
|
||
|
<td class="colFirst"><code>long</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#getInternalMemoryLimit--">getInternalMemoryLimit</a></span>()</code>
|
||
|
<div class="block">Returns the maximum amount of non JE Cache Memory that preload can use at
|
||
|
one time.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i2" class="altColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#getLoadLNs--">getLoadLNs</a></span>()</code>
|
||
|
<div class="block">Return the configuration of the preload load LNs option.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i3" class="rowColor">
|
||
|
<td class="colFirst"><code>long</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#getLSNBatchSize--">getLSNBatchSize</a></span>()</code>
|
||
|
<div class="block">Preload is implemented to optimize I/O cost by fetching the records of
|
||
|
a Database by disk order, so that disk access is are sequential rather
|
||
|
than random.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i4" class="altColor">
|
||
|
<td class="colFirst"><code>long</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#getMaxBytes--">getMaxBytes</a></span>()</code>
|
||
|
<div class="block">Return the number of bytes in the cache to stop the preload at.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i5" class="rowColor">
|
||
|
<td class="colFirst"><code>long</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#getMaxMillisecs--">getMaxMillisecs</a></span>()</code>
|
||
|
<div class="block">Return the number of millisecs to stop the preload after.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i6" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je">PreloadConfig.Phases</a>></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#getProgressListener--">getProgressListener</a></span>()</code>
|
||
|
<div class="block">Return the ProgressListener for this PreloadConfig.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i7" class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#setInternalMemoryLimit-long-">setInternalMemoryLimit</a></span>(long internalMemoryLimit)</code>
|
||
|
<div class="block">Set the maximum amount of non JE Cache Memory that preload can use at
|
||
|
one time.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i8" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#setLoadLNs-boolean-">setLoadLNs</a></span>(boolean loadLNs)</code>
|
||
|
<div class="block">Configure the preload load LNs option.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i9" class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#setLSNBatchSize-long-">setLSNBatchSize</a></span>(long lsnBatchSize)</code>
|
||
|
<div class="block">Set the maximum number of LSNs to gather and sort at any one time.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i10" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#setMaxBytes-long-">setMaxBytes</a></span>(long maxBytes)</code>
|
||
|
<div class="block">Configure the maximum number of bytes to preload.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i11" class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#setMaxMillisecs-long-">setMaxMillisecs</a></span>(long maxMillisecs)</code>
|
||
|
<div class="block">Configure the maximum number of milliseconds to execute preload.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i12" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#setProgressListener-com.sleepycat.je.ProgressListener-">setProgressListener</a></span>(<a href="../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je">PreloadConfig.Phases</a>> progressListener)</code>
|
||
|
<div class="block">Configure the preload operation to make periodic calls to a <a href="../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je"><code>ProgressListener</code></a> to provide feedback on preload progress.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i13" class="rowColor">
|
||
|
<td class="colFirst"><code>java.lang.String</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/PreloadConfig.html#toString--">toString</a></span>()</code>
|
||
|
<div class="block">Returns the values for each configuration attribute.</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>equals, finalize, getClass, hashCode, notify, notifyAll, 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="PreloadConfig--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>PreloadConfig</h4>
|
||
|
<pre>public PreloadConfig()</pre>
|
||
|
<div class="block">Default configuration used if null is passed to <a href="../../../com/sleepycat/je/Database.html#preload-long-"><code>Database.preload</code></a>.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ============ METHOD DETAIL ========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="method.detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Method Detail</h3>
|
||
|
<a name="setMaxBytes-long-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setMaxBytes</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> setMaxBytes(long maxBytes)</pre>
|
||
|
<div class="block">Configure the maximum number of bytes to preload.
|
||
|
|
||
|
<p>The default is 0 for this class.</p></div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>maxBytes</code> - If the maxBytes parameter is non-zero, a preload will
|
||
|
stop when the cache contains this number of bytes.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getMaxBytes--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getMaxBytes</h4>
|
||
|
<pre>public long getMaxBytes()</pre>
|
||
|
<div class="block">Return the number of bytes in the cache to stop the preload at.
|
||
|
|
||
|
<p>This method may be called at any time during the life of the
|
||
|
application.</p></div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>The number of bytes in the cache to stop the preload at.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setMaxMillisecs-long-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setMaxMillisecs</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> setMaxMillisecs(long maxMillisecs)</pre>
|
||
|
<div class="block">Configure the maximum number of milliseconds to execute preload.
|
||
|
|
||
|
<p>The default is 0 for this class.</p></div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>maxMillisecs</code> - If the maxMillisecs parameter is non-zero, a preload
|
||
|
will stop when this amount of time has passed.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getMaxMillisecs--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getMaxMillisecs</h4>
|
||
|
<pre>public long getMaxMillisecs()</pre>
|
||
|
<div class="block">Return the number of millisecs to stop the preload after.
|
||
|
|
||
|
<p>This method may be called at any time during the life of the
|
||
|
application.</p></div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>The number of millisecs to stop the preload after.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setLoadLNs-boolean-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setLoadLNs</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> setLoadLNs(boolean loadLNs)</pre>
|
||
|
<div class="block">Configure the preload load LNs option.
|
||
|
|
||
|
<p>The default is false for this class.</p></div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>loadLNs</code> - If set to true, the preload will load Leaf Nodes (LNs)
|
||
|
containing the data values.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getLoadLNs--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getLoadLNs</h4>
|
||
|
<pre>public boolean getLoadLNs()</pre>
|
||
|
<div class="block">Return the configuration of the preload load LNs option.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>The configuration of the preload load LNs option.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setProgressListener-com.sleepycat.je.ProgressListener-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setProgressListener</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> setProgressListener(<a href="../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je">PreloadConfig.Phases</a>> progressListener)</pre>
|
||
|
<div class="block">Configure the preload operation to make periodic calls to a <a href="../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je"><code>ProgressListener</code></a> to provide feedback on preload progress.
|
||
|
The ProgressListener.progress() method is called each time the preload
|
||
|
mush fetch a btree node or data record from disk.
|
||
|
<p>
|
||
|
When using progress listeners, review the information at <a href="../../../com/sleepycat/je/ProgressListener.html#progress-T-long-long-"><code>ProgressListener.progress(T, long, long)</code></a> to avoid any unintended disruption to
|
||
|
replication stream syncup.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>progressListener</code> - The ProgressListener to callback during
|
||
|
preload.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getProgressListener--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getProgressListener</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/ProgressListener.html" title="interface in com.sleepycat.je">ProgressListener</a><<a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je">PreloadConfig.Phases</a>> getProgressListener()</pre>
|
||
|
<div class="block">Return the ProgressListener for this PreloadConfig.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the ProgressListener for this PreloadConfig.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setLSNBatchSize-long-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setLSNBatchSize</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> setLSNBatchSize(long lsnBatchSize)</pre>
|
||
|
<div class="block">Set the maximum number of LSNs to gather and sort at any one time. The
|
||
|
default is an unlimited number of LSNs. Setting this lower causes the
|
||
|
preload to use less memory, but it sorts and processes LSNs more
|
||
|
frequently thereby causing slower performance. Setting this higher will
|
||
|
in general improve performance at the expense of memory. Each LSN uses
|
||
|
16 bytes of memory.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>lsnBatchSize</code> - the maximum number of LSNs to accumulate and sort
|
||
|
per batch.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getLSNBatchSize--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getLSNBatchSize</h4>
|
||
|
<pre>public long getLSNBatchSize()</pre>
|
||
|
<div class="block">Preload is implemented to optimize I/O cost by fetching the records of
|
||
|
a Database by disk order, so that disk access is are sequential rather
|
||
|
than random. LSNs (log sequence numbers) are the disk addresses of
|
||
|
database records. Setting this value causes the preload to process
|
||
|
batches of LSNs rather than all in-memory LSNs at one time,
|
||
|
which bounds the memory usage of
|
||
|
the preload processing, at the expense of preload performance.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the maximum number of LSNs to be sorted that this
|
||
|
preload is configured for.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setInternalMemoryLimit-long-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setInternalMemoryLimit</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> setInternalMemoryLimit(long internalMemoryLimit)</pre>
|
||
|
<div class="block">Set the maximum amount of non JE Cache Memory that preload can use at
|
||
|
one time. The default is an unlimited amount of memory. Setting this
|
||
|
lower causes the preload to use less memory, but generally results in
|
||
|
slower performance. Setting this higher will often improve performance
|
||
|
at the expense of higher memory utilization.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>internalMemoryLimit</code> - the maximum number of non JE Cache bytes to
|
||
|
use.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getInternalMemoryLimit--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getInternalMemoryLimit</h4>
|
||
|
<pre>public long getInternalMemoryLimit()</pre>
|
||
|
<div class="block">Returns the maximum amount of non JE Cache Memory that preload can use at
|
||
|
one time.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the maximum amount of non JE Cache Memory that preload can use at
|
||
|
one time.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="clone--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>clone</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/PreloadConfig.html" title="class in com.sleepycat.je">PreloadConfig</a> clone()</pre>
|
||
|
<div class="block">Returns a copy of this configuration object.</div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
<dd><code>clone</code> in class <code>java.lang.Object</code></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="toString--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>toString</h4>
|
||
|
<pre>public java.lang.String toString()</pre>
|
||
|
<div class="block">Returns the values for each configuration attribute.</div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the values for each configuration attribute.</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/PreloadConfig.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/PartialComparator.html" title="interface in com.sleepycat.je"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
<li><a href="../../../com/sleepycat/je/PreloadConfig.Phases.html" title="enum in com.sleepycat.je"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../index.html?com/sleepycat/je/PreloadConfig.html" target="_top">Frames</a></li>
|
||
|
<li><a href="PreloadConfig.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
<li><a href="../../../allclasses-noframe.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>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
||
|
<li>Field | </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>Field | </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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
</body>
|
||
|
</html>
|