je/docs/java/com/sleepycat/persist/StoreConfig.html

890 lines
38 KiB
HTML
Raw Normal View History

2021-06-06 17:46:45 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_151) on Tue Oct 31 17:36:46 EDT 2017 -->
<title>StoreConfig (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StoreConfig (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":42,"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,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoreConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/persist/StoreConfigBeanInfo.html" title="class in com.sleepycat.persist"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/persist/StoreConfig.html" target="_top">Frames</a></li>
<li><a href="StoreConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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 ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.persist</div>
<h2 title="Class StoreConfig" class="title">Class StoreConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.persist.StoreConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">StoreConfig</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Configuration properties used with an <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a> or <a href="../../../com/sleepycat/persist/raw/RawStore.html" title="class in com.sleepycat.persist.raw"><code>RawStore</code></a>.
<p><code>StoreConfig</code> objects are thread-safe. Multiple threads may safely
call the methods of a shared <code>StoreConfig</code> object.</p>
<p>See the <a href="package-summary.html#example">package
summary example</a> for an example of using a <code>StoreConfig</code>.</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Mark Hayes</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" border="0" cellpadding="3" cellspacing="0" 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="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#DEFAULT">DEFAULT</a></span></code>
<div class="block">The default store configuration containing properties as if the
configuration were constructed and not modified.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#StoreConfig--">StoreConfig</a></span>()</code>
<div class="block">Creates an entity store configuration object with default properties.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#clone--">clone</a></span>()</code>
<div class="block">Returns a shallow copy of the configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#cloneConfig--">cloneConfig</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">As of JE 4.0.13, replaced by <a href="../../../com/sleepycat/persist/StoreConfig.html#clone--"><code>clone()</code></a>.</span></div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getAllowCreate--">getAllowCreate</a></span>()</code>
<div class="block">Returns whether creation of a new store is allowed.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getDeferredWrite--">getDeferredWrite</a></span>()</code>
<div class="block">Returns the deferred-write configuration property.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getExclusiveCreate--">getExclusiveCreate</a></span>()</code>
<div class="block">Returns whether opening an existing store is prohibited.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getModel--">getModel</a></span>()</code>
<div class="block">Returns the entity model that defines entity classes and index keys.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getMutations--">getMutations</a></span>()</code>
<div class="block">Returns the configured mutations for performing lazy evolution of stored
instances.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getReadOnly--">getReadOnly</a></span>()</code>
<div class="block">Returns the read-only configuration property.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getReplicated--">getReplicated</a></span>()</code>
<div class="block">Returns the replicated property for the store.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getSecondaryBulkLoad--">getSecondaryBulkLoad</a></span>()</code>
<div class="block">Returns the bulk-load-secondaries configuration property.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getTemporary--">getTemporary</a></span>()</code>
<div class="block">Returns the temporary configuration property.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#getTransactional--">getTransactional</a></span>()</code>
<div class="block">Returns the transactional configuration property.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setAllowCreate-boolean-">setAllowCreate</a></span>(boolean&nbsp;allowCreate)</code>
<div class="block">Specifies whether creation of a new store is allowed.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setDeferredWrite-boolean-">setDeferredWrite</a></span>(boolean&nbsp;deferredWrite)</code>
<div class="block">Sets the deferred-write configuration property.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setExclusiveCreate-boolean-">setExclusiveCreate</a></span>(boolean&nbsp;exclusiveCreate)</code>
<div class="block">Specifies whether opening an existing store is prohibited.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setModel-com.sleepycat.persist.model.EntityModel-">setModel</a></span>(<a href="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;model)</code>
<div class="block">Sets the entity model that defines entity classes and index keys.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setMutations-com.sleepycat.persist.evolve.Mutations-">setMutations</a></span>(<a href="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;mutations)</code>
<div class="block">Configures mutations for performing lazy evolution of stored instances.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setReadOnly-boolean-">setReadOnly</a></span>(boolean&nbsp;readOnly)</code>
<div class="block">Sets the read-only configuration property.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setReplicated-boolean-">setReplicated</a></span>(boolean&nbsp;replicated)</code>
<div class="block">Configures a store to be replicated or non-replicated, in a replicated
Environment.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setSecondaryBulkLoad-boolean-">setSecondaryBulkLoad</a></span>(boolean&nbsp;secondaryBulkLoad)</code>
<div class="block">Sets the bulk-load-secondaries configuration property.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setTemporary-boolean-">setTemporary</a></span>(boolean&nbsp;temporary)</code>
<div class="block">Sets the temporary configuration property.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/persist/StoreConfig.html#setTransactional-boolean-">setTransactional</a></span>(boolean&nbsp;transactional)</code>
<div class="block">Sets the transactional configuration property.</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>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="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a> DEFAULT</pre>
<div class="block">The default store configuration containing properties as if the
configuration were constructed and not modified.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StoreConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StoreConfig</h4>
<pre>public&nbsp;StoreConfig()</pre>
<div class="block">Creates an entity store configuration object with default properties.</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>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;cloneConfig()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of JE 4.0.13, replaced by <a href="../../../com/sleepycat/persist/StoreConfig.html#clone--"><code>clone()</code></a>.</span></div>
<div class="block">Returns a shallow copy of the configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the clone.</dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;clone()</pre>
<div class="block">Returns a shallow copy of the configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="setAllowCreate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowCreate</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setAllowCreate(boolean&nbsp;allowCreate)</pre>
<div class="block">Specifies whether creation of a new store is allowed. By default this
property is false.
<p>If this property is false and the internal store metadata database
does not exist, <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je"><code>DatabaseException</code></a> will be thrown when the store
is opened.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowCreate</code> - whether creation of a new store is allowed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getAllowCreate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowCreate</h4>
<pre>public&nbsp;boolean&nbsp;getAllowCreate()</pre>
<div class="block">Returns whether creation of a new store is allowed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether creation of a new store is allowed.</dd>
</dl>
</li>
</ul>
<a name="setExclusiveCreate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExclusiveCreate</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setExclusiveCreate(boolean&nbsp;exclusiveCreate)</pre>
<div class="block">Specifies whether opening an existing store is prohibited. By default
this property is false.
<p>If this property is true and the internal store metadata database
already exists, <a href="../../../com/sleepycat/je/DatabaseException.html" title="class in com.sleepycat.je"><code>DatabaseException</code></a> will be thrown when the store
is opened.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exclusiveCreate</code> - whether opening an existing store is prohibited.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getExclusiveCreate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExclusiveCreate</h4>
<pre>public&nbsp;boolean&nbsp;getExclusiveCreate()</pre>
<div class="block">Returns whether opening an existing store is prohibited.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether opening an existing store is prohibited.</dd>
</dl>
</li>
</ul>
<a name="setTransactional-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactional</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setTransactional(boolean&nbsp;transactional)</pre>
<div class="block">Sets the transactional configuration property. By default this property
is false.
<p>This property is true to open all store indices for transactional
access. True may not be specified if the environment is not also
transactional.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transactional</code> - whether the store is transactional.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getTransactional--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactional</h4>
<pre>public&nbsp;boolean&nbsp;getTransactional()</pre>
<div class="block">Returns the transactional configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is transactional.</dd>
</dl>
</li>
</ul>
<a name="setReadOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadOnly</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setReadOnly(boolean&nbsp;readOnly)</pre>
<div class="block">Sets the read-only configuration property. By default this property is
false.
<p>This property is true to open all store indices for read-only access,
or false to open them for read-write access. False may not be specified
if the environment is read-only.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readOnly</code> - whether the store is read-only.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getReadOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadOnly</h4>
<pre>public&nbsp;boolean&nbsp;getReadOnly()</pre>
<div class="block">Returns the read-only configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is read-only.</dd>
</dl>
</li>
</ul>
<a name="setReplicated-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReplicated</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setReplicated(boolean&nbsp;replicated)</pre>
<div class="block">Configures a store to be replicated or non-replicated, in a replicated
Environment. By default this property is true, meaning that by default
a store is replicated in a replicated Environment.
<p>
In a non-replicated Environment, this property is ignored. All stores
are non-replicated in a non-replicated Environment.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>replicated</code> - whether the store is replicated.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../je/rep/ReplicatedEnvironment.html#nonRepDbs">Non-replicated
Databases in a Replicated Environment</a></dd>
</dl>
</li>
</ul>
<a name="getReplicated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplicated</h4>
<pre>public&nbsp;boolean&nbsp;getReplicated()</pre>
<div class="block">Returns the replicated property for the store.
<p>
This method returns true by default. However, in a non-replicated
Environment, this property is ignored. All stores are non-replicated
in a non-replicated Environment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is replicated.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/persist/StoreConfig.html#setReplicated-boolean-"><code>setReplicated(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="setDeferredWrite-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDeferredWrite</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setDeferredWrite(boolean&nbsp;deferredWrite)</pre>
<div class="block">Sets the deferred-write configuration property. By default this
property is false.
<p>This property is true to open all store index databases for
deferred-write access. True may not be specified if the store is
transactional.</p>
<p>Deferred write stores avoid disk I/O and are not guaranteed to be
persistent until <a href="../../../com/sleepycat/persist/EntityStore.html#sync--"><code>EntityStore.sync()</code></a> or <a href="../../../com/sleepycat/je/Environment.html#sync--"><code>Environment.sync()</code></a> is
called or the store is closed normally. This mode is particularly geared
toward stores that frequently modify and delete data records. See the
Getting Started Guide, Database chapter for a full description of the
mode.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>deferredWrite</code> - whether the store is deferred-write.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/persist/StoreConfig.html#setTransactional-boolean-"><code>setTransactional(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getDeferredWrite--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDeferredWrite</h4>
<pre>public&nbsp;boolean&nbsp;getDeferredWrite()</pre>
<div class="block">Returns the deferred-write configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is deferred-write.</dd>
</dl>
</li>
</ul>
<a name="setTemporary-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTemporary</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setTemporary(boolean&nbsp;temporary)</pre>
<div class="block">Sets the temporary configuration property. By default this property is
false.
<p>This property is true to open all store databases as temporary
databases. True may not be specified if the store is transactional.</p>
<p>Temporary stores avoid disk I/O and are not persistent -- they are
deleted when the store is closed or after a crash. This mode is
particularly geared toward in-memory stores. See the Getting Started
Guide, Database chapter for a full description of the mode.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>temporary</code> - whether the store is temporary.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/sleepycat/persist/StoreConfig.html#setTransactional-boolean-"><code>setTransactional(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getTemporary--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTemporary</h4>
<pre>public&nbsp;boolean&nbsp;getTemporary()</pre>
<div class="block">Returns the temporary configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is temporary.</dd>
</dl>
</li>
</ul>
<a name="setSecondaryBulkLoad-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecondaryBulkLoad</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setSecondaryBulkLoad(boolean&nbsp;secondaryBulkLoad)</pre>
<div class="block">Sets the bulk-load-secondaries configuration property. By default this
property is false.
<p>This property is true to cause the initial creation of secondary
indices to be performed as a bulk load. If this property is true and
<a href="../../../com/sleepycat/persist/EntityStore.html#getSecondaryIndex-com.sleepycat.persist.PrimaryIndex-java.lang.Class-java.lang.String-"><code>EntityStore.getSecondaryIndex</code></a> has
never been called for a secondary index, that secondary index will not
be created or written as records are written to the primary index. In
addition, if that secondary index defines a foreign key constraint, the
constraint will not be enforced.</p>
<p>The secondary index will be populated later when the <code>getSecondaryIndex</code> method is called for the first time for that index,
or when the store is closed and re-opened with this property set to
false and the primary index is obtained. In either case, the secondary
index is populated by reading through the entire primary index and
adding records to the secondary index as needed. While populating the
secondary, foreign key constraints will be enforced and an exception is
thrown if a constraint is violated.</p>
<p>When loading a primary index along with secondary indexes from a
large input data set, configuring a bulk load of the secondary indexes
is sometimes more performant than updating the secondary indexes each
time the primary index is updated. The absence of foreign key
constraints during the load also provides more flexibility.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>secondaryBulkLoad</code> - whether bulk-load-secondaries is used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getSecondaryBulkLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecondaryBulkLoad</h4>
<pre>public&nbsp;boolean&nbsp;getSecondaryBulkLoad()</pre>
<div class="block">Returns the bulk-load-secondaries configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether bulk-load-secondaries is used.</dd>
</dl>
</li>
</ul>
<a name="setModel-com.sleepycat.persist.model.EntityModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setModel</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setModel(<a href="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;model)</pre>
<div class="block">Sets the entity model that defines entity classes and index keys.
<p>If null is specified or this method is not called, an <a href="../../../com/sleepycat/persist/model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><code>AnnotationModel</code></a> instance is used by default.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>model</code> - the EntityModel.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getModel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModel</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;getModel()</pre>
<div class="block">Returns the entity model that defines entity classes and index keys.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the EntityModel.</dd>
</dl>
</li>
</ul>
<a name="setMutations-com.sleepycat.persist.evolve.Mutations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMutations</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setMutations(<a href="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;mutations)</pre>
<div class="block">Configures mutations for performing lazy evolution of stored instances.
Existing mutations for this store are not cleared, so the mutations
required are only those changes that have been made since the store was
last opened. Some new mutations may override existing specifications,
and some may be supplemental.
<p>If null is specified and the store already exists, the previously
specified mutations are used. The mutations are stored persistently in
serialized form.</p>
<p>Mutations must be available to handle all changes to classes that are
incompatible with the class definitions known to this store. See <a href="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><code>Mutations</code></a> and <a href="../../../com/sleepycat/persist/evolve/package-summary.html"><code>Class Evolution</code></a> for
more information.</p>
<p>If an incompatible class change has been made and mutations are not
available for handling the change, <a href="../../../com/sleepycat/persist/evolve/IncompatibleClassException.html" title="class in com.sleepycat.persist.evolve"><code>IncompatibleClassException</code></a>
will be thrown when creating an <a href="../../../com/sleepycat/persist/EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mutations</code> - the Mutations.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="getMutations--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMutations</h4>
<pre>public&nbsp;<a href="../../../com/sleepycat/persist/evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;getMutations()</pre>
<div class="block">Returns the configured mutations for performing lazy evolution of stored
instances.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Mutations.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoreConfig.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/persist/SecondaryIndex.html" title="class in com.sleepycat.persist"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/sleepycat/persist/StoreConfigBeanInfo.html" title="class in com.sleepycat.persist"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/persist/StoreConfig.html" target="_top">Frames</a></li>
<li><a href="StoreConfig.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>