mirror of
https://github.com/yasuhirokimura/db18
synced 2026-06-08 18:29:23 +00:00
Yasuhiro KIMURA
855 lines
46 KiB
HTML
855 lines
46 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
|
|
<title>SecondaryConfig (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="SecondaryConfig (Oracle - Berkeley DB Java API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
|
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../";
|
|
var useModuleDirectories = true;
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="fixedNav">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/SecondaryConfig.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<ul class="navListSearch">
|
|
<li><label for="search">SEARCH:</label>
|
|
<input type="text" id="search" value="search" disabled="disabled">
|
|
<input type="reset" id="reset" value="reset" disabled="disabled">
|
|
</li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
</div>
|
|
<div class="navPadding"> </div>
|
|
<script type="text/javascript"><!--
|
|
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
|
//-->
|
|
</script>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">com.sleepycat.db</a></div>
|
|
<h2 title="Class SecondaryConfig" class="title">Class SecondaryConfig</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="DatabaseConfig.html" title="class in com.sleepycat.db">com.sleepycat.db.DatabaseConfig</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.db.SecondaryConfig</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code>java.lang.Cloneable</code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">SecondaryConfig</span>
|
|
extends <a href="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a>
|
|
implements java.lang.Cloneable</pre>
|
|
<div class="block">The configuration properties of a <code>SecondaryDatabase</code> extend
|
|
those of a primary <code>Database</code>.
|
|
The secondary database configuration is specified when calling <a href="Environment.html#openSecondaryDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.Database-com.sleepycat.db.SecondaryConfig-"><code>Environment.openSecondaryDatabase</code></a>.
|
|
<p>
|
|
To create a configuration object with default attributes:
|
|
<pre>
|
|
SecondaryConfig config = new SecondaryConfig();
|
|
</pre>
|
|
To set custom attributes:
|
|
<pre>
|
|
SecondaryConfig config = new SecondaryConfig();
|
|
config.setAllowCreate(true);
|
|
config.setSortedDuplicates(true);
|
|
config.setKeyCreator(new MyKeyCreator());
|
|
</pre>
|
|
<hr>
|
|
<p>
|
|
NOTE: There are two situations where the use of secondary databases without
|
|
transactions requires special consideration. When using a transactional
|
|
database or when doing read operations only, this note does not apply.
|
|
<ul>
|
|
<li>If secondary is configured to not allow duplicates, when the secondary
|
|
is being updated it is possible that an error will occur when the secondary
|
|
key value in a record being added is already present in the database. A
|
|
<code>DatabaseException</code> will be thrown in this situation.</li>
|
|
<li>If a foreign key constraint is configured with the delete action
|
|
<code>ABORT</code> (the default setting), a <code>DatabaseException</code>
|
|
will be thrown if an attempt is made to delete a referenced foreign
|
|
key.</li>
|
|
</ul>
|
|
In both cases, the operation will be partially complete because the primary
|
|
database record will have already been updated or deleted. In the presence
|
|
of transactions, the exception will cause the transaction to abort. Without
|
|
transactions, it is the responsibility of the caller to handle the results
|
|
of the incomplete update or to take steps to prevent this situation from
|
|
happening in the first place.
|
|
<hr>
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="Environment.html#openSecondaryDatabase-com.sleepycat.db.Transaction-java.lang.String-java.lang.String-com.sleepycat.db.Database-com.sleepycat.db.SecondaryConfig-"><code>Environment.openSecondaryDatabase</code></a>,
|
|
<a href="SecondaryDatabase.html" title="class in com.sleepycat.db"><code>SecondaryDatabase</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="memberSummary" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Field</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static <a href="SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#SecondaryConfig--">SecondaryConfig</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates an instance 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colSecond" scope="col">Method</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowPopulate--">getAllowPopulate</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns whether automatic population of the secondary is allowed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>com.sleepycat.db.internal.Db</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getForeignKeyDatabase--">getForeignKeyDatabase</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the database used to check the foreign key integrity constraint,
|
|
or null if no foreign key constraint will be checked.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getForeignKeyDeleteAction--">getForeignKeyDeleteAction</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the action taken when a referenced record in the foreign key
|
|
database is deleted.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getForeignKeyNullifier--">getForeignKeyNullifier</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the user-supplied object used for setting single-valued foreign
|
|
keys to null.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getForeignMultiKeyNullifier--">getForeignMultiKeyNullifier</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the user-supplied object used for setting multi-valued foreign
|
|
keys to null.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getImmutableSecondaryKey--">getImmutableSecondaryKey</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns whether the secondary key is immutable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getKeyCreator--">getKeyCreator</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the user-supplied object used for creating single-valued secondary
|
|
keys.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMultiKeyCreator--">getMultiKeyCreator</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the user-supplied object used for creating multi-valued secondary
|
|
keys.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllowPopulate-boolean-">setAllowPopulate</a></span>​(boolean allowPopulate)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies whether automatic population of the secondary is allowed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setForeignKeyDatabase-com.sleepycat.db.Database-">setForeignKeyDatabase</a></span>​(<a href="Database.html" title="class in com.sleepycat.db">Database</a> foreignDb)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Defines a foreign key integrity constraint for a given foreign key
|
|
database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setForeignKeyDeleteAction-com.sleepycat.db.ForeignKeyDeleteAction-">setForeignKeyDeleteAction</a></span>​(<a href="ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a> action)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies the action taken when a referenced record in the foreign key
|
|
database is deleted.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setForeignKeyNullifier-com.sleepycat.db.ForeignKeyNullifier-">setForeignKeyNullifier</a></span>​(<a href="ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a> keyNullifier)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies the user-supplied object used for setting single-valued
|
|
foreign keys to null.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setForeignMultiKeyNullifier-com.sleepycat.db.ForeignMultiKeyNullifier-">setForeignMultiKeyNullifier</a></span>​(<a href="ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a> multiKeyNullifier)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies the user-supplied object used for setting multi-valued foreign
|
|
keys to null.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setImmutableSecondaryKey-boolean-">setImmutableSecondaryKey</a></span>​(boolean immutableSecondaryKey)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies whether the secondary key is immutable.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setKeyCreator-com.sleepycat.db.SecondaryKeyCreator-">setKeyCreator</a></span>​(<a href="SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a> keyCreator)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies the user-supplied object used for creating single-valued
|
|
secondary keys.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMultiKeyCreator-com.sleepycat.db.SecondaryMultiKeyCreator-">setMultiKeyCreator</a></span>​(<a href="SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a> multiKeyCreator)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Specifies the user-supplied object used for creating multi-valued
|
|
secondary keys.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.db.DatabaseConfig">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.sleepycat.db.<a href="DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a></h3>
|
|
<code><a href="DatabaseConfig.html#cloneConfig--">cloneConfig</a>, <a href="DatabaseConfig.html#enableEncrypted-boolean-">enableEncrypted</a>, <a href="DatabaseConfig.html#getAllowCreate--">getAllowCreate</a>, <a href="DatabaseConfig.html#getBlobDir--">getBlobDir</a>, <a href="DatabaseConfig.html#getBlobThreshold--">getBlobThreshold</a>, <a href="DatabaseConfig.html#getBtreeComparator--">getBtreeComparator</a>, <a href="DatabaseConfig.html#getBtreeCompressor--">getBtreeCompressor</a>, <a href="DatabaseConfig.html#getBtreeMinKey--">getBtreeMinKey</a>, <a href="DatabaseConfig.html#getBtreePrefixCalculator--">getBtreePrefixCalculator</a>, <a href="DatabaseConfig.html#getBtreeRecordNumbers--">getBtreeRecordNumbers</a>, <a href="DatabaseConfig.html#getByteOrder--">getByteOrder</a>, <a href="DatabaseConfig.html#getByteSwapped--">getByteSwapped</a>, <a href="DatabaseConfig.html#getCacheCount--">getCacheCount</a>, <a href="DatabaseConfig.html#getCacheSize--">getCacheSize</a>, <a href="DatabaseConfig.html#getChecksum--">getChecksum</a>, <a href="DatabaseConfig.html#getCreateDir--">getCreateDir</a>, <a href="DatabaseConfig.html#getDirtyRead--">getDirtyRead</a>, <a href="DatabaseConfig.html#getDuplicateComparator--">getDuplicateComparator</a>, <a href="DatabaseConfig.html#getEncrypted--">getEncrypted</a>, <a href="DatabaseConfig.html#getErrorHandler--">getErrorHandler</a>, <a href="DatabaseConfig.html#getErrorPrefix--">getErrorPrefix</a>, <a href="DatabaseConfig.html#getErrorStream--">getErrorStream</a>, <a href="DatabaseConfig.html#getExclusiveCreate--">getExclusiveCreate</a>, <a href="DatabaseConfig.html#getExternalFileDir--">getExternalFileDir</a>, <a href="DatabaseConfig.html#getExternalFileThreshold--">getExternalFileThreshold</a>, <a href="DatabaseConfig.html#getFeedbackHandler--">getFeedbackHandler</a>, <a href="DatabaseConfig.html#getHashComparator--">getHashComparator</a>, <a href="DatabaseConfig.html#getHasher--">getHasher</a>, <a href="DatabaseConfig.html#getHashFillFactor--">getHashFillFactor</a>, <a href="DatabaseConfig.html#getHashNumElements--">getHashNumElements</a>, <a href="DatabaseConfig.html#getHeapRegionSize--">getHeapRegionSize</a>, <a href="DatabaseConfig.html#getHeapsize--">getHeapsize</a>, <a href="DatabaseConfig.html#getMessageHandler--">getMessageHandler</a>, <a href="DatabaseConfig.html#getMessagePrefix--">getMessagePrefix</a>, <a href="DatabaseConfig.html#getMessageStream--">getMessageStream</a>, <a href="DatabaseConfig.html#getMode--">getMode</a>, <a href="DatabaseConfig.html#getMultiversion--">getMultiversion</a>, <a href="DatabaseConfig.html#getNoMMap--">getNoMMap</a>, <a href="DatabaseConfig.html#getNoWaitDbExclusiveLock--">getNoWaitDbExclusiveLock</a>, <a href="DatabaseConfig.html#getPageSize--">getPageSize</a>, <a href="DatabaseConfig.html#getPanicHandler--">getPanicHandler</a>, <a href="DatabaseConfig.html#getPartitionDirs--">getPartitionDirs</a>, <a href="DatabaseConfig.html#getPartitionHandler--">getPartitionHandler</a>, <a href="DatabaseConfig.html#getPartitionKeys--">getPartitionKeys</a>, <a href="DatabaseConfig.html#getPartitionParts--">getPartitionParts</a>, <a href="DatabaseConfig.html#getPassword--">getPassword</a>, <a href="DatabaseConfig.html#getPriority--">getPriority</a>, <a href="DatabaseConfig.html#getQueueExtentSize--">getQueueExtentSize</a>, <a href="DatabaseConfig.html#getQueueInOrder--">getQueueInOrder</a>, <a href="DatabaseConfig.html#getReadOnly--">getReadOnly</a>, <a href="DatabaseConfig.html#getReadUncommitted--">getReadUncommitted</a>, <a href="DatabaseConfig.html#getRecordDelimiter--">getRecordDelimiter</a>, <a href="DatabaseConfig.html#getRecordLength--">getRecordLength</a>, <a href="DatabaseConfig.html#getRecordNumberAppender--">getRecordNumberAppender</a>, <a href="DatabaseConfig.html#getRecordPad--">getRecordPad</a>, <a href="DatabaseConfig.html#getRecordSource--">getRecordSource</a>, <a href="DatabaseConfig.html#getRenumbering--">getRenumbering</a>, <a href="DatabaseConfig.html#getReverseSplitOff--">getReverseSplitOff</a>, <a href="DatabaseConfig.html#getSliceCallback--">getSliceCallback</a>, <a href="DatabaseConfig.html#getSliced--">getSliced</a>, <a href="DatabaseConfig.html#getSnapshot--">getSnapshot</a>, <a href="DatabaseConfig.html#getSortedDuplicates--">getSortedDuplicates</a>, <a href="DatabaseConfig.html#getTransactional--">getTransactional</a>, <a href="DatabaseConfig.html#getTransactionNotDurable--">getTransactionNotDurable</a>, <a href="DatabaseConfig.html#getTruncate--">getTruncate</a>, <a href="DatabaseConfig.html#getType--">getType</a>, <a href="DatabaseConfig.html#getUnsortedDuplicates--">getUnsortedDuplicates</a>, <a href="DatabaseConfig.html#setAllowCreate-boolean-">setAllowCreate</a>, <a href="DatabaseConfig.html#setBlobDir-java.io.File-">setBlobDir</a>, <a href="DatabaseConfig.html#setBlobThreshold-int-">setBlobThreshold</a>, <a href="DatabaseConfig.html#setBtreeComparator-java.util.Comparator-">setBtreeComparator</a>, <a href="DatabaseConfig.html#setBtreeCompressor-com.sleepycat.db.BtreeCompressor-">setBtreeCompressor</a>, <a href="DatabaseConfig.html#setBtreeMinKey-int-">setBtreeMinKey</a>, <a href="DatabaseConfig.html#setBtreePrefixCalculator-com.sleepycat.db.BtreePrefixCalculator-">setBtreePrefixCalculator</a>, <a href="DatabaseConfig.html#setBtreeRecordNumbers-boolean-">setBtreeRecordNumbers</a>, <a href="DatabaseConfig.html#setByteOrder-int-">setByteOrder</a>, <a href="DatabaseConfig.html#setCacheCount-int-">setCacheCount</a>, <a href="DatabaseConfig.html#setCacheSize-long-">setCacheSize</a>, <a href="DatabaseConfig.html#setChecksum-boolean-">setChecksum</a>, <a href="DatabaseConfig.html#setCreateDir-java.io.File-">setCreateDir</a>, <a href="DatabaseConfig.html#setDirtyRead-boolean-">setDirtyRead</a>, <a href="DatabaseConfig.html#setDuplicateComparator-java.util.Comparator-">setDuplicateComparator</a>, <a href="DatabaseConfig.html#setEncrypted-java.lang.String-">setEncrypted</a>, <a href="DatabaseConfig.html#setErrorHandler-com.sleepycat.db.ErrorHandler-">setErrorHandler</a>, <a href="DatabaseConfig.html#setErrorPrefix-java.lang.String-">setErrorPrefix</a>, <a href="DatabaseConfig.html#setErrorStream-java.io.OutputStream-">setErrorStream</a>, <a href="DatabaseConfig.html#setExclusiveCreate-boolean-">setExclusiveCreate</a>, <a href="DatabaseConfig.html#setExternalFileDir-java.io.File-">setExternalFileDir</a>, <a href="DatabaseConfig.html#setExternalFileThreshold-int-">setExternalFileThreshold</a>, <a href="DatabaseConfig.html#setFeedbackHandler-com.sleepycat.db.FeedbackHandler-">setFeedbackHandler</a>, <a href="DatabaseConfig.html#setHashComparator-java.util.Comparator-">setHashComparator</a>, <a href="DatabaseConfig.html#setHasher-com.sleepycat.db.Hasher-">setHasher</a>, <a href="DatabaseConfig.html#setHashFillFactor-int-">setHashFillFactor</a>, <a href="DatabaseConfig.html#setHashNumElements-int-">setHashNumElements</a>, <a href="DatabaseConfig.html#setHeapRegionSize-int-">setHeapRegionSize</a>, <a href="DatabaseConfig.html#setHeapsize-long-">setHeapsize</a>, <a href="DatabaseConfig.html#setMessageHandler-com.sleepycat.db.MessageHandler-">setMessageHandler</a>, <a href="DatabaseConfig.html#setMessagePrefix-java.lang.String-">setMessagePrefix</a>, <a href="DatabaseConfig.html#setMessageStream-java.io.OutputStream-">setMessageStream</a>, <a href="DatabaseConfig.html#setMode-int-">setMode</a>, <a href="DatabaseConfig.html#setMsgfile-java.io.File-">setMsgfile</a>, <a href="DatabaseConfig.html#setMultiversion-boolean-">setMultiversion</a>, <a href="DatabaseConfig.html#setNoMMap-boolean-">setNoMMap</a>, <a href="DatabaseConfig.html#setNoWaitDbExclusiveLock-java.lang.Boolean-">setNoWaitDbExclusiveLock</a>, <a href="DatabaseConfig.html#setPageSize-int-">setPageSize</a>, <a href="DatabaseConfig.html#setPanicHandler-com.sleepycat.db.PanicHandler-">setPanicHandler</a>, <a href="DatabaseConfig.html#setPartitionByCallback-int-com.sleepycat.db.PartitionHandler-">setPartitionByCallback</a>, <a href="DatabaseConfig.html#setPartitionByRange-int-com.sleepycat.db.MultipleDataEntry-">setPartitionByRange</a>, <a href="DatabaseConfig.html#setPartitionDirs-java.io.File:A-">setPartitionDirs</a>, <a href="DatabaseConfig.html#setPriority-com.sleepycat.db.CacheFilePriority-">setPriority</a>, <a href="DatabaseConfig.html#setQueueExtentSize-int-">setQueueExtentSize</a>, <a href="DatabaseConfig.html#setQueueInOrder-boolean-">setQueueInOrder</a>, <a href="DatabaseConfig.html#setReadOnly-boolean-">setReadOnly</a>, <a href="DatabaseConfig.html#setReadUncommitted-boolean-">setReadUncommitted</a>, <a href="DatabaseConfig.html#setRecordDelimiter-int-">setRecordDelimiter</a>, <a href="DatabaseConfig.html#setRecordLength-int-">setRecordLength</a>, <a href="DatabaseConfig.html#setRecordNumberAppender-com.sleepycat.db.RecordNumberAppender-">setRecordNumberAppender</a>, <a href="DatabaseConfig.html#setRecordPad-int-">setRecordPad</a>, <a href="DatabaseConfig.html#setRecordSource-java.io.File-">setRecordSource</a>, <a href="DatabaseConfig.html#setRenumbering-boolean-">setRenumbering</a>, <a href="DatabaseConfig.html#setReverseSplitOff-boolean-">setReverseSplitOff</a>, <a href="DatabaseConfig.html#setSliceCallback-com.sleepycat.db.Slice-">setSliceCallback</a>, <a href="DatabaseConfig.html#setSliced-boolean-">setSliced</a>, <a href="DatabaseConfig.html#setSnapshot-boolean-">setSnapshot</a>, <a href="DatabaseConfig.html#setSortedDuplicates-boolean-">setSortedDuplicates</a>, <a href="DatabaseConfig.html#setTransactional-boolean-">setTransactional</a>, <a href="DatabaseConfig.html#setTransactionNotDurable-boolean-">setTransactionNotDurable</a>, <a href="DatabaseConfig.html#setTruncate-boolean-">setTruncate</a>, <a href="DatabaseConfig.html#setType-com.sleepycat.db.DatabaseType-">setType</a>, <a href="DatabaseConfig.html#setUnsortedDuplicates-boolean-">setUnsortedDuplicates</a></code></li>
|
|
</ul>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class 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 <a href="SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> DEFAULT</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="SecondaryConfig--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>SecondaryConfig</h4>
|
|
<pre>public SecondaryConfig()</pre>
|
|
<div class="block">Creates an instance 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="setAllowPopulate-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setAllowPopulate</h4>
|
|
<pre class="methodSignature">public void setAllowPopulate​(boolean allowPopulate)</pre>
|
|
<div class="block">Specifies whether automatic population of the secondary is allowed.
|
|
<p>
|
|
If automatic population is allowed, when the secondary database is
|
|
opened it is checked to see if it is empty. If it is empty, the
|
|
primary database is read in its entirety and keys are added to the
|
|
secondary database using the information read from the primary.
|
|
<p>
|
|
If this property is set to true and the database is transactional, the
|
|
population of the secondary will be done within the explicit or auto-commit
|
|
transaction that is used to open the database.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>allowPopulate</code> - whether automatic population of the secondary is
|
|
allowed.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getAllowPopulate--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getAllowPopulate</h4>
|
|
<pre class="methodSignature">public boolean getAllowPopulate()</pre>
|
|
<div class="block">Returns whether automatic population of the secondary is allowed. If
|
|
<a href="#setAllowPopulate-boolean-"><code>setAllowPopulate(boolean)</code></a> has not been called, this method returns
|
|
false.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>whether automatic population of the secondary is allowed.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setAllowPopulate-boolean-"><code>setAllowPopulate(boolean)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setImmutableSecondaryKey-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setImmutableSecondaryKey</h4>
|
|
<pre class="methodSignature">public void setImmutableSecondaryKey​(boolean immutableSecondaryKey)</pre>
|
|
<div class="block">Specifies whether the secondary key is immutable.
|
|
<p>
|
|
Specifying that a secondary key is immutable can be used to optimize
|
|
updates when the secondary key in a primary record will never be changed
|
|
after that primary record is inserted. For immutable secondary keys, a
|
|
best effort is made to avoid calling
|
|
<code>SecondaryKeyCreator.createSecondaryKey</code> when a primary record
|
|
is updated. This optimization may reduce the overhead of an update
|
|
operation significantly if the <code>createSecondaryKey</code> operation is
|
|
expensive.
|
|
<p>
|
|
Be sure to set this property to true only if the secondary key in the
|
|
primary record is never changed. If this rule is violated, the secondary
|
|
index will become corrupted, that is, it will become out of sync with the
|
|
primary.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>immutableSecondaryKey</code> - whether the secondary key is immutable.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getImmutableSecondaryKey--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getImmutableSecondaryKey</h4>
|
|
<pre class="methodSignature">public boolean getImmutableSecondaryKey()</pre>
|
|
<div class="block">Returns whether the secondary key is immutable. If
|
|
<a href="#setImmutableSecondaryKey-boolean-"><code>setImmutableSecondaryKey(boolean)</code></a> has not been called, this method returns
|
|
false.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>whether the secondary key is immutable.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setImmutableSecondaryKey-boolean-"><code>setImmutableSecondaryKey(boolean)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setKeyCreator-com.sleepycat.db.SecondaryKeyCreator-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setKeyCreator</h4>
|
|
<pre class="methodSignature">public void setKeyCreator​(<a href="SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a> keyCreator)</pre>
|
|
<div class="block">Specifies the user-supplied object used for creating single-valued
|
|
secondary keys.
|
|
<p>
|
|
Unless the primary database is read-only, a key creator is required
|
|
when opening a secondary database. Either a KeyCreator or MultiKeyCreator
|
|
must be specified, but both may not be specified.
|
|
<p>
|
|
Unless the primary database is read-only, a key creator is required
|
|
when opening a secondary database.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>keyCreator</code> - the user-supplied object used for creating single-valued
|
|
secondary keys.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getKeyCreator--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getKeyCreator</h4>
|
|
<pre class="methodSignature">public <a href="SecondaryKeyCreator.html" title="interface in com.sleepycat.db">SecondaryKeyCreator</a> getKeyCreator()</pre>
|
|
<div class="block">Returns the user-supplied object used for creating single-valued secondary
|
|
keys.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the user-supplied object used for creating single-valued secondary
|
|
keys.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setKeyCreator-com.sleepycat.db.SecondaryKeyCreator-"><code>setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setMultiKeyCreator-com.sleepycat.db.SecondaryMultiKeyCreator-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setMultiKeyCreator</h4>
|
|
<pre class="methodSignature">public void setMultiKeyCreator​(<a href="SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a> multiKeyCreator)</pre>
|
|
<div class="block">Specifies the user-supplied object used for creating multi-valued
|
|
secondary keys.
|
|
<p>
|
|
Unless the primary database is read-only, a key creator is required
|
|
when opening a secondary database. Either a KeyCreator or MultiKeyCreator
|
|
must be specified, but both may not be specified.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>multiKeyCreator</code> - the user-supplied object used for creating multi-valued
|
|
secondary keys.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getMultiKeyCreator--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getMultiKeyCreator</h4>
|
|
<pre class="methodSignature">public <a href="SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db">SecondaryMultiKeyCreator</a> getMultiKeyCreator()</pre>
|
|
<div class="block">Returns the user-supplied object used for creating multi-valued secondary
|
|
keys.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the user-supplied object used for creating multi-valued secondary
|
|
keys.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setKeyCreator-com.sleepycat.db.SecondaryKeyCreator-"><code>setKeyCreator(com.sleepycat.db.SecondaryKeyCreator)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setForeignKeyDatabase-com.sleepycat.db.Database-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setForeignKeyDatabase</h4>
|
|
<pre class="methodSignature">public void setForeignKeyDatabase​(<a href="Database.html" title="class in com.sleepycat.db">Database</a> foreignDb)</pre>
|
|
<div class="block">Defines a foreign key integrity constraint for a given foreign key
|
|
database.
|
|
|
|
<p>If this property is non-null, a record must be present in the
|
|
specified foreign database for every record in the secondary database,
|
|
where the secondary key value is equal to the foreign database key
|
|
value. Whenever a record is to be added to the secondary database, the
|
|
secondary key is used as a lookup key in the foreign database.
|
|
|
|
<p>The foreign database must not have duplicates allowed.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>foreignDb</code> - the database used to check the foreign key
|
|
integrity constraint, or null if no foreign key constraint should be
|
|
checked.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getForeignKeyDatabase--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getForeignKeyDatabase</h4>
|
|
<pre class="methodSignature">public com.sleepycat.db.internal.Db getForeignKeyDatabase()</pre>
|
|
<div class="block">Returns the database used to check the foreign key integrity constraint,
|
|
or null if no foreign key constraint will be checked.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the foreign key database, or null.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setForeignKeyDatabase-com.sleepycat.db.Database-"><code>setForeignKeyDatabase(com.sleepycat.db.Database)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setForeignKeyDeleteAction-com.sleepycat.db.ForeignKeyDeleteAction-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setForeignKeyDeleteAction</h4>
|
|
<pre class="methodSignature">public void setForeignKeyDeleteAction​(<a href="ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a> action)</pre>
|
|
<div class="block">Specifies the action taken when a referenced record in the foreign key
|
|
database is deleted.
|
|
|
|
<p>This property is ignored if the foreign key database property is
|
|
null.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>action</code> - the action taken when a referenced record
|
|
in the foreign key database is deleted.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="ForeignKeyDeleteAction.html" title="class in com.sleepycat.db"><code>@see #setForeignKeyDatabase</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getForeignKeyDeleteAction--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getForeignKeyDeleteAction</h4>
|
|
<pre class="methodSignature">public <a href="ForeignKeyDeleteAction.html" title="class in com.sleepycat.db">ForeignKeyDeleteAction</a> getForeignKeyDeleteAction()</pre>
|
|
<div class="block">Returns the action taken when a referenced record in the foreign key
|
|
database is deleted.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the action taken when a referenced record in the foreign key
|
|
database is deleted.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setForeignKeyDeleteAction-com.sleepycat.db.ForeignKeyDeleteAction-"><code>setForeignKeyDeleteAction(com.sleepycat.db.ForeignKeyDeleteAction)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setForeignKeyNullifier-com.sleepycat.db.ForeignKeyNullifier-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setForeignKeyNullifier</h4>
|
|
<pre class="methodSignature">public void setForeignKeyNullifier​(<a href="ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a> keyNullifier)</pre>
|
|
<div class="block">Specifies the user-supplied object used for setting single-valued
|
|
foreign keys to null.
|
|
|
|
<p>This method may <em>not</em> be used along with <a href="#setMultiKeyCreator-com.sleepycat.db.SecondaryMultiKeyCreator-"><code>setMultiKeyCreator(com.sleepycat.db.SecondaryMultiKeyCreator)</code></a>. When using a multi-key creator, use <a href="#setForeignMultiKeyNullifier-com.sleepycat.db.ForeignMultiKeyNullifier-"><code>setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)</code></a> instead.</p>
|
|
|
|
<p>If the foreign key database property is non-null and the foreign key
|
|
delete action is <code>NULLIFY</code>, this property is required to be
|
|
non-null; otherwise, this property is ignored.</p>
|
|
|
|
<p><em>WARNING:</em> Key nullifier instances are shared by multiple
|
|
threads and key nullifier methods are called without any special
|
|
synchronization. Therefore, key creators must be thread safe. In
|
|
general no shared state should be used and any caching of computed
|
|
values must be done with proper synchronization.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>keyNullifier</code> - the user-supplied object used for setting
|
|
single-valued foreign keys to null.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="ForeignKeyNullifier.html" title="interface in com.sleepycat.db"><code>@see ForeignKeyDeleteAction#NULLIFY @see
|
|
#setForeignKeyDatabase</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getForeignKeyNullifier--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getForeignKeyNullifier</h4>
|
|
<pre class="methodSignature">public <a href="ForeignKeyNullifier.html" title="interface in com.sleepycat.db">ForeignKeyNullifier</a> getForeignKeyNullifier()</pre>
|
|
<div class="block">Returns the user-supplied object used for setting single-valued foreign
|
|
keys to null.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the user-supplied object used for setting single-valued foreign
|
|
keys to null.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setForeignKeyNullifier-com.sleepycat.db.ForeignKeyNullifier-"><code>setForeignKeyNullifier(com.sleepycat.db.ForeignKeyNullifier)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setForeignMultiKeyNullifier-com.sleepycat.db.ForeignMultiKeyNullifier-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setForeignMultiKeyNullifier</h4>
|
|
<pre class="methodSignature">public void setForeignMultiKeyNullifier​(<a href="ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a> multiKeyNullifier)</pre>
|
|
<div class="block">Specifies the user-supplied object used for setting multi-valued foreign
|
|
keys to null.
|
|
|
|
<p>If the foreign key database property is non-null and the foreign key
|
|
delete action is <code>NULLIFY</code>, this property is required to be
|
|
non-null; otherwise, this property is ignored.</p>
|
|
|
|
<p><em>WARNING:</em> Key nullifier instances are shared by multiple
|
|
threads and key nullifier methods are called without any special
|
|
synchronization. Therefore, key creators must be thread safe. In
|
|
general no shared state should be used and any caching of computed
|
|
values must be done with proper synchronization.</p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>multiKeyNullifier</code> - the user-supplied object used for
|
|
setting multi-valued foreign keys to null.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db"><code>@see ForeignKeyDeleteAction#NULLIFY @see
|
|
#setForeignKeyDatabase</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getForeignMultiKeyNullifier--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getForeignMultiKeyNullifier</h4>
|
|
<pre class="methodSignature">public <a href="ForeignMultiKeyNullifier.html" title="interface in com.sleepycat.db">ForeignMultiKeyNullifier</a> getForeignMultiKeyNullifier()</pre>
|
|
<div class="block">Returns the user-supplied object used for setting multi-valued foreign
|
|
keys to null.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the user-supplied object used for setting multi-valued foreign
|
|
keys to null.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#setForeignMultiKeyNullifier-com.sleepycat.db.ForeignMultiKeyNullifier-"><code>setForeignMultiKeyNullifier(com.sleepycat.db.ForeignMultiKeyNullifier)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/SecondaryConfig.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../allclasses.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
|
|
</body>
|
|
</html>
|