admin/yasuhirokimura-db18
1
0
Fork 0
mirror of https://github.com/yasuhirokimura/db18 synced 2026-06-08 18:29:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yasuhirokimura-db18/docs/java/com/sleepycat/db/DatabaseConfig.html
T
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

4284 lines
182 KiB
HTML
Raw Permalink 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 (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>DatabaseConfig (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="DatabaseConfig (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":42,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":42,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":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":10,"i68":42,"i69":42,"i70":10,"i71":10,"i72":10,"i73":10,"i74":10,"i75":10,"i76":10,"i77":10,"i78":10,"i79":10,"i80":42,"i81":10,"i82":10,"i83":10,"i84":10,"i85":10,"i86":10,"i87":10,"i88":10,"i89":10,"i90":10,"i91":10,"i92":10,"i93":10,"i94":10,"i95":10,"i96":10,"i97":10,"i98":10,"i99":10,"i100":10,"i101":10,"i102":10,"i103":10,"i104":10,"i105":10,"i106":10,"i107":10,"i108":10,"i109":10,"i110":10,"i111":10,"i112":10,"i113":10,"i114":10,"i115":10,"i116":10,"i117":10,"i118":10,"i119":10,"i120":10,"i121":10,"i122":10,"i123":10,"i124":10,"i125":10,"i126":10,"i127":10,"i128":10,"i129":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DatabaseConfig.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 DatabaseConfig" class="title">Class DatabaseConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.DatabaseConfig</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">DatabaseConfig</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Specify the attributes of a database.</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="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</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">An instance created using the default constructor is initialized
with the system's default settings.</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="#DatabaseConfig--">DatabaseConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">An instance created using the default constructor is initialized with
the system's default settings.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cloneConfig--">cloneConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a copy of this configuration object.</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="#enableEncrypted-boolean-">enableEncrypted</a></span>&#8203;(boolean&nbsp;enable)</code></th>
<td class="colLast">
<div class="block">Enables encryption when the environment is also encrypted, see
<a href="EnvironmentConfig.html#setEncrypted-java.lang.String-"><code>EnvironmentConfig.setEncrypted</code></a></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="#getAllowCreate--">getAllowCreate</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured
to create the database if it does not already exist.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlobDir--">getBlobDir</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#getExternalFileDir--"><code>getExternalFileDir()</code></a>.</div>
</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="#getBlobThreshold--">getBlobThreshold</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#getExternalFileThreshold--"><code>getExternalFileThreshold()</code></a>.</div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Comparator</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBtreeComparator--">getBtreeComparator</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the custom Comparator used for btree keys.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBtreeCompressor--">getBtreeCompressor</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Btree compression callbacks.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBtreeMinKey--">getBtreeMinKey</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the minimum number of key/data pairs intended to be stored
on any single Btree leaf page.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBtreePrefixCalculator--">getBtreePrefixCalculator</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the Btree prefix callback.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBtreeRecordNumbers--">getBtreeRecordNumbers</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the Btree is configured to support retrieval by record number.</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="#getByteOrder--">getByteOrder</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the database byte order; a byte order of 4,321 indicates a
big endian order, and a byte order of 1,234 indicates a little
endian order.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByteSwapped--">getByteSwapped</a></span>()</code></th>
<td class="colLast">
<div class="block">Return if the underlying database files were created on an architecture
of the same byte order as the current one.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheCount--">getCacheCount</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the number of shared memory buffer pools, that is, the number
of caches.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCacheSize--">getCacheSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the size of the shared memory buffer pool, that is, the cache.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getChecksum--">getChecksum</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database environment is configured to do checksum
verification of pages read into the cache from the backing
filestore.</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="#getCreateDir--">getCreateDir</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the directory a database will/has been created in or looked for.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDirtyRead--">getDirtyRead</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#getReadUncommitted--"><code>getReadUncommitted()</code></a> to conform to ANSI
database isolation terminology.</div>
</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.util.Comparator</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDuplicateComparator--">getDuplicateComparator</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the duplicate data item comparison callback.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEncrypted--">getEncrypted</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database has been configured to perform encryption.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorHandler--">getErrorHandler</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the function to be called if an error occurs.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorPrefix--">getErrorPrefix</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the prefix string that appears before error messages.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>java.io.OutputStream</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getErrorStream--">getErrorStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the an OutputStream for displaying error messages.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExclusiveCreate--">getExclusiveCreate</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured
to fail if the database already exists.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExternalFileDir--">getExternalFileDir</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the path of a directory where external files are stored.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExternalFileThreshold--">getExternalFileThreshold</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the threshold value in bytes beyond which data items are
stored as external files.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code><a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFeedbackHandler--">getFeedbackHandler</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the object's methods to be called to provide feedback.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>java.util.Comparator</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHashComparator--">getHashComparator</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the Comparator used to compare keys in a Hash database.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="Hasher.html" title="interface in com.sleepycat.db">Hasher</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHasher--">getHasher</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the database-specific hash function.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHashFillFactor--">getHashFillFactor</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the hash table density.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHashNumElements--">getHashNumElements</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the estimate of the final size of the hash table.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeapRegionSize--">getHeapRegionSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the number of pages in a region of the database.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeapsize--">getHeapsize</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the maximum on-disk database file size.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code><a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageHandler--">getMessageHandler</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the function to be called with an informational message.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessagePrefix--">getMessagePrefix</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the prefix string that appears before informational messages.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>java.io.OutputStream</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMessageStream--">getMessageStream</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the an OutputStream for displaying informational messages.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMode--">getMode</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the mode used to create files.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMultiversion--">getMultiversion</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database is configured for multiversion concurrency control.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNoMMap--">getNoMMap</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the library is configured to not map this database into
memory.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>java.lang.Boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNoWaitDbExclusiveLock--">getNoWaitDbExclusiveLock</a></span>()</code></th>
<td class="colLast">
<div class="block">Return whether the <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is
configured to obtain a write lock on the entire database.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPageSize--">getPageSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the size of the pages used to hold items in the database, in bytes.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code><a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPanicHandler--">getPanicHandler</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the function to be called if the database environment panics.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>java.io.File[]</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionDirs--">getPartitionDirs</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the array of directories the database extents should be created in or
looked for.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code><a href="PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionHandler--">getPartitionHandler</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the function to be called to determine which partition a key resides in.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code><a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionKeys--">getPartitionKeys</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the array of keys the database is configured to partition with.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionParts--">getPartitionParts</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the number of partitions the database is configured for.</div>
</td>
</tr>
<tr id="i45" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPassword--">getPassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i46" class="altColor">
<td class="colFirst"><code><a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPriority--">getPriority</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the the cache priority for pages referenced by this handle.</div>
</td>
</tr>
<tr id="i47" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueueExtentSize--">getQueueExtentSize</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the size of the extents used to hold pages in a Queue database,
specified as a number of pages.</div>
</td>
</tr>
<tr id="i48" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQueueInOrder--">getQueueInOrder</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> method is configured to return
key/data pairs in order, always returning the key/data item from the
head of the queue.</div>
</td>
</tr>
<tr id="i49" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadOnly--">getReadOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database is configured in read-only mode.</div>
</td>
</tr>
<tr id="i50" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadUncommitted--">getReadUncommitted</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database is configured to support read uncommitted.</div>
</td>
</tr>
<tr id="i51" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordDelimiter--">getRecordDelimiter</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the delimiting byte used to mark the end of a record in the
backing source file for the Recno access method.</div>
</td>
</tr>
<tr id="i52" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordLength--">getRecordLength</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the database record length, in bytes.</div>
</td>
</tr>
<tr id="i53" class="rowColor">
<td class="colFirst"><code><a href="RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordNumberAppender--">getRecordNumberAppender</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the function to call after the record number has been
selected but before the data has been stored into the database.</div>
</td>
</tr>
<tr id="i54" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordPad--">getRecordPad</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the padding character for short, fixed-length records for the
Queue and Recno access methods.</div>
</td>
</tr>
<tr id="i55" class="rowColor">
<td class="colFirst"><code>java.io.File</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordSource--">getRecordSource</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the name of an underlying flat text database file that is
read to initialize a transient record number index.</div>
</td>
</tr>
<tr id="i56" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRenumbering--">getRenumbering</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the logical record numbers are mutable, and change as
records are added to and deleted from the database.</div>
</td>
</tr>
<tr id="i57" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReverseSplitOff--">getReverseSplitOff</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the Btree has been configured to not do reverse splits.</div>
</td>
</tr>
<tr id="i58" class="altColor">
<td class="colFirst"><code><a href="Slice.html" title="interface in com.sleepycat.db">Slice</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSliceCallback--">getSliceCallback</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the Slice callback.</div>
</td>
</tr>
<tr id="i59" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSliced--">getSliced</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured to create a sliced database.</div>
</td>
</tr>
<tr id="i60" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSnapshot--">getSnapshot</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the any specified backing source file will be read in its
entirety when the database is opened.</div>
</td>
</tr>
<tr id="i61" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSortedDuplicates--">getSortedDuplicates</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database is configured to support sorted duplicate data
items.</div>
</td>
</tr>
<tr id="i62" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactional--">getTransactional</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database open is enclosed within a transaction.</div>
</td>
</tr>
<tr id="i63" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactionNotDurable--">getTransactionNotDurable</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database environment is configured to not write log
records for this database.</div>
</td>
</tr>
<tr id="i64" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTruncate--">getTruncate</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database has been configured to be physically truncated
by truncating the underlying file, discarding all previous databases
it might have held.</div>
</td>
</tr>
<tr id="i65" class="rowColor">
<td class="colFirst"><code><a href="DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType--">getType</a></span>()</code></th>
<td class="colLast">
<div class="block">Return the type of the database.</div>
</td>
</tr>
<tr id="i66" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUnsortedDuplicates--">getUnsortedDuplicates</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database is configured to support duplicate data items.</div>
</td>
</tr>
<tr id="i67" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllowCreate-boolean-">setAllowCreate</a></span>&#8203;(boolean&nbsp;allowCreate)</code></th>
<td class="colLast">
<div class="block">Configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to create
the database if it does not already exist.</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="#setBlobDir-java.io.File-">setBlobDir</a></span>&#8203;(java.io.File&nbsp;dir)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#setExternalFileDir-java.io.File-"><code>setExternalFileDir(java.io.File)</code></a>.</div>
</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="#setBlobThreshold-int-">setBlobThreshold</a></span>&#8203;(int&nbsp;value)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#setExternalFileThreshold-int-"><code>setExternalFileThreshold(int)</code></a>.</div>
</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="#setBtreeComparator-java.util.Comparator-">setBtreeComparator</a></span>&#8203;(java.util.Comparator&nbsp;btreeComparator)</code></th>
<td class="colLast">
<div class="block">By default, a byte by byte lexicographic comparison is used for
btree keys.</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="#setBtreeCompressor-com.sleepycat.db.BtreeCompressor-">setBtreeCompressor</a></span>&#8203;(<a href="BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a>&nbsp;btreeCompressor)</code></th>
<td class="colLast">
<div class="block">Set the Btree compression callbacks.</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="#setBtreeMinKey-int-">setBtreeMinKey</a></span>&#8203;(int&nbsp;btMinKey)</code></th>
<td class="colLast">
<div class="block">Set the minimum number of key/data pairs intended to be stored on any
single Btree leaf page.</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="#setBtreePrefixCalculator-com.sleepycat.db.BtreePrefixCalculator-">setBtreePrefixCalculator</a></span>&#8203;(<a href="BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a>&nbsp;btreePrefixCalculator)</code></th>
<td class="colLast">
<div class="block">Set the Btree prefix callback.</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="#setBtreeRecordNumbers-boolean-">setBtreeRecordNumbers</a></span>&#8203;(boolean&nbsp;btreeRecordNumbers)</code></th>
<td class="colLast">
<div class="block">Configure the Btree to support retrieval by record number.</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="#setByteOrder-int-">setByteOrder</a></span>&#8203;(int&nbsp;byteOrder)</code></th>
<td class="colLast">
<div class="block">Set the byte order for integers in the stored database metadata.</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="#setCacheCount-int-">setCacheCount</a></span>&#8203;(int&nbsp;cacheCount)</code></th>
<td class="colLast">
<div class="block">Set the number of shared memory buffer pools, that is, the number of
caches.</div>
</td>
</tr>
<tr id="i77" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCacheSize-long-">setCacheSize</a></span>&#8203;(long&nbsp;cacheSize)</code></th>
<td class="colLast">
<div class="block">Set the size of the shared memory buffer pool, that is, the size of the
cache.</div>
</td>
</tr>
<tr id="i78" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setChecksum-boolean-">setChecksum</a></span>&#8203;(boolean&nbsp;checksum)</code></th>
<td class="colLast">
<div class="block">Configure the database environment to do checksum verification of
pages read into the cache from the backing filestore.</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="#setCreateDir-java.io.File-">setCreateDir</a></span>&#8203;(java.io.File&nbsp;createDir)</code></th>
<td class="colLast">
<div class="block">Specify which directory a database should be created in or looked for.</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="#setDirtyRead-boolean-">setDirtyRead</a></span>&#8203;(boolean&nbsp;dirtyRead)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#setReadUncommitted-boolean-"><code>setReadUncommitted(boolean)</code></a> to conform to ANSI
database isolation terminology.</div>
</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="#setDuplicateComparator-java.util.Comparator-">setDuplicateComparator</a></span>&#8203;(java.util.Comparator&nbsp;duplicateComparator)</code></th>
<td class="colLast">
<div class="block">Set the duplicate data item comparison callback.</div>
</td>
</tr>
<tr id="i82" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEncrypted-java.lang.String-">setEncrypted</a></span>&#8203;(java.lang.String&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Set the password used to perform encryption and decryption.</div>
</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="#setErrorHandler-com.sleepycat.db.ErrorHandler-">setErrorHandler</a></span>&#8203;(<a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a>&nbsp;errorHandler)</code></th>
<td class="colLast">
<div class="block">Set the function to be called if an error occurs.</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="#setErrorPrefix-java.lang.String-">setErrorPrefix</a></span>&#8203;(java.lang.String&nbsp;errorPrefix)</code></th>
<td class="colLast">
<div class="block">Set the prefix string that appears before error messages.</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="#setErrorStream-java.io.OutputStream-">setErrorStream</a></span>&#8203;(java.io.OutputStream&nbsp;errorStream)</code></th>
<td class="colLast">
<div class="block">Set an OutputStream for displaying error messages.</div>
</td>
</tr>
<tr id="i86" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExclusiveCreate-boolean-">setExclusiveCreate</a></span>&#8203;(boolean&nbsp;exclusiveCreate)</code></th>
<td class="colLast">
<div class="block">Configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to fail if
the database already exists.</div>
</td>
</tr>
<tr id="i87" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExternalFileDir-java.io.File-">setExternalFileDir</a></span>&#8203;(java.io.File&nbsp;dir)</code></th>
<td class="colLast">
<div class="block">Sets the path of a directory where external files are stored.</div>
</td>
</tr>
<tr id="i88" 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>&#8203;(int&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Set the size in bytes which is used to determine when a data item will be
stored as an external file.</div>
</td>
</tr>
<tr id="i89" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setFeedbackHandler-com.sleepycat.db.FeedbackHandler-">setFeedbackHandler</a></span>&#8203;(<a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a>&nbsp;feedbackHandler)</code></th>
<td class="colLast">
<div class="block">Set an object whose methods are called to provide feedback.</div>
</td>
</tr>
<tr id="i90" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHashComparator-java.util.Comparator-">setHashComparator</a></span>&#8203;(java.util.Comparator&nbsp;hashComparator)</code></th>
<td class="colLast">
<div class="block">Set the Hash key comparison function.</div>
</td>
</tr>
<tr id="i91" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHasher-com.sleepycat.db.Hasher-">setHasher</a></span>&#8203;(<a href="Hasher.html" title="interface in com.sleepycat.db">Hasher</a>&nbsp;hasher)</code></th>
<td class="colLast">
<div class="block">Set a database-specific hash function.</div>
</td>
</tr>
<tr id="i92" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHashFillFactor-int-">setHashFillFactor</a></span>&#8203;(int&nbsp;hashFillFactor)</code></th>
<td class="colLast">
<div class="block">Set the desired density within the hash table.</div>
</td>
</tr>
<tr id="i93" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHashNumElements-int-">setHashNumElements</a></span>&#8203;(int&nbsp;hashNumElements)</code></th>
<td class="colLast">
<div class="block">Set an estimate of the final size of the hash table.</div>
</td>
</tr>
<tr id="i94" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeapRegionSize-int-">setHeapRegionSize</a></span>&#8203;(int&nbsp;npages)</code></th>
<td class="colLast">
<div class="block">Sets the number of pages in a region of a database configured to use
the Heap access method.</div>
</td>
</tr>
<tr id="i95" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setHeapsize-long-">setHeapsize</a></span>&#8203;(long&nbsp;bytes)</code></th>
<td class="colLast">
<div class="block">Set the maximum on-disk database file size used by a database configured to
use the Heap access method.</div>
</td>
</tr>
<tr id="i96" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageHandler-com.sleepycat.db.MessageHandler-">setMessageHandler</a></span>&#8203;(<a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a>&nbsp;messageHandler)</code></th>
<td class="colLast">
<div class="block">Set a function to be called with an informational message.</div>
</td>
</tr>
<tr id="i97" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessagePrefix-java.lang.String-">setMessagePrefix</a></span>&#8203;(java.lang.String&nbsp;messagePrefix)</code></th>
<td class="colLast">
<div class="block">Set the prefix string that appears before informational messages.</div>
</td>
</tr>
<tr id="i98" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMessageStream-java.io.OutputStream-">setMessageStream</a></span>&#8203;(java.io.OutputStream&nbsp;messageStream)</code></th>
<td class="colLast">
<div class="block">Set an OutputStream for displaying informational messages.</div>
</td>
</tr>
<tr id="i99" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMode-int-">setMode</a></span>&#8203;(int&nbsp;mode)</code></th>
<td class="colLast">
<div class="block">On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files
created by the database open are created with mode <code>mode</code>
(as described in the <code>chmod</code>(2) manual page) and modified
by the process' umask value at the time of creation (see the
<code>umask</code>(2) manual page).</div>
</td>
</tr>
<tr id="i100" 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>&#8203;(java.io.File&nbsp;file)</code></th>
<td class="colLast">
<div class="block">Sets the path of a file to store statistical information.</div>
</td>
</tr>
<tr id="i101" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMultiversion-boolean-">setMultiversion</a></span>&#8203;(boolean&nbsp;multiversion)</code></th>
<td class="colLast">
<div class="block">Configured the database with support for multiversion concurrency control.</div>
</td>
</tr>
<tr id="i102" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNoMMap-boolean-">setNoMMap</a></span>&#8203;(boolean&nbsp;noMMap)</code></th>
<td class="colLast">
<div class="block">Configure the library to not map this database into memory.</div>
</td>
</tr>
<tr id="i103" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNoWaitDbExclusiveLock-java.lang.Boolean-">setNoWaitDbExclusiveLock</a></span>&#8203;(java.lang.Boolean&nbsp;noWaitDbExclLock)</code></th>
<td class="colLast">
<div class="block">Configure the <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a
write lock on the entire database.</div>
</td>
</tr>
<tr id="i104" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPageSize-int-">setPageSize</a></span>&#8203;(int&nbsp;pageSize)</code></th>
<td class="colLast">
<div class="block">Set the size of the pages used to hold items in the database, in bytes.</div>
</td>
</tr>
<tr id="i105" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPanicHandler-com.sleepycat.db.PanicHandler-">setPanicHandler</a></span>&#8203;(<a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a>&nbsp;panicHandler)</code></th>
<td class="colLast">
<div class="block">Set the function to be called if the database environment panics.</div>
</td>
</tr>
<tr id="i106" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPartitionByCallback-int-com.sleepycat.db.PartitionHandler-">setPartitionByCallback</a></span>&#8203;(int&nbsp;parts,
<a href="PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a>&nbsp;partitionHandler)</code></th>
<td class="colLast">
<div class="block">Enable or disable database partitioning, and set the callback that will
be used for the partitioning.</div>
</td>
</tr>
<tr id="i107" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPartitionByRange-int-com.sleepycat.db.MultipleDataEntry-">setPartitionByRange</a></span>&#8203;(int&nbsp;parts,
<a href="MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</a>&nbsp;keys)</code></th>
<td class="colLast">
<div class="block">Enable or disable database partitioning, and set key ranges that will be
used for the partitioning.</div>
</td>
</tr>
<tr id="i108" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPartitionDirs-java.io.File:A-">setPartitionDirs</a></span>&#8203;(java.io.File[]&nbsp;dirs)</code></th>
<td class="colLast">
<div class="block">Specify the array of directories the database extents should be created in or
looked for.</div>
</td>
</tr>
<tr id="i109" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPriority-com.sleepycat.db.CacheFilePriority-">setPriority</a></span>&#8203;(<a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a>&nbsp;priority)</code></th>
<td class="colLast">
<div class="block">Set the cache priority for pages referenced by the DB handle.</div>
</td>
</tr>
<tr id="i110" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueueExtentSize-int-">setQueueExtentSize</a></span>&#8203;(int&nbsp;queueExtentSize)</code></th>
<td class="colLast">
<div class="block">Set the size of the extents used to hold pages in a Queue database,
specified as a number of pages.</div>
</td>
</tr>
<tr id="i111" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setQueueInOrder-boolean-">setQueueInOrder</a></span>&#8203;(boolean&nbsp;queueInOrder)</code></th>
<td class="colLast">
<div class="block">Configure <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> to return key/data pairs in
order, always returning the key/data item from the head of the
queue.</div>
</td>
</tr>
<tr id="i112" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnly-boolean-">setReadOnly</a></span>&#8203;(boolean&nbsp;readOnly)</code></th>
<td class="colLast">
<div class="block">Configure the database in read-only mode.</div>
</td>
</tr>
<tr id="i113" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadUncommitted-boolean-">setReadUncommitted</a></span>&#8203;(boolean&nbsp;readUncommitted)</code></th>
<td class="colLast">
<div class="block">Configure the database to support read uncommitted.</div>
</td>
</tr>
<tr id="i114" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRecordDelimiter-int-">setRecordDelimiter</a></span>&#8203;(int&nbsp;recordDelimiter)</code></th>
<td class="colLast">
<div class="block">Set the delimiting byte used to mark the end of a record in the backing
source file for the Recno access method.</div>
</td>
</tr>
<tr id="i115" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRecordLength-int-">setRecordLength</a></span>&#8203;(int&nbsp;recordLength)</code></th>
<td class="colLast">
<div class="block">Specify the database record length, in bytes.</div>
</td>
</tr>
<tr id="i116" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRecordNumberAppender-com.sleepycat.db.RecordNumberAppender-">setRecordNumberAppender</a></span>&#8203;(<a href="RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a>&nbsp;recnoAppender)</code></th>
<td class="colLast">
<div class="block">Configure <a href="Database.html#append-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-"><code>Database.append</code></a> to call the function after the
record number has been selected but before the data has been stored
into the database.</div>
</td>
</tr>
<tr id="i117" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRecordPad-int-">setRecordPad</a></span>&#8203;(int&nbsp;recordPad)</code></th>
<td class="colLast">
<div class="block">Set the padding character for short, fixed-length records for the Queue
and Recno access methods.</div>
</td>
</tr>
<tr id="i118" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRecordSource-java.io.File-">setRecordSource</a></span>&#8203;(java.io.File&nbsp;recordSource)</code></th>
<td class="colLast">
<div class="block">Set the underlying source file for the Recno access method.</div>
</td>
</tr>
<tr id="i119" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRenumbering-boolean-">setRenumbering</a></span>&#8203;(boolean&nbsp;renumbering)</code></th>
<td class="colLast">
<div class="block">Configure the logical record numbers to be mutable, and change as
records are added to and deleted from the database.</div>
</td>
</tr>
<tr id="i120" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReverseSplitOff-boolean-">setReverseSplitOff</a></span>&#8203;(boolean&nbsp;reverseSplitOff)</code></th>
<td class="colLast">
<div class="block">Configure the Btree to not do reverse splits.</div>
</td>
</tr>
<tr id="i121" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSliceCallback-com.sleepycat.db.Slice-">setSliceCallback</a></span>&#8203;(<a href="Slice.html" title="interface in com.sleepycat.db">Slice</a>&nbsp;sliceHandler)</code></th>
<td class="colLast">
<div class="block">Set the slice callback.</div>
</td>
</tr>
<tr id="i122" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSliced-boolean-">setSliced</a></span>&#8203;(boolean&nbsp;sliced)</code></th>
<td class="colLast">
<div class="block">Configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to open or create a sliced database.</div>
</td>
</tr>
<tr id="i123" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSnapshot-boolean-">setSnapshot</a></span>&#8203;(boolean&nbsp;snapshot)</code></th>
<td class="colLast">
<div class="block">Specify that any specified backing source file be read in its entirety
when the database is opened.</div>
</td>
</tr>
<tr id="i124" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSortedDuplicates-boolean-">setSortedDuplicates</a></span>&#8203;(boolean&nbsp;sortedDuplicates)</code></th>
<td class="colLast">
<div class="block">Configure the database to support sorted, duplicate data items.</div>
</td>
</tr>
<tr id="i125" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactional-boolean-">setTransactional</a></span>&#8203;(boolean&nbsp;transactional)</code></th>
<td class="colLast">
<div class="block">Enclose the database open within a transaction.</div>
</td>
</tr>
<tr id="i126" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactionNotDurable-boolean-">setTransactionNotDurable</a></span>&#8203;(boolean&nbsp;transactionNotDurable)</code></th>
<td class="colLast">
<div class="block">Configure the database environment to not write log records for this
database.</div>
</td>
</tr>
<tr id="i127" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTruncate-boolean-">setTruncate</a></span>&#8203;(boolean&nbsp;truncate)</code></th>
<td class="colLast">
<div class="block">Configure the database to be physically truncated by truncating the
underlying file, discarding all previous databases it might have
held.</div>
</td>
</tr>
<tr id="i128" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setType-com.sleepycat.db.DatabaseType-">setType</a></span>&#8203;(<a href="DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a>&nbsp;type)</code></th>
<td class="colLast">
<div class="block">Configure the type of the database.</div>
</td>
</tr>
<tr id="i129" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setUnsortedDuplicates-boolean-">setUnsortedDuplicates</a></span>&#8203;(boolean&nbsp;unsortedDuplicates)</code></th>
<td class="colLast">
<div class="block">Configure the database to support unsorted duplicate data items.</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="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> DEFAULT</pre>
<div class="block">An instance created using the default constructor is initialized
with the system's default settings.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DatabaseConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DatabaseConfig</h4>
<pre>public&nbsp;DatabaseConfig()</pre>
<div class="block">An instance created using the default constructor is initialized with
the system's default settings.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="cloneConfig--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneConfig</h4>
<pre class="methodSignature">public&nbsp;<a href="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a>&nbsp;cloneConfig()</pre>
<div class="block">Returns a copy of this configuration object.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a copy of this configuration object</dd>
</dl>
</li>
</ul>
<a name="setAllowCreate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowCreate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAllowCreate&#8203;(boolean&nbsp;allowCreate)</pre>
<div class="block">Configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to create
the database if it does not already exist.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowCreate</code> - If true, configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to
create the database if it does not already exist.</dd>
</dl>
</li>
</ul>
<a name="getAllowCreate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowCreate</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getAllowCreate()</pre>
<div class="block">Return true if the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured
to create the database if it does not already exist.
<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 <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured
to create the database if it does not already exist.</dd>
</dl>
</li>
</ul>
<a name="setBlobDir-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBlobDir</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;setBlobDir&#8203;(java.io.File&nbsp;dir)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#setExternalFileDir-java.io.File-"><code>setExternalFileDir(java.io.File)</code></a>.</div>
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dir</code> - The path of a directory where external files are stored</dd>
</dl>
</li>
</ul>
<a name="getBlobDir--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlobDir</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;java.io.File&nbsp;getBlobDir()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#getExternalFileDir--"><code>getExternalFileDir()</code></a>.</div>
</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The path of a directory where external files are stored</dd>
</dl>
</li>
</ul>
<a name="setBlobThreshold-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBlobThreshold</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;setBlobThreshold&#8203;(int&nbsp;value)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#setExternalFileThreshold-int-"><code>setExternalFileThreshold(int)</code></a>.</div>
</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The size in bytes which is used to determine when a data item will be
stored as an external file. If 0, external files will be never used by the
database.</dd>
</dl>
</li>
</ul>
<a name="getBlobThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBlobThreshold</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;int&nbsp;getBlobThreshold()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#getExternalFileThreshold--"><code>getExternalFileThreshold()</code></a>.</div>
</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The threshold value in bytes beyond which data items are
stored as external files. If 0, external files are not used by the database.</dd>
</dl>
</li>
</ul>
<a name="setBtreeComparator-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBtreeComparator</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBtreeComparator&#8203;(java.util.Comparator&nbsp;btreeComparator)</pre>
<div class="block">By default, a byte by byte lexicographic comparison is used for
btree keys. To customize the comparison, supply a different
Comparator.
<p>
The <code>compare</code> method is passed the byte arrays representing
keys that are stored in the database. If you know how your data is
organized in the byte array, then you can write a comparison routine that
directly examines the contents of the arrays. Otherwise, you have to
reconstruct your original objects, and then perform the comparison.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>btreeComparator</code> - the custom Comparator used for btree keys</dd>
</dl>
</li>
</ul>
<a name="getBtreeComparator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBtreeComparator</h4>
<pre class="methodSignature">public&nbsp;java.util.Comparator&nbsp;getBtreeComparator()</pre>
<div class="block">Return the custom Comparator used for btree keys.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the custom Comparator used for btree keys, or null if the default
comparison function will be used.</dd>
</dl>
</li>
</ul>
<a name="setBtreeMinKey-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBtreeMinKey</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBtreeMinKey&#8203;(int&nbsp;btMinKey)</pre>
<div class="block">Set the minimum number of key/data pairs intended to be stored on any
single Btree leaf page.
<p>
This value is used to determine if key or data items will be stored
on overflow pages instead of Btree leaf pages. The value must be
at least 2; if the value is not explicitly set, a value of 2 is used.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>btMinKey</code> - The minimum number of key/data pairs intended to be stored on any
single Btree leaf page.</dd>
</dl>
</li>
</ul>
<a name="getBtreeMinKey--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBtreeMinKey</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getBtreeMinKey()</pre>
<div class="block">Return the minimum number of key/data pairs intended to be stored
on any single Btree leaf page.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The minimum number of key/data pairs intended to be stored
on any single Btree leaf page.</dd>
</dl>
</li>
</ul>
<a name="setByteOrder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setByteOrder</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setByteOrder&#8203;(int&nbsp;byteOrder)</pre>
<div class="block">Set the byte order for integers in the stored database metadata.
<p>
The host byte order of the machine where the process is running will
be used if no byte order is set.
<p>
<b>
The access methods provide no guarantees about the byte ordering of the
application data stored in the database, and applications are
responsible for maintaining any necessary ordering.
</b>
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
If creating additional databases in a single physical file, information
specified to this method will be ignored and the byte order of the
existing databases will be used.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>byteOrder</code> - The byte order as an integer; for example, big endian order is the
number 4,321, and little endian order is the number 1,234.</dd>
</dl>
</li>
</ul>
<a name="getByteOrder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteOrder</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getByteOrder()</pre>
<div class="block">Return the database byte order; a byte order of 4,321 indicates a
big endian order, and a byte order of 1,234 indicates a little
endian order.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The database byte order; a byte order of 4,321 indicates a
big endian order, and a byte order of 1,234 indicates a little
endian order.</dd>
</dl>
</li>
</ul>
<a name="getByteSwapped--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getByteSwapped</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getByteSwapped()</pre>
<div class="block">Return if the underlying database files were created on an architecture
of the same byte order as the current one.
<p>
This information may be used to determine whether application data
needs to be adjusted for this architecture or not.
<p>
This method may not be called before the
database has been opened.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Return false if the underlying database files were created on an
architecture of the same byte order as the current one, and true if
they were not (that is, big-endian on a little-endian machine, or
vice versa).</dd>
</dl>
</li>
</ul>
<a name="setBtreeCompressor-com.sleepycat.db.BtreeCompressor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBtreeCompressor</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBtreeCompressor&#8203;(<a href="BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a>&nbsp;btreeCompressor)</pre>
<div class="block">Set the Btree compression callbacks.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>btreeCompressor</code> - the custom Btree compression callbacks</dd>
</dl>
</li>
</ul>
<a name="getBtreeCompressor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBtreeCompressor</h4>
<pre class="methodSignature">public&nbsp;<a href="BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a>&nbsp;getBtreeCompressor()</pre>
<div class="block">Get the Btree compression callbacks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the btree compression callbacks</dd>
</dl>
</li>
</ul>
<a name="setSliceCallback-com.sleepycat.db.Slice-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSliceCallback</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSliceCallback&#8203;(<a href="Slice.html" title="interface in com.sleepycat.db">Slice</a>&nbsp;sliceHandler)</pre>
<div class="block">Set the slice callback.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sliceHandler</code> - the slice callback</dd>
</dl>
</li>
</ul>
<a name="getSliceCallback--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSliceCallback</h4>
<pre class="methodSignature">public&nbsp;<a href="Slice.html" title="interface in com.sleepycat.db">Slice</a>&nbsp;getSliceCallback()</pre>
<div class="block">Get the Slice callback.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the slice callback</dd>
</dl>
</li>
</ul>
<a name="setBtreePrefixCalculator-com.sleepycat.db.BtreePrefixCalculator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBtreePrefixCalculator</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBtreePrefixCalculator&#8203;(<a href="BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a>&nbsp;btreePrefixCalculator)</pre>
<div class="block">Set the Btree prefix callback. The prefix callback is used to determine
the amount by which keys stored on the Btree internal pages can be
safely truncated without losing their uniqueness. See the
<a href="../../../../programmer_reference/bt_conf.html#am_conf_bt_prefix" target="_top">Btree prefix
comparison</a> section of the Berkeley DB Reference Guide for more
details about how this works. The usefulness of this is data-dependent,
but can produce significantly reduced tree sizes and search times in
some data sets.
<p>
If no prefix callback or key comparison callback is specified by the
application, a default lexical comparison function is used to calculate
prefixes. If no prefix callback is specified and a key comparison
callback is specified, no prefix function is used. It is an error to
specify a prefix function without also specifying a Btree key comparison
function.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>btreePrefixCalculator</code> - the Btree prefix callback</dd>
</dl>
</li>
</ul>
<a name="getBtreePrefixCalculator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBtreePrefixCalculator</h4>
<pre class="methodSignature">public&nbsp;<a href="BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a>&nbsp;getBtreePrefixCalculator()</pre>
<div class="block">Return the Btree prefix callback.
<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 Btree prefix callback.</dd>
</dl>
</li>
</ul>
<a name="setCacheSize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCacheSize&#8203;(long&nbsp;cacheSize)</pre>
<div class="block">Set the size of the shared memory buffer pool, that is, the size of the
cache.
<p>
The cache should be the size of the normal working data set of the
application, with some small amount of additional memory for unusual
situations. (Note: the working set is not the same as the number of
pages accessed simultaneously, and is usually much larger.)
<p>
The default cache size is 256KB, and may not be specified as less than
20KB. Any cache size less than 500MB is automatically increased by 25%
to account for buffer pool overhead; cache sizes larger than 500MB are
used as specified. The current maximum size of a single cache is 4GB.
(All sizes are in powers-of-two, that is, 256KB is 2^18 not 256,000.)
<p>
Because databases opened within database environments use the cache
specified to the environment, it is an error to attempt to configure a
cache size in a database created within an environment.
<p>
This method may not be called after the database is opened.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheSize</code> - The size of the shared memory buffer pool, that is, the size of the
cache.</dd>
</dl>
</li>
</ul>
<a name="getCacheSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheSize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getCacheSize()</pre>
<div class="block">Return the size of the shared memory buffer pool, that is, the cache.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The size of the shared memory buffer pool, that is, the cache.</dd>
</dl>
</li>
</ul>
<a name="setCreateDir-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCreateDir</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCreateDir&#8203;(java.io.File&nbsp;createDir)</pre>
<div class="block">Specify which directory a database should be created in or looked for.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>createDir</code> - The directory will be used to create or locate the database file specified in
the openDatabase method call. The directory must be one of the directories
in the environment list specified by EnvironmentConfig.addDataDirectory.</dd>
</dl>
</li>
</ul>
<a name="getCreateDir--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCreateDir</h4>
<pre class="methodSignature">public&nbsp;java.io.File&nbsp;getCreateDir()</pre>
<div class="block">Return the directory a database will/has been created in or looked for.
<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 directory a database will/has been created in or looked for.</dd>
</dl>
</li>
</ul>
<a name="setCacheCount-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCacheCount</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCacheCount&#8203;(int&nbsp;cacheCount)</pre>
<div class="block">Set the number of shared memory buffer pools, that is, the number of
caches.
<p>
It is possible to specify caches larger than 4GB and/or large enough
they cannot be allocated contiguously on some architectures. For
example, some releases of Solaris limit the amount of memory that may
be allocated contiguously by a process. This method allows applications
to break the cache broken up into a number of equally sized, separate
pieces of memory.
<p>
Because databases opened within database environments use the cache
specified to the environment, it is an error to attempt to configure
multiple caches in a database created within an environment.
<p>
This method may not be called after the database is opened.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cacheCount</code> - The number of shared memory buffer pools, that is, the number of caches.</dd>
</dl>
</li>
</ul>
<a name="getCacheCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCacheCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getCacheCount()</pre>
<div class="block">Return the number of shared memory buffer pools, that is, the number
of caches.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of shared memory buffer pools, that is, the number
of caches.</dd>
</dl>
</li>
</ul>
<a name="setChecksum-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setChecksum</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setChecksum&#8203;(boolean&nbsp;checksum)</pre>
<div class="block">Configure the database environment to do checksum verification of
pages read into the cache from the backing filestore.
<p>
Berkeley DB uses the SHA1 Secure Hash Algorithm if encryption is
also configured for this database, and a general hash algorithm if
it is not.
<p>
Calling this method only affects the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle
(and any other library handles opened within the scope of that handle).
<p>
If the database already exists when the database is opened, any database
configuration specified by this method
will be ignored.
If creating additional databases in a file, the checksum behavior
specified must be consistent with the existing databases in the file or
an error will be returned.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>checksum</code> - If true, configure the database environment to do checksum verification
of pages read into the cache from the backing filestore.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getChecksum--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChecksum</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getChecksum()</pre>
<div class="block">Return true if the database environment is configured to do checksum
verification of pages read into the cache from the backing
filestore.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database environment is configured to do checksum
verification of pages read into the cache from the backing
filestore.</dd>
</dl>
</li>
</ul>
<a name="setReadUncommitted-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadUncommitted</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setReadUncommitted&#8203;(boolean&nbsp;readUncommitted)</pre>
<div class="block">Configure the database to support read uncommitted.
<p>
Read operations on the database may request the return of modified
but not yet committed data. This flag must be specified on all
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles used to perform read uncommitted or database
updates, otherwise requests for read uncommitted may not be honored and
the read may block.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readUncommitted</code> - If true, configure the database to support read uncommitted.</dd>
</dl>
</li>
</ul>
<a name="getReadUncommitted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadUncommitted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getReadUncommitted()</pre>
<div class="block">Return true if the database is configured to support read uncommitted.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database is configured to support read uncommitted.</dd>
</dl>
</li>
</ul>
<a name="setDirtyRead-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDirtyRead</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;void&nbsp;setDirtyRead&#8203;(boolean&nbsp;dirtyRead)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#setReadUncommitted-boolean-"><code>setReadUncommitted(boolean)</code></a> to conform to ANSI
database isolation terminology.</div>
</div>
<div class="block">Configure the database to support read uncommitted.
<p>
Read operations on the database may request the return of modified
but not yet committed data. This flag must be specified on all
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles used to perform read uncommitted or database
updates, otherwise requests for read uncommitted may not be honored and
the read may block.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dirtyRead</code> - If true, configure the database to support read uncommitted.
<p></dd>
</dl>
</li>
</ul>
<a name="getDirtyRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDirtyRead</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;boolean&nbsp;getDirtyRead()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">This has been replaced by <a href="#getReadUncommitted--"><code>getReadUncommitted()</code></a> to conform to ANSI
database isolation terminology.</div>
</div>
<div class="block">Return true if the database is configured to support read uncommitted.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database is configured to support read uncommitted.
<p></dd>
</dl>
</li>
</ul>
<a name="setDuplicateComparator-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDuplicateComparator</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDuplicateComparator&#8203;(java.util.Comparator&nbsp;duplicateComparator)</pre>
<div class="block">Set the duplicate data item comparison callback. The comparison
function is called whenever it is necessary to compare a data item
specified by the application with a data item currently stored in the
database. This comparator is only used if
<a href="#setSortedDuplicates-boolean-"><code>DatabaseConfig.setSortedDuplicates</code></a> is also configured.
<p>
If no comparison function is specified, the data items are compared
lexically, with shorter data items collating before longer data items.
<p>
The <code>compare</code> method is passed the byte arrays representing
data items in the database. If you know how your data is organized in
the byte array, then you can write a comparison routine that directly
examines the contents of the arrays. Otherwise, you have to
reconstruct your original objects, and then perform the comparison.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>duplicateComparator</code> - the comparison callback for duplicate data items.</dd>
</dl>
</li>
</ul>
<a name="getDuplicateComparator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDuplicateComparator</h4>
<pre class="methodSignature">public&nbsp;java.util.Comparator&nbsp;getDuplicateComparator()</pre>
<div class="block">Return the duplicate data item comparison callback.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the duplicate data item Comparator, or null if the default Comparator
will be used.</dd>
</dl>
</li>
</ul>
<a name="setEncrypted-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncrypted</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEncrypted&#8203;(java.lang.String&nbsp;password)</pre>
<div class="block">Set the password used to perform encryption and decryption.
<p>
Because databases opened within environments use the password
specified to the environment, it is an error to attempt to set a
password in a database created within an environment. To encrypt
a database within an encrypted environment use
<a href="#enableEncrypted-boolean-"><code>DatabaseConfig.enableEncrypted</code></a>
<p>
Berkeley DB uses the Rijndael/AES (also known as the Advanced
Encryption Standard and Federal Information Processing
Standard (FIPS) 197) algorithm for encryption or decryption.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - the password used to perform encryption and decryption</dd>
</dl>
</li>
</ul>
<a name="enableEncrypted-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableEncrypted</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;enableEncrypted&#8203;(boolean&nbsp;enable)</pre>
<div class="block">Enables encryption when the environment is also encrypted, see
<a href="EnvironmentConfig.html#setEncrypted-java.lang.String-"><code>EnvironmentConfig.setEncrypted</code></a>
<p>
To encrypt a database that does not use an environment, see
<a href="#setEncrypted-java.lang.String-"><code>DatabaseConfig.setEncrypted</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enable</code> - encryption on this database.</dd>
</dl>
</li>
</ul>
<a name="getEncrypted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncrypted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getEncrypted()</pre>
<div class="block">Return true if the database has been configured to perform encryption.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database has been configured to perform encryption.</dd>
</dl>
</li>
</ul>
<a name="setErrorHandler-com.sleepycat.db.ErrorHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setErrorHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setErrorHandler&#8203;(<a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a>&nbsp;errorHandler)</pre>
<div class="block">Set the function to be called if an error occurs.
<p>
When an error occurs in the Berkeley DB library, an exception is thrown.
In some cases, however, the error information returned to the
application may be insufficient to completely describe the cause of the
error, especially during initial application debugging.
<p>
The <a href="EnvironmentConfig.html#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>EnvironmentConfig.setErrorHandler</code></a> and <a href="#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>DatabaseConfig.setErrorHandler</code></a> methods are used to enhance the mechanism for reporting
error messages to the application. In some cases, when an error occurs,
Berkeley DB will invoke the ErrorHandler's object error method. It is
up to this method to display the error message in an appropriate manner.
<p>
Alternatively, applications can use <a href="EnvironmentConfig.html#setErrorStream-java.io.OutputStream-"><code>EnvironmentConfig.setErrorStream</code></a> and <a href="#setErrorStream-java.io.OutputStream-"><code>DatabaseConfig.setErrorStream</code></a> to
display the additional information via an output stream. Applications
should not mix these approaches.
<p>
This error-logging enhancement does not slow performance or significantly
increase application size, and may be run during normal operation as well
as during application debugging.
<p>
For <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments,
calling this method affects the entire environment and is equivalent to
calling <a href="EnvironmentConfig.html#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>EnvironmentConfig.setErrorHandler</code></a>.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>errorHandler</code> - The function to be called if an error occurs.</dd>
</dl>
</li>
</ul>
<a name="getErrorHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a>&nbsp;getErrorHandler()</pre>
<div class="block">Return the function to be called if an error occurs.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The function to be called if an error occurs.</dd>
</dl>
</li>
</ul>
<a name="setErrorPrefix-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setErrorPrefix</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setErrorPrefix&#8203;(java.lang.String&nbsp;errorPrefix)</pre>
<div class="block">Set the prefix string that appears before error messages.
<p>
For <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments,
calling this method affects the entire environment and is equivalent to
calling <a href="EnvironmentConfig.html#setErrorPrefix-java.lang.String-"><code>EnvironmentConfig.setErrorPrefix</code></a>.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>errorPrefix</code> - The prefix string that appears before error messages.</dd>
</dl>
</li>
</ul>
<a name="getErrorPrefix--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorPrefix</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getErrorPrefix()</pre>
<div class="block">Return the prefix string that appears before error messages.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The prefix string that appears before error messages.</dd>
</dl>
</li>
</ul>
<a name="setErrorStream-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setErrorStream</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setErrorStream&#8203;(java.io.OutputStream&nbsp;errorStream)</pre>
<div class="block">Set an OutputStream for displaying error messages.
<p>
When an error occurs in the Berkeley DB library, an exception is thrown.
In some cases, however, the error information returned to the
application may be insufficient to completely describe the cause of the
error, especially during initial application debugging.
<p>
The <a href="EnvironmentConfig.html#setErrorStream-java.io.OutputStream-"><code>EnvironmentConfig.setErrorStream</code></a> and
<a href="#setErrorStream-java.io.OutputStream-"><code>DatabaseConfig.setErrorStream</code></a> methods are used to enhance
the mechanism for reporting error messages to the application by setting
a OutputStream to be used for displaying additional Berkeley DB error
messages. In some cases, when an error occurs, Berkeley DB will output
an additional error message to the specified stream.
<p>
The error message will consist of the prefix string and a colon
("<b>:</b>") (if a prefix string was previously specified using
<a href="EnvironmentConfig.html#setErrorPrefix-java.lang.String-"><code>EnvironmentConfig.setErrorPrefix</code></a> or <a href="#setErrorPrefix-java.lang.String-"><code>DatabaseConfig.setErrorPrefix</code></a>), an error string, and a trailing newline character.
<p>
Setting errorStream to null unconfigures the interface.
<p>
Alternatively, applications can use <a href="EnvironmentConfig.html#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>EnvironmentConfig.setErrorHandler</code></a> and <a href="#setErrorHandler-com.sleepycat.db.ErrorHandler-"><code>DatabaseConfig.setErrorHandler</code></a> to capture
the additional error information in a way that does not use output
streams. Applications should not mix these approaches.
<p>
This error-logging enhancement does not slow performance or significantly
increase application size, and may be run during normal operation as well
as during application debugging.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>errorStream</code> - The application-specified OutputStream for error messages.</dd>
</dl>
</li>
</ul>
<a name="getErrorStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getErrorStream</h4>
<pre class="methodSignature">public&nbsp;java.io.OutputStream&nbsp;getErrorStream()</pre>
<div class="block">Return the an OutputStream for displaying error messages.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The an OutputStream for displaying error messages.</dd>
</dl>
</li>
</ul>
<a name="setExclusiveCreate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExclusiveCreate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExclusiveCreate&#8203;(boolean&nbsp;exclusiveCreate)</pre>
<div class="block">Configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to fail if
the database already exists.
<p>
The exclusiveCreate mode is only meaningful if specified with the
allowCreate mode.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exclusiveCreate</code> - If true, configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to
fail if the database already exists.</dd>
</dl>
</li>
</ul>
<a name="getExclusiveCreate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExclusiveCreate</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getExclusiveCreate()</pre>
<div class="block">Return true if the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured
to fail if the database already exists.
<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 <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured
to fail if the database already exists.</dd>
</dl>
</li>
</ul>
<a name="setExternalFileDir-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalFileDir</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExternalFileDir&#8203;(java.io.File&nbsp;dir)</pre>
<div class="block">Sets the path of a directory where external files are stored.
<p>
If the database is opened within an environment, this path setting is
ignored in
<a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a>.
Use <a href="Database.html#getConfig--"><code>Database.getConfig</code></a> and
<a href="#getExternalFileDir--"><code>DatabaseConfig.getExternalFileDir</code></a>
to identify the current storage location of external files after opening
the database.
<p>
This path can not be set after opening the database.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dir</code> - The path of a directory where external files are stored.</dd>
</dl>
</li>
</ul>
<a name="getExternalFileDir--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalFileDir</h4>
<pre class="methodSignature">public&nbsp;java.io.File&nbsp;getExternalFileDir()</pre>
<div class="block">Returns the path of a directory where external files are stored.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The path of a directory where external files are stored.</dd>
</dl>
</li>
</ul>
<a name="setExternalFileThreshold-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalFileThreshold</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExternalFileThreshold&#8203;(int&nbsp;value)</pre>
<div class="block">Set the size in bytes which is used to determine when a data item will be
stored as an external file.
<p>
Any data item that is equal to or larger in size than the
threshold value will automatically be stored as an external file.
<p>
It is illegal to enable external files in the database which is configured
as in-memory database or with duplicates, sorted
duplicates, compression, multiversion concurrency control and
transactional read operations with degree 1 isolation.
<p>
This threshold value can not be set after opening the database.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The size in bytes which is used to determine when a data item will be
stored as an external file. If 0, external files will be never used by the
database.</dd>
</dl>
</li>
</ul>
<a name="getExternalFileThreshold--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalFileThreshold</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getExternalFileThreshold()</pre>
<div class="block">Return the threshold value in bytes beyond which data items are
stored as external files.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The threshold value in bytes beyond which data items are
stored as external files. If 0, external files are not used by the database.</dd>
</dl>
</li>
</ul>
<a name="setFeedbackHandler-com.sleepycat.db.FeedbackHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFeedbackHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setFeedbackHandler&#8203;(<a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a>&nbsp;feedbackHandler)</pre>
<div class="block">Set an object whose methods are called to provide feedback.
<p>
Some operations performed by the Berkeley DB library can take
non-trivial amounts of time. This method can be used by applications
to monitor progress within these operations. When an operation is
likely to take a long time, Berkeley DB will call the object's methods
with progress information.
<p>
It is up to the object's methods to display this information in an
appropriate manner.
<p>
This method configures only operations performed using a single a
<a href="Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>feedbackHandler</code> - An object whose methods are called to provide feedback.</dd>
</dl>
</li>
</ul>
<a name="getFeedbackHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFeedbackHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a>&nbsp;getFeedbackHandler()</pre>
<div class="block">Return the object's methods to be called to provide feedback.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The object's methods to be called to provide feedback.</dd>
</dl>
</li>
</ul>
<a name="setHashFillFactor-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHashFillFactor</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setHashFillFactor&#8203;(int&nbsp;hashFillFactor)</pre>
<div class="block">Set the desired density within the hash table.
<p>
If no value is specified, the fill factor will be selected dynamically
as pages are filled.
<p>
The density is an approximation of the number of keys allowed to
accumulate in any one bucket, determining when the hash table grows or
shrinks. If you know the average sizes of the keys and data in your
data set, setting the fill factor can enhance performance. A reasonable
rule computing fill factor is to set it to the following:
<blockquote><pre>
(pagesize - 32) / (average_key_size + average_data_size + 8)
</pre></blockquote>
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hashFillFactor</code> - The desired density within the hash table.</dd>
</dl>
</li>
</ul>
<a name="getHashFillFactor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHashFillFactor</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getHashFillFactor()</pre>
<div class="block">Return the hash table density.
<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 hash table density.</dd>
</dl>
</li>
</ul>
<a name="setHashComparator-java.util.Comparator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHashComparator</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setHashComparator&#8203;(java.util.Comparator&nbsp;hashComparator)</pre>
<div class="block">Set the Hash key comparison function. The comparison function is called
whenever it is necessary to compare a key specified by the application with
a key currently stored in the database.
<p>
If no comparison function is specified, a byte-by-byte comparison is
performed.
<p>
The <code>compare</code> method is passed the byte arrays representing
keys that are stored in the database. If you know how your data is
organized in the byte array, then you can write a comparison routine that
directly examines the contents of the arrays. Otherwise, you have to
reconstruct your original objects, and then perform the comparison.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hashComparator</code> - the Comparator used to compare keys in a Hash database</dd>
</dl>
</li>
</ul>
<a name="getHashComparator--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHashComparator</h4>
<pre class="methodSignature">public&nbsp;java.util.Comparator&nbsp;getHashComparator()</pre>
<div class="block">Return the Comparator used to compare keys in a Hash database.
<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 Comparator used to compare keys in a Hash database.</dd>
</dl>
</li>
</ul>
<a name="setHasher-com.sleepycat.db.Hasher-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHasher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setHasher&#8203;(<a href="Hasher.html" title="interface in com.sleepycat.db">Hasher</a>&nbsp;hasher)</pre>
<div class="block">Set a database-specific hash function.
<p>
If no hash function is specified, a default hash function is used.
Because no hash function performs equally well on all possible data,
the user may find that the built-in hash function performs poorly
with a particular data set.
<p>
This method configures operations performed using the specified
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> object, not all operations performed on the underlying
database.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method must be the same as that
historically used to create the database or corruption can occur.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hasher</code> - A database-specific hash function.</dd>
</dl>
</li>
</ul>
<a name="getHasher--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHasher</h4>
<pre class="methodSignature">public&nbsp;<a href="Hasher.html" title="interface in com.sleepycat.db">Hasher</a>&nbsp;getHasher()</pre>
<div class="block">Return the database-specific hash function.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The database-specific hash function.</dd>
</dl>
</li>
</ul>
<a name="setHashNumElements-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHashNumElements</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setHashNumElements&#8203;(int&nbsp;hashNumElements)</pre>
<div class="block">Set an estimate of the final size of the hash table.
<p>
In order for the estimate to be used when creating the database, the
<a href="#setHashFillFactor-int-"><code>DatabaseConfig.setHashFillFactor</code></a> method must also be called.
If the estimate or fill factor are not set or are set too low, hash
tables will still expand gracefully as keys are entered, although a
slight performance degradation may be noticed.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>hashNumElements</code> - An estimate of the final size of the hash table.</dd>
</dl>
</li>
</ul>
<a name="getHashNumElements--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHashNumElements</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getHashNumElements()</pre>
<div class="block">Return the estimate of the final size of the hash table.
<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 estimate of the final size of the hash table.</dd>
</dl>
</li>
</ul>
<a name="setHeapsize-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeapsize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setHeapsize&#8203;(long&nbsp;bytes)</pre>
<div class="block">Set the maximum on-disk database file size used by a database configured to
use the Heap access method. If this method is never called, the database's
file size can grow without bound. If this method is called, then the heap
file can never grow larger than the limit defined by this method. In that
case, attempts to update or create records in a Heap database that has
reached its maximum size will throw a <a href="HeapFullException.html" title="class in com.sleepycat.db"><code>HeapFullException</code></a>.
<p>
The size specified to this method must be at least three times the database
page size. That is, a Heap database must contain at least three database
pages. You can set the database page size using <a href="#setPageSize-int-"><code>setPageSize(int)</code></a>.
<p>
This method may not be called after the database is opened. Further, if this
method is called on an existing Heap database, the size specified here must
match the size used to create the database. Note, however, that specifying
an incorrect size to this method will not result in an error return until
the database is opened.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>bytes</code> - The maximum on-disk database file size.</dd>
</dl>
</li>
</ul>
<a name="getHeapsize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeapsize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getHeapsize()</pre>
<div class="block">Return the maximum on-disk database file size.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The maximum on-disk database file size.</dd>
</dl>
</li>
</ul>
<a name="setHeapRegionSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setHeapRegionSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setHeapRegionSize&#8203;(int&nbsp;npages)</pre>
<div class="block">Sets the number of pages in a region of a database configured to use
the Heap access method. If this method is never called, the default region
size for the database's page size will be used. You can set the database
page size using <a href="#setPageSize-int-"><code>setPageSize(int)</code></a>.
<p>
This method may not be called after the database is opened. Further, if this
method is called on an existing Heap database, the value specified here will
be ignored. If the specified region size is larger than the maximum region
size for the database's page size, an error will be returned when the
database is opened. The maximum allowable region size will be included in
the error message.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>npages</code> - The size of the region, in pages.</dd>
</dl>
</li>
</ul>
<a name="getHeapRegionSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeapRegionSize</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getHeapRegionSize()</pre>
<div class="block">Return the number of pages in a region of the database.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The size of the region, in pages.</dd>
</dl>
</li>
</ul>
<a name="setMessageHandler-com.sleepycat.db.MessageHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMessageHandler&#8203;(<a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a>&nbsp;messageHandler)</pre>
<div class="block">Set a function to be called with an informational message.
<p>
There are interfaces in the Berkeley DB library which either directly
output informational messages or statistical information, or configure
the library to output such messages when performing other operations,
<a href="EnvironmentConfig.html#setVerboseDeadlock-boolean-"><code>EnvironmentConfig.setVerboseDeadlock</code></a> for example.
<p>
The <a href="EnvironmentConfig.html#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>EnvironmentConfig.setMessageHandler</code></a> and
<a href="#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>DatabaseConfig.setMessageHandler</code></a> methods are used to display
these messages for the application.
<p>
Setting messageHandler to null unconfigures the interface.
<p>
Alternatively, you can use <a href="EnvironmentConfig.html#setMessageStream-java.io.OutputStream-"><code>EnvironmentConfig.setMessageStream</code></a>
and <a href="#setMessageStream-java.io.OutputStream-"><code>DatabaseConfig.setMessageStream</code></a> to send the additional
information directly to an output streams. You should not mix these
approaches.
<p>
For <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments,
calling this method affects the entire environment and is equivalent to
calling <a href="EnvironmentConfig.html#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>EnvironmentConfig.setMessageHandler</code></a>.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageHandler</code> - The application-specified function for informational messages.</dd>
</dl>
</li>
</ul>
<a name="getMessageHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a>&nbsp;getMessageHandler()</pre>
<div class="block">Return the function to be called with an informational message.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The function to be called with an informational message.</dd>
</dl>
</li>
</ul>
<a name="setMessagePrefix-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessagePrefix</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMessagePrefix&#8203;(java.lang.String&nbsp;messagePrefix)</pre>
<div class="block">Set the prefix string that appears before informational messages.
<p>
For <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments,
calling this method affects the entire environment and is equivalent to
calling <a href="EnvironmentConfig.html#setMessagePrefix-java.lang.String-"><code>EnvironmentConfig.setMessagePrefix</code></a>.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messagePrefix</code> - The prefix string that appears before informational messages.</dd>
</dl>
</li>
</ul>
<a name="getMessagePrefix--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessagePrefix</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getMessagePrefix()</pre>
<div class="block">Return the prefix string that appears before informational messages.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The prefix string that appears before informational messages.</dd>
</dl>
</li>
</ul>
<a name="setMsgfile-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMsgfile</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMsgfile&#8203;(java.io.File&nbsp;file)</pre>
<div class="block">Sets the path of a file to store statistical information.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>file</code> - The path of a file to store statistical information.</dd>
</dl>
</li>
</ul>
<a name="setMessageStream-java.io.OutputStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMessageStream</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMessageStream&#8203;(java.io.OutputStream&nbsp;messageStream)</pre>
<div class="block">Set an OutputStream for displaying informational messages.
<p>
There are interfaces in the Berkeley DB library which either directly
output informational messages or statistical information, or configure
the library to output such messages when performing other operations,
<a href="EnvironmentConfig.html#setVerboseDeadlock-boolean-"><code>EnvironmentConfig.setVerboseDeadlock</code></a> for example.
<p>
The <a href="EnvironmentConfig.html#setMessageStream-java.io.OutputStream-"><code>EnvironmentConfig.setMessageStream</code></a> and
<a href="#setMessageStream-java.io.OutputStream-"><code>DatabaseConfig.setMessageStream</code></a> methods are used to display
these messages for the application. In this case, the message will
include a trailing newline character.
<p>
The error message will consist of the prefix string and a colon
("<b>:</b>") (if a prefix string was previously specified using
<a href="EnvironmentConfig.html#setMessagePrefix-java.lang.String-"><code>EnvironmentConfig.setMessagePrefix</code></a> or <a href="#setMessagePrefix-java.lang.String-"><code>DatabaseConfig.setMessagePrefix</code></a>), an informational string, and a trailing newline character.
<p>
Setting messageStream to null unconfigures the interface.
<p>
Alternatively, you can use <a href="EnvironmentConfig.html#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>EnvironmentConfig.setMessageHandler</code></a>
and <a href="#setMessageHandler-com.sleepycat.db.MessageHandler-"><code>DatabaseConfig.setMessageHandler</code></a> to capture the additional
information in a way that does not use output streams. You should not
mix these approaches.
<p>
For <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments,
calling this method affects the entire environment and is equivalent to
calling <a href="EnvironmentConfig.html#setMessageStream-java.io.OutputStream-"><code>EnvironmentConfig.setMessageStream</code></a>.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>messageStream</code> - The application-specified OutputStream for informational messages.</dd>
</dl>
</li>
</ul>
<a name="getMessageStream--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMessageStream</h4>
<pre class="methodSignature">public&nbsp;java.io.OutputStream&nbsp;getMessageStream()</pre>
<div class="block">Return the an OutputStream for displaying informational messages.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The an OutputStream for displaying informational messages.</dd>
</dl>
</li>
</ul>
<a name="setMode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMode</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMode&#8203;(int&nbsp;mode)</pre>
<div class="block">On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files
created by the database open are created with mode <code>mode</code>
(as described in the <code>chmod</code>(2) manual page) and modified
by the process' umask value at the time of creation (see the
<code>umask</code>(2) manual page). Created files are owned by the
process owner; the group ownership of created files is based on the
system and directory defaults, and is not further specified by Berkeley
DB. System shared memory segments created by the database open are
created with mode <code>mode</code>, unmodified by the process' umask
value. If <code>mode</code> is 0, the database open will use a default
mode of readable and writable by both owner and group.
<p>
On Windows systems, the mode parameter is ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mode</code> - the mode used to create files</dd>
</dl>
</li>
</ul>
<a name="getMode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMode</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getMode()</pre>
<div class="block">Return the mode used to create files.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The mode used to create files.</dd>
</dl>
</li>
</ul>
<a name="setMultiversion-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMultiversion</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMultiversion&#8203;(boolean&nbsp;multiversion)</pre>
<div class="block">Configured the database with support for multiversion concurrency control.
This will cause updates to the database to follow a copy-on-write
protocol, which is required to support Snapshot Isolation. See
<a href="TransactionConfig.html#setSnapshot-boolean-"><code>TransactionConfig.setSnapshot(boolean)</code></a>) for more information.
Multiversion access requires that the database be opened
in a transaction and is not supported for queue databases.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>multiversion</code> - If true, configure the database with support for multiversion concurrency
control.</dd>
</dl>
</li>
</ul>
<a name="getMultiversion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMultiversion</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getMultiversion()</pre>
<div class="block">Return true if the database is configured for multiversion concurrency control.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database is configured for multiversion concurrency control.</dd>
</dl>
</li>
</ul>
<a name="setNoMMap-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNoMMap</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNoMMap&#8203;(boolean&nbsp;noMMap)</pre>
<div class="block">Configure the library to not map this database into memory.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>noMMap</code> - If true, configure the library to not map this database into memory.</dd>
</dl>
</li>
</ul>
<a name="getNoMMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNoMMap</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getNoMMap()</pre>
<div class="block">Return true if the library is configured to not map this database into
memory.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the library is configured to not map this database into
memory.</dd>
</dl>
</li>
</ul>
<a name="setNoWaitDbExclusiveLock-java.lang.Boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNoWaitDbExclusiveLock</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setNoWaitDbExclusiveLock&#8203;(java.lang.Boolean&nbsp;noWaitDbExclLock)</pre>
<div class="block">Configure the <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a
write lock on the entire database.
<p>
This method may not be called after the database is opened.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>noWaitDbExclLock</code> - If True, configure the <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to
obtain a write lock on the entire database. When the database is opened it will
immediately throw
<a href="LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a> if it
cannot obtain the exclusive lock immediately. If False, configure the
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a write lock on the
entire database. When the database is opened, it will block until it can obtain
the exclusive lock. If null, do not configure the
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a write lock on the
entire database.
<p>
Handles configured for a write lock on the entire database can only have one
active transaction at a time.</dd>
</dl>
</li>
</ul>
<a name="getNoWaitDbExclusiveLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNoWaitDbExclusiveLock</h4>
<pre class="methodSignature">public&nbsp;java.lang.Boolean&nbsp;getNoWaitDbExclusiveLock()</pre>
<div class="block">Return whether the <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is
configured to obtain a write lock on the entire database.
<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 <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is configured for
immediate exclusive database locking. In this case, the locking operation will
error out if it cannot immediately obtain an exclusive lock. False if the
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is configured for exclusive
database locking. In this case, it will block until it can obtain the exclusive
database lock when database is opened. Null if the
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is not configured for
exclusive locking.</dd>
</dl>
</li>
</ul>
<a name="setPageSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPageSize&#8203;(int&nbsp;pageSize)</pre>
<div class="block">Set the size of the pages used to hold items in the database, in bytes.
<p>
The minimum page size is 512 bytes, the maximum page size is 64K bytes,
and the page size must be a power-of-two. If the page size is not
explicitly set, one is selected based on the underlying filesystem I/O
block size. The automatically selected size has a lower limit of 512
bytes and an upper limit of 16K bytes.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
If creating additional databases in a file, the page size specified must
be consistent with the existing databases in the file or an error will
be returned.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pageSize</code> - The size of the pages used to hold items in the database, in bytes.</dd>
</dl>
</li>
</ul>
<a name="getPageSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPageSize()</pre>
<div class="block">Return the size of the pages used to hold items in the database, in bytes.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The size of the pages used to hold items in the database, in bytes.</dd>
</dl>
</li>
</ul>
<a name="setPanicHandler-com.sleepycat.db.PanicHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPanicHandler</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPanicHandler&#8203;(<a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a>&nbsp;panicHandler)</pre>
<div class="block">Set the function to be called if the database environment panics.
<p>
Errors can occur in the Berkeley DB library where the only solution is
to shut down the application and run recovery (for example, if Berkeley
DB is unable to allocate heap memory). In such cases, the Berkeley DB
methods will throw a <a href="RunRecoveryException.html" title="class in com.sleepycat.db"><code>RunRecoveryException</code></a>. It is often easier
to simply exit the application when such errors occur rather than
gracefully return up the stack. This method specifies a function to be
called when <a href="RunRecoveryException.html" title="class in com.sleepycat.db"><code>RunRecoveryException</code></a> is about to be thrown from a
Berkeley DB method.
<p>
For <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments,
calling this method affects the entire environment and is equivalent to
calling <a href="EnvironmentConfig.html#setPanicHandler-com.sleepycat.db.PanicHandler-"><code>EnvironmentConfig.setPanicHandler</code></a>.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>panicHandler</code> - The function to be called if the database environment panics.</dd>
</dl>
</li>
</ul>
<a name="getPanicHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPanicHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a>&nbsp;getPanicHandler()</pre>
<div class="block">Return the function to be called if the database environment panics.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The function to be called if the database environment panics.</dd>
</dl>
</li>
</ul>
<a name="setPartitionByCallback-int-com.sleepycat.db.PartitionHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitionByCallback</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPartitionByCallback&#8203;(int&nbsp;parts,
<a href="PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a>&nbsp;partitionHandler)</pre>
<div class="block">Enable or disable database partitioning, and set the callback that will
be used for the partitioning.
<p>
This method may only be called before opening a database.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parts</code> - The number of partitions that will be created.
<p></dd>
<dd><code>partitionHandler</code> - The function to be called to determine which partition a key resides in.</dd>
</dl>
</li>
</ul>
<a name="setPartitionByRange-int-com.sleepycat.db.MultipleDataEntry-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitionByRange</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPartitionByRange&#8203;(int&nbsp;parts,
<a href="MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</a>&nbsp;keys)</pre>
<div class="block">Enable or disable database partitioning, and set key ranges that will be
used for the partitioning.
<p>
This method may only be called before opening a database.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parts</code> - The number of partitions that will be created.
<p></dd>
<dd><code>keys</code> - A MultipleDatabaseEntry that contains the boundary keys for partitioning.
<p></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if parts is not equal to the size of key array plus 1.</dd>
</dl>
</li>
</ul>
<a name="getPartitionHandler--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionHandler</h4>
<pre class="methodSignature">public&nbsp;<a href="PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a>&nbsp;getPartitionHandler()</pre>
<div class="block">Return the function to be called to determine which partition a key resides in.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The function to be called to determine which partition a key resides in.</dd>
</dl>
</li>
</ul>
<a name="getPartitionParts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionParts</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getPartitionParts()</pre>
<div class="block">Return the number of partitions the database is configured for.
<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 partitions the database is configured for.</dd>
</dl>
</li>
</ul>
<a name="getPartitionKeys--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionKeys</h4>
<pre class="methodSignature">public&nbsp;<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a>&nbsp;getPartitionKeys()</pre>
<div class="block">Return the array of keys the database is configured to partition with.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The array of keys the database is configured to partition with.</dd>
</dl>
</li>
</ul>
<a name="setPartitionDirs-java.io.File:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPartitionDirs</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPartitionDirs&#8203;(java.io.File[]&nbsp;dirs)</pre>
<div class="block">Specify the array of directories the database extents should be created in or
looked for. If the number of directories is less than the number of partitions,
the directories will be used in a round robin fasion.
<p>
This method may only be called before the database is opened.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dirs</code> - The array of directories the database extents should be created in or looked
for.</dd>
</dl>
</li>
</ul>
<a name="getPartitionDirs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPartitionDirs</h4>
<pre class="methodSignature">public&nbsp;java.io.File[]&nbsp;getPartitionDirs()</pre>
<div class="block">Return the array of directories the database extents should be created in or
looked for. If the number of directories is less than the number of partitions,
the directories will be used in a round robin fasion.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The array of directories the database extents should be created in or looked
for.</dd>
</dl>
</li>
</ul>
<a name="setPriority-com.sleepycat.db.CacheFilePriority-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPriority</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setPriority&#8203;(<a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a>&nbsp;priority)</pre>
<div class="block">Set the cache priority for pages referenced by the DB handle.
<p>
The priority of a page biases the replacement algorithm to be more or less
likely to discard a page when space is needed in the buffer pool. The bias
is temporary, and pages will eventually be discarded if they are not
referenced again. The priority setting is only advisory, and does not
guarantee pages will be treated in a specific way.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>priority</code> - The desired cache priority.</dd>
</dl>
</li>
</ul>
<a name="getPriority--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPriority</h4>
<pre class="methodSignature">public&nbsp;<a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a>&nbsp;getPriority()</pre>
<div class="block">Return the the cache priority for pages referenced by this handle.
<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 cache priority for pages referenced by this handle.</dd>
</dl>
</li>
</ul>
<a name="setQueueExtentSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueueExtentSize</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setQueueExtentSize&#8203;(int&nbsp;queueExtentSize)</pre>
<div class="block">Set the size of the extents used to hold pages in a Queue database,
specified as a number of pages.
<p>
Each extent is created as a separate physical file. If no extent
size is set, the default behavior is to create only a single
underlying database file.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queueExtentSize</code> - The number of pages in a Queue database extent.</dd>
</dl>
</li>
</ul>
<a name="getQueueExtentSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueExtentSize</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getQueueExtentSize()</pre>
<div class="block">Return the size of the extents used to hold pages in a Queue database,
specified as a number of pages.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The size of the extents used to hold pages in a Queue database,
specified as a number of pages.</dd>
</dl>
</li>
</ul>
<a name="setQueueInOrder-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQueueInOrder</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setQueueInOrder&#8203;(boolean&nbsp;queueInOrder)</pre>
<div class="block">Configure <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> to return key/data pairs in
order, always returning the key/data item from the head of the
queue.
<p>
The default behavior of queue databases is optimized for multiple
readers, and does not guarantee that record will be retrieved in the
order they are added to the queue. Specifically, if a writing
thread adds multiple records to an empty queue, reading threads may
skip some of the initial records when the next call to retrieve a
key/data pair returns.
<p>
This flag configures the <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> method to verify
that the record being returned is in fact the head of the queue.
This will increase contention and reduce concurrency when there are
many reading threads.
<p>
Calling this method only affects the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle
(and any other library handles opened within the scope of that handle).
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>queueInOrder</code> - If true, configure the <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> method to return
key/data pairs in order, always returning the key/data item from the
head of the queue.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getQueueInOrder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQueueInOrder</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getQueueInOrder()</pre>
<div class="block">Return true if the <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> method is configured to return
key/data pairs in order, always returning the key/data item from the
head of the queue.
<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 <a href="Database.html#consume-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-boolean-"><code>Database.consume</code></a> method is configured to return
key/data pairs in order, always returning the key/data item from the
head of the queue.</dd>
</dl>
</li>
</ul>
<a name="setReadOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadOnly</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setReadOnly&#8203;(boolean&nbsp;readOnly)</pre>
<div class="block">Configure the database in read-only mode.
<p>
Any attempt to modify items in the database will fail, regardless
of the actual permissions of any underlying files.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readOnly</code> - If true, configure the database in read-only mode.</dd>
</dl>
</li>
</ul>
<a name="getReadOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadOnly</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getReadOnly()</pre>
<div class="block">Return true if the database is configured in read-only mode.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database is configured in read-only mode.</dd>
</dl>
</li>
</ul>
<a name="setRecordNumberAppender-com.sleepycat.db.RecordNumberAppender-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecordNumberAppender</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRecordNumberAppender&#8203;(<a href="RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a>&nbsp;recnoAppender)</pre>
<div class="block">Configure <a href="Database.html#append-com.sleepycat.db.Transaction-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-"><code>Database.append</code></a> to call the function after the
record number has been selected but before the data has been stored
into the database.
<p>
This method configures operations performed using the specified
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> object, not all operations performed on the underlying
database.
<p>
This method may not be called after the database is opened.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recnoAppender</code> - The function to call after the record number has been selected but
before the data has been stored into the database.</dd>
</dl>
</li>
</ul>
<a name="getRecordNumberAppender--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordNumberAppender</h4>
<pre class="methodSignature">public&nbsp;<a href="RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a>&nbsp;getRecordNumberAppender()</pre>
<div class="block">Return the function to call after the record number has been
selected but before the data has been stored into the database.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The function to call after the record number has been
selected but before the data has been stored into the database.</dd>
</dl>
</li>
</ul>
<a name="setRecordDelimiter-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecordDelimiter</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRecordDelimiter&#8203;(int&nbsp;recordDelimiter)</pre>
<div class="block">Set the delimiting byte used to mark the end of a record in the backing
source file for the Recno access method.
<p>
This byte is used for variable length records if a backing source
file is specified. If a backing source file is specified and no
delimiting byte was specified, newline characters (that is, ASCII
0x0a) are interpreted as end-of-record markers.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recordDelimiter</code> - The delimiting byte used to mark the end of a record in the backing
source file for the Recno access method.</dd>
</dl>
</li>
</ul>
<a name="getRecordDelimiter--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordDelimiter</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRecordDelimiter()</pre>
<div class="block">Return the delimiting byte used to mark the end of a record in the
backing source file for the Recno access method.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The delimiting byte used to mark the end of a record in the
backing source file for the Recno access method.</dd>
</dl>
</li>
</ul>
<a name="setRecordLength-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecordLength</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRecordLength&#8203;(int&nbsp;recordLength)</pre>
<div class="block">Specify the database record length, in bytes.
<p>
For the Queue access method, specify the record length. For the
Queue access method, the record length must be enough smaller than
the database's page size that at least one record plus the database
page's metadata information can fit on each database page.
<p>
For the Recno access method, specify the records are fixed-length,
not byte-delimited, and the record length.
<p>
Any records added to the database that are less than the specified
length are automatically padded (see
<a href="#setRecordPad-int-"><code>DatabaseConfig.setRecordPad</code></a> for more information).
<p>
Any attempt to insert records into the database that are greater
than the specified length will cause the call to fail.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recordLength</code> - The database record length, in bytes.</dd>
</dl>
</li>
</ul>
<a name="getRecordLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordLength</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRecordLength()</pre>
<div class="block">Return the database record length, in bytes.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The database record length, in bytes.</dd>
</dl>
</li>
</ul>
<a name="setBtreeRecordNumbers-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBtreeRecordNumbers</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBtreeRecordNumbers&#8203;(boolean&nbsp;btreeRecordNumbers)</pre>
<div class="block">Configure the Btree to support retrieval by record number.
<p>
Logical record numbers in Btree databases are mutable in the face of
record insertion or deletion.
<p>
Maintaining record counts within a Btree introduces a serious point
of contention, namely the page locations where the record counts are
stored. In addition, the entire database must be locked during both
insertions and deletions, effectively single-threading the database
for those operations. Configuring a Btree for retrieval by record
number can result in serious performance degradation for some
applications and data sets.
<p>
Retrieval by record number may not be configured for a Btree that also
supports duplicate data items.
<p>
Calling this method affects the database, including all threads of
control accessing the database.
<p>
If the database already exists when the database is opened, any database
configuration specified by this method
must be the same as the existing database or an error
will be returned.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>btreeRecordNumbers</code> - If true, configure the Btree to support retrieval by record number.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getBtreeRecordNumbers--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBtreeRecordNumbers</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getBtreeRecordNumbers()</pre>
<div class="block">Return true if the Btree is configured to support retrieval by record 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>True if the Btree is configured to support retrieval by record number.</dd>
</dl>
</li>
</ul>
<a name="setRecordPad-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecordPad</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRecordPad&#8203;(int&nbsp;recordPad)</pre>
<div class="block">Set the padding character for short, fixed-length records for the Queue
and Recno access methods.
<p>
If no pad character is specified, "space" characters (that is, ASCII
0x20) are used for padding.
<p>
This method configures a database, not only operations performed using
the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method will be ignored.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recordPad</code> - The padding character for short, fixed-length records for the Queue
and Recno access methods.</dd>
</dl>
</li>
</ul>
<a name="getRecordPad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordPad</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getRecordPad()</pre>
<div class="block">Return the padding character for short, fixed-length records for the
Queue and Recno access methods.
<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 padding character for short, fixed-length records for the
Queue and Recno access methods.</dd>
</dl>
</li>
</ul>
<a name="setRecordSource-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRecordSource</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRecordSource&#8203;(java.io.File&nbsp;recordSource)</pre>
<div class="block">Set the underlying source file for the Recno access method.
<p>
The purpose of the source file is to provide fast access and
modification to databases that are normally stored as flat text
files.
<p>
The recordSource parameter specifies an underlying flat text
database file that is read to initialize a transient record number
index. In the case of variable length records, the records are
separated, as specified by the
<a href="#setRecordDelimiter-int-"><code>DatabaseConfig.setRecordDelimiter</code></a> method. For example,
standard UNIX byte stream files can be interpreted as a sequence of
variable length records separated by newline characters (that is, ASCII
0x0a).
<p>
In addition, when cached data would normally be written back to the
underlying database file (for example, the <a href="Database.html#close-boolean-"><code>Database.close</code></a>
or <a href="Database.html#sync--"><code>Database.sync</code></a> methods are called), the in-memory copy
of the database will be written back to the source file.
<p>
By default, the backing source file is read lazily; that is, records
are not read from the file until they are requested by the application.
<b>
If multiple processes (not threads) are accessing a Recno database
concurrently, and are either inserting or deleting records, the backing
source file must be read in its entirety before more than a single
process accesses the database, and only that process should specify
the backing source file as part of opening the database. See the
<a href="#setSnapshot-boolean-"><code>DatabaseConfig.setSnapshot</code></a> method for more information.
</b>
<p>
<b>
Reading and writing the backing source file cannot be
transaction-protected because it involves filesystem operations that
are not part of the <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> transaction methodology. For
this reason, if a temporary database is used to hold the records,
it is possible to lose the contents of the source file, for example,
if the system crashes at the right instant. If a file is used to
hold the database, normal database recovery on that file can be used
to prevent information loss, although it is still possible that the
contents of the source file will be lost if the system crashes.
</b>
<p>
The source file must already exist (but may be zero-length) when
the database is opened.
<p>
It is not an error to specify a read-only source file when creating
a database, nor is it an error to modify the resulting database.
However, any attempt to write the changes to the backing source file
using either the <a href="Database.html#sync--"><code>Database.sync</code></a> or <a href="Database.html#close-boolean-"><code>Database.close</code></a>
methods will fail, of course. Specify the noSync argument to the
<a href="Database.html#close-boolean-"><code>Database.close</code></a> method to stop it from attempting to write
the changes to the backing file; instead, they will be silently
discarded.
<p>
For all of the previous reasons, the source file is generally used
to specify databases that are read-only for Berkeley DB
applications; and that are either generated on the fly by software
tools or modified using a different mechanism -- for example, a text
editor.
<p>
This method configures operations performed using the specified
<a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> object, not all operations performed on the underlying
database.
<p>
This method may not be called after the database is opened.
If the database already exists when it is opened,
the information specified to this method must be the same as that
historically used to create the database or corruption can occur.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>recordSource</code> - The name of an underlying flat text database file that is read to
initialize a transient record number index. In the case of variable
length records, the records are separated, as specified by the
<a href="#setRecordDelimiter-int-"><code>DatabaseConfig.setRecordDelimiter</code></a> method. For example,
standard UNIX byte stream files can be interpreted as a sequence of
variable length records separated by newline characters (that is, ASCII
0x0a).</dd>
</dl>
</li>
</ul>
<a name="getRecordSource--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRecordSource</h4>
<pre class="methodSignature">public&nbsp;java.io.File&nbsp;getRecordSource()</pre>
<div class="block">Return the name of an underlying flat text database file that is
read to initialize a transient record number index.
<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 name of an underlying flat text database file that is
read to initialize a transient record number index.</dd>
</dl>
</li>
</ul>
<a name="setRenumbering-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRenumbering</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRenumbering&#8203;(boolean&nbsp;renumbering)</pre>
<div class="block">Configure the logical record numbers to be mutable, and change as
records are added to and deleted from the database.
<p>
For example, the deletion of record number 4 causes records numbered
5 and greater to be renumbered downward by one. If a cursor was
positioned to record number 4 before the deletion, it will refer to
the new record number 4, if any such record exists, after the
deletion. If a cursor was positioned after record number 4 before
the deletion, it will be shifted downward one logical record,
continuing to refer to the same record as it did before.
<p>
Creating new records will cause the creation of multiple records if
the record number is more than one greater than the largest record
currently in the database. For example, creating record 28, when
record 25 was previously the last record in the database, will
create records 26 and 27 as well as 28. Attempts to retrieve
records that were created in this manner will result in an error
return of <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a>.
<p>
If a created record is not at the end of the database, all records
following the new record will be automatically renumbered upward by one.
For example, the creation of a new record numbered 8 causes records
numbered 8 and greater to be renumbered upward by one. If a cursor was
positioned to record number 8 or greater before the insertion, it will
be shifted upward one logical record, continuing to refer to the same
record as it did before.
<p>
For these reasons, concurrent access to a Recno database configured
with mutable record numbers may be largely meaningless, although it
is supported.
<p>
Calling this method affects the database, including all threads of
control accessing the database.
<p>
If the database already exists when the database is opened, any database
configuration specified by this method
must be the same as the existing database or an error
will be returned.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>renumbering</code> - If true, configure the logical record numbers to be mutable, and
change as records are added to and deleted from the database.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getRenumbering--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRenumbering</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getRenumbering()</pre>
<div class="block">Return true if the logical record numbers are mutable, and change as
records are added to and deleted from the database.
<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 logical record numbers are mutable, and change as
records are added to and deleted from the database.</dd>
</dl>
</li>
</ul>
<a name="setReverseSplitOff-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReverseSplitOff</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setReverseSplitOff&#8203;(boolean&nbsp;reverseSplitOff)</pre>
<div class="block">Configure the Btree to not do reverse splits.
<p>
As pages are emptied in a database, the Btree implementation
attempts to coalesce empty pages into higher-level pages in order
to keep the database as small as possible and minimize search time.
This can hurt performance in applications with cyclical data
demands; that is, applications where the database grows and shrinks
repeatedly. For example, because Berkeley DB does page-level locking,
the maximum level of concurrency in a database of two pages is far
smaller than that in a database of 100 pages, so a database that has
shrunk to a minimal size can cause severe deadlocking when a new
cycle of data insertion begins.
<p>
Calling this method only affects the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle
(and any other library handles opened within the scope of that handle).
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>reverseSplitOff</code> - If true, configure the Btree to not do reverse splits.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getReverseSplitOff--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReverseSplitOff</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getReverseSplitOff()</pre>
<div class="block">Return true if the Btree has been configured to not do reverse splits.
<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 Btree has been configured to not do reverse splits.</dd>
</dl>
</li>
</ul>
<a name="setSortedDuplicates-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortedDuplicates</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSortedDuplicates&#8203;(boolean&nbsp;sortedDuplicates)</pre>
<div class="block">Configure the database to support sorted, duplicate data items.
<p>
Insertion when the key of the key/data pair being inserted already
exists in the database will be successful. The ordering of
duplicates in the database is determined by the duplicate comparison
function.
<p>
If the application does not specify a duplicate data item comparison
function, a default lexical comparison will be used.
<p>
If a primary database is to be associated with one or more secondary
databases, it may not be configured for duplicates.
<p>
A Btree that supports duplicate data items cannot also be configured
for retrieval by record number.
<p>
Calling this method affects the database, including all threads of
control accessing the database.
<p>
If the database already exists when the database is opened, any database
configuration specified by this method
must be the same as the existing database or an error
will be returned.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sortedDuplicates</code> - If true, configure the database to support duplicate data items.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getSortedDuplicates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSortedDuplicates</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getSortedDuplicates()</pre>
<div class="block">Return true if the database is configured to support sorted duplicate data
items.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database is configured to support sorted duplicate data
items.</dd>
</dl>
</li>
</ul>
<a name="setUnsortedDuplicates-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnsortedDuplicates</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setUnsortedDuplicates&#8203;(boolean&nbsp;unsortedDuplicates)</pre>
<div class="block">Configure the database to support unsorted duplicate data items.
<p>
Insertion when the key of the key/data pair being inserted already
exists in the database will be successful. The ordering of
duplicates in the database is determined by the order of insertion,
unless the ordering is otherwise specified by use of a database
cursor operation.
<p>
If a primary database is to be associated with one or more secondary
databases, it may not be configured for duplicates.
<p>
Sorted duplicates are preferred to unsorted duplicates for
performance reasons. Unsorted duplicates should only be used by
applications wanting to order duplicate data items manually.
<p>
Calling this method affects the database, including all threads of
control accessing the database.
<p>
If the database already exists when the database is opened, any database
configuration specified by this method
must be the same as the existing database or an error
will be returned.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>unsortedDuplicates</code> - If true, configure the database to support unsorted duplicate data items.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getUnsortedDuplicates--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnsortedDuplicates</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getUnsortedDuplicates()</pre>
<div class="block">Return true if the database is configured to support duplicate data items.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database is configured to support duplicate data items.</dd>
</dl>
</li>
</ul>
<a name="setSliced-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSliced</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSliced&#8203;(boolean&nbsp;sliced)</pre>
<div class="block">Configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to open or create a sliced database.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sliced</code> - If true, configure the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method to open or created a sliced database.</dd>
</dl>
</li>
</ul>
<a name="getSliced--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSliced</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getSliced()</pre>
<div class="block">Return true if the <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured to create a sliced database.
<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 <a href="Environment.html#openDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.DatabaseConfig-"><code>Environment.openDatabase</code></a> method is configured to create a sliced database.</dd>
</dl>
</li>
</ul>
<a name="setSnapshot-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSnapshot</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSnapshot&#8203;(boolean&nbsp;snapshot)</pre>
<div class="block">Specify that any specified backing source file be read in its entirety
when the database is opened.
<p>
If this flag is not specified, the backing source file may be read
lazily.
<p>
Calling this method only affects the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle
(and any other library handles opened within the scope of that handle).
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>snapshot</code> - If true, any specified backing source file will be read in its entirety
when the database is opened.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getSnapshot--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSnapshot</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getSnapshot()</pre>
<div class="block">Return true if the any specified backing source file will be read in its
entirety when the database is opened.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the any specified backing source file will be read in its
entirety when the database is opened.</dd>
</dl>
</li>
</ul>
<a name="getTransactional--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactional</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getTransactional()</pre>
<div class="block">Return true if the database open is enclosed within a transaction.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database open is enclosed within a transaction.</dd>
</dl>
</li>
</ul>
<a name="setTransactional-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactional</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTransactional&#8203;(boolean&nbsp;transactional)</pre>
<div class="block">Enclose the database open within a transaction.
<p>
If the call succeeds, the open operation will be recoverable. If
the call fails, no database will have been created.
<p>
All future operations on this database, which are not explicitly
enclosed in a transaction by the application, will be enclosed in
in a transaction within the library.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transactional</code> - If true, enclose the database open within a transaction.</dd>
</dl>
</li>
</ul>
<a name="setTransactionNotDurable-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactionNotDurable</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTransactionNotDurable&#8203;(boolean&nbsp;transactionNotDurable)</pre>
<div class="block">Configure the database environment to not write log records for this
database.
<p>
This means that updates of this database exhibit the ACI (atomicity,
consistency, and isolation) properties, but not D (durability); that
is, database integrity will be maintained, but if the application
or system fails, integrity will not persist. The database file must
be verified and/or restored from backup after a failure. In order
to ensure integrity after application shut down, the database
must be flushed to disk before the database handles are closed,
or all
database changes must be flushed from the database environment cache
using <a href="Environment.html#checkpoint-com.sleepycat.db.CheckpointConfig-"><code>Environment.checkpoint</code></a>.
<p>
All database handles for a single physical file must call this method,
including database handles for different databases in a physical file.
<p>
Calling this method only affects the specified <a href="Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle
(and any other library handles opened within the scope of that handle).
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transactionNotDurable</code> - If true, configure the database environment to not write log records
for this database.
A value of false is illegal to this method, that is, once set, the
configuration cannot be cleared.</dd>
</dl>
</li>
</ul>
<a name="getTransactionNotDurable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactionNotDurable</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getTransactionNotDurable()</pre>
<div class="block">Return true if the database environment is configured to not write log
records for this database.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database environment is configured to not write log
records for this database.</dd>
</dl>
</li>
</ul>
<a name="setTruncate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTruncate</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTruncate&#8203;(boolean&nbsp;truncate)</pre>
<div class="block">Configure the database to be physically truncated by truncating the
underlying file, discarding all previous databases it might have
held.
<p>
Underlying filesystem primitives are used to implement this
configuration. For this reason, it is applicable only to a physical
file and cannot be used to discard databases within a file.
<p>
This configuration option cannot be lock or transaction-protected, and
it is an error to specify it in a locking or transaction-protected
database environment.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>truncate</code> - If true, configure the database to be physically truncated by truncating
the underlying file, discarding all previous databases it might have
held.</dd>
</dl>
</li>
</ul>
<a name="getTruncate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTruncate</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getTruncate()</pre>
<div class="block">Return true if the database has been configured to be physically truncated
by truncating the underlying file, discarding all previous databases
it might have held.
<p>
This method may be called at any time during the life of the application.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database has been configured to be physically truncated
by truncating the underlying file, discarding all previous databases
it might have held.</dd>
</dl>
</li>
</ul>
<a name="setType-com.sleepycat.db.DatabaseType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setType</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setType&#8203;(<a href="DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a>&nbsp;type)</pre>
<div class="block">Configure the type of the database.
<p>
If they type is DB_UNKNOWN, the database must already exist.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>type</code> - The type of the database.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre class="methodSignature">public&nbsp;<a href="DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a>&nbsp;getType()</pre>
<div class="block">Return the type of the database.
<p>
This method may be used to determine the type of the database after
opening it.
<p>
This method may not be called before the
database has been opened.
<p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The type of the database.</dd>
</dl>
</li>
</ul>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPassword</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getPassword()</pre>
</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/DatabaseConfig.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>
Reference in New Issue View Git Blame Copy Permalink