609 lines
26 KiB
HTML
609 lines
26 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
|
<!-- NewPage -->
|
||
|
<html lang="en">
|
||
|
<head>
|
||
|
<!-- Generated by javadoc (1.8.0_151) on Tue Oct 31 17:36:45 EDT 2017 -->
|
||
|
<title>CursorConfig (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="CursorConfig (Oracle - Berkeley DB Java Edition API)";
|
||
|
}
|
||
|
}
|
||
|
catch(err) {
|
||
|
}
|
||
|
//-->
|
||
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
|
||
|
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
||
|
var altColor = "altColor";
|
||
|
var rowColor = "rowColor";
|
||
|
var tableTab = "tableTab";
|
||
|
var activeTableTab = "activeTableTab";
|
||
|
</script>
|
||
|
<noscript>
|
||
|
<div>JavaScript is disabled on your browser.</div>
|
||
|
</noscript>
|
||
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
|
<div class="topNav"><a name="navbar.top">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<a name="navbar.top.firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/CursorConfig.html">Use</a></li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
||
|
<li><a href="../../../index-all.html">Index</a></li>
|
||
|
<li><a href="../../../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
<li><a href="../../../com/sleepycat/je/CustomStats.html" title="interface in com.sleepycat.je"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../index.html?com/sleepycat/je/CursorConfig.html" target="_top">Frames</a></li>
|
||
|
<li><a href="CursorConfig.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_top">
|
||
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>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 ========= -->
|
||
|
<!-- ======== START OF CLASS DATA ======== -->
|
||
|
<div class="header">
|
||
|
<div class="subTitle">com.sleepycat.je</div>
|
||
|
<h2 title="Class CursorConfig" class="title">Class CursorConfig</h2>
|
||
|
</div>
|
||
|
<div class="contentContainer">
|
||
|
<ul class="inheritance">
|
||
|
<li>java.lang.Object</li>
|
||
|
<li>
|
||
|
<ul class="inheritance">
|
||
|
<li>com.sleepycat.je.CursorConfig</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">CursorConfig</span>
|
||
|
extends java.lang.Object
|
||
|
implements java.lang.Cloneable</pre>
|
||
|
<div class="block">Specifies the attributes of database cursor. An instance created with the
|
||
|
default constructor is initialized with the system's default settings.</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" border="0" cellpadding="3" cellspacing="0" 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="colLast" scope="col">Field and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>static <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#DEFAULT">DEFAULT</a></span></code>
|
||
|
<div class="block">Default configuration used if null is passed to methods that create a
|
||
|
cursor.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="rowColor">
|
||
|
<td class="colFirst"><code>static <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#READ_COMMITTED">READ_COMMITTED</a></span></code>
|
||
|
<div class="block">A convenience instance to configure a cursor for read committed
|
||
|
isolation.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colFirst"><code>static <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#READ_UNCOMMITTED">READ_UNCOMMITTED</a></span></code>
|
||
|
<div class="block">A convenience instance to configure read operations performed by the
|
||
|
cursor to return modified but not yet committed data.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="constructor.summary">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Constructor Summary</h3>
|
||
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||
|
<tr>
|
||
|
<th class="colOne" scope="col">Constructor and Description</th>
|
||
|
</tr>
|
||
|
<tr class="altColor">
|
||
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#CursorConfig--">CursorConfig</a></span>()</code>
|
||
|
<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" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
|
<tr>
|
||
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
|
<th class="colLast" scope="col">Method and Description</th>
|
||
|
</tr>
|
||
|
<tr id="i0" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#clone--">clone</a></span>()</code>
|
||
|
<div class="block">Returns a copy of this configuration object.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i1" class="rowColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#getNonSticky--">getNonSticky</a></span>()</code>
|
||
|
<div class="block">Returns the non-sticky setting.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i2" class="altColor">
|
||
|
<td class="colFirst"><code>boolean</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#getReadCommitted--">getReadCommitted</a></span>()</code>
|
||
|
<div class="block">Returns true if read operations performed by the cursor are configured
|
||
|
to obey read committed isolation.</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/je/CursorConfig.html#getReadUncommitted--">getReadUncommitted</a></span>()</code>
|
||
|
<div class="block">Returns true if read operations performed by the cursor are configured
|
||
|
to return modified but not yet committed data.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i4" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#setNonSticky-boolean-">setNonSticky</a></span>(boolean nonSticky)</code>
|
||
|
<div class="block">Configures the behavior of the cursor when a cursor movement operation
|
||
|
returns <a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a>.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i5" class="rowColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#setReadCommitted-boolean-">setReadCommitted</a></span>(boolean readCommitted)</code>
|
||
|
<div class="block">Configures read operations performed by the cursor to obey read
|
||
|
committed isolation.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i6" class="altColor">
|
||
|
<td class="colFirst"><code><a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a></code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#setReadUncommitted-boolean-">setReadUncommitted</a></span>(boolean readUncommitted)</code>
|
||
|
<div class="block">Configures read operations performed by the cursor to return modified
|
||
|
but not yet committed data.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
<tr id="i7" class="rowColor">
|
||
|
<td class="colFirst"><code>java.lang.String</code></td>
|
||
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/sleepycat/je/CursorConfig.html#toString--">toString</a></span>()</code>
|
||
|
<div class="block">Returns the values for each configuration attribute.</div>
|
||
|
</td>
|
||
|
</tr>
|
||
|
</table>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Methods inherited from class java.lang.Object</h3>
|
||
|
<code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
<div class="details">
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<!-- ============ FIELD DETAIL =========== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="field.detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Field Detail</h3>
|
||
|
<a name="DEFAULT">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>DEFAULT</h4>
|
||
|
<pre>public static final <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> DEFAULT</pre>
|
||
|
<div class="block">Default configuration used if null is passed to methods that create a
|
||
|
cursor.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="READ_UNCOMMITTED">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>READ_UNCOMMITTED</h4>
|
||
|
<pre>public static final <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> READ_UNCOMMITTED</pre>
|
||
|
<div class="block">A convenience instance to configure read operations performed by the
|
||
|
cursor to return modified but not yet committed data.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="READ_COMMITTED">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>READ_COMMITTED</h4>
|
||
|
<pre>public static final <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> READ_COMMITTED</pre>
|
||
|
<div class="block">A convenience instance to configure a cursor for read committed
|
||
|
isolation.
|
||
|
|
||
|
This ensures the stability of the current data item read by the cursor
|
||
|
but permits data read by this cursor to be modified or deleted prior to
|
||
|
the commit of the transaction.</div>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList"><a name="constructor.detail">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<h3>Constructor Detail</h3>
|
||
|
<a name="CursorConfig--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>CursorConfig</h4>
|
||
|
<pre>public CursorConfig()</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="setReadUncommitted-boolean-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setReadUncommitted</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> setReadUncommitted(boolean readUncommitted)</pre>
|
||
|
<div class="block">Configures read operations performed by the cursor to return modified
|
||
|
but not yet committed data.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>readUncommitted</code> - If true, configure read operations performed by
|
||
|
the cursor to return modified but not yet committed data.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
<dd><a href="../../../com/sleepycat/je/LockMode.html#READ_UNCOMMITTED"><code>LockMode.READ_UNCOMMITTED</code></a></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getReadUncommitted--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getReadUncommitted</h4>
|
||
|
<pre>public boolean getReadUncommitted()</pre>
|
||
|
<div class="block">Returns true if read operations performed by the cursor are configured
|
||
|
to return modified but not yet committed data.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>true if read operations performed by the cursor are configured
|
||
|
to return modified but not yet committed data.</dd>
|
||
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
<dd><a href="../../../com/sleepycat/je/LockMode.html#READ_UNCOMMITTED"><code>LockMode.READ_UNCOMMITTED</code></a></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setReadCommitted-boolean-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setReadCommitted</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> setReadCommitted(boolean readCommitted)</pre>
|
||
|
<div class="block">Configures read operations performed by the cursor to obey read
|
||
|
committed isolation. Read committed isolation provides for cursor
|
||
|
stability but not repeatable reads. Data items which have been
|
||
|
previously read by this transaction may be deleted or modified by other
|
||
|
transactions before the cursor is closed or the transaction completes.</div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>readCommitted</code> - If true, configure read operations performed by
|
||
|
the cursor to obey read committed isolation.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
<dd><a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getReadCommitted--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getReadCommitted</h4>
|
||
|
<pre>public boolean getReadCommitted()</pre>
|
||
|
<div class="block">Returns true if read operations performed by the cursor are configured
|
||
|
to obey read committed isolation.</div>
|
||
|
<dl>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>true if read operations performed by the cursor are configured
|
||
|
to obey read committed isolation.</dd>
|
||
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
<dd><a href="../../../com/sleepycat/je/LockMode.html#READ_COMMITTED"><code>LockMode.READ_COMMITTED</code></a></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="setNonSticky-boolean-">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>setNonSticky</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> setNonSticky(boolean nonSticky)</pre>
|
||
|
<div class="block">Configures the behavior of the cursor when a cursor movement operation
|
||
|
returns <a href="../../../com/sleepycat/je/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a>.
|
||
|
|
||
|
By default, a cursor is "sticky", meaning that the prior position is
|
||
|
maintained by cursor movement operations, and the cursor stays at the
|
||
|
prior position when the operation does not succeed. For example, if
|
||
|
<a href="../../../com/sleepycat/je/Cursor.html#getFirst-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-"><code>Cursor.getFirst(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.LockMode)</code></a> is called successfully, and then
|
||
|
<a href="../../../com/sleepycat/je/Cursor.html#getNext-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-"><code>Cursor.getNext(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.LockMode)</code></a> is called, if <code>getNext</code> returns
|
||
|
<code>NOTFOUND</code> the cursor will remain positioned on the first record.
|
||
|
<p>
|
||
|
Also, as part of maintaining the prior position, the lock on the record
|
||
|
at the current position will be held (at least) until after a cursor
|
||
|
movement operation succeeds and acquires a lock on the record at the new
|
||
|
position. In the example above, a lock on the first record will still
|
||
|
be held after <code>getNext</code> returns <code>NOTFOUND</code>.
|
||
|
<p>
|
||
|
If the cursor is configured to be non-sticky, the prior position is
|
||
|
not maintained, and this has certain performance advantages:
|
||
|
<ul>
|
||
|
<li>
|
||
|
Some processing is avoided because the prior position is not
|
||
|
maintained.
|
||
|
</li>
|
||
|
<li>
|
||
|
The lock on the record at the prior position is released before
|
||
|
acquiring the lock on the record at the new position (when the
|
||
|
cursor movement operation succeeds.) This can help to prevent
|
||
|
deadlocks in certain situations. Namely, if the cursor's isolation
|
||
|
mode allows locks to be released when moving to a new position, then
|
||
|
only one lock at a time will be held by the cursor. Holding multiple
|
||
|
locks at a time can cause deadlocks, when locks are acquired in
|
||
|
different orders by different threads, for example, when one cursor
|
||
|
is scanning forward and another cursor is scanning backward. Note
|
||
|
that this optimization does not apply to repeatable-read or
|
||
|
serializable isolation, since these modes require that locks are
|
||
|
not released by cursor movement operations.
|
||
|
</li>
|
||
|
</ul>
|
||
|
<p>
|
||
|
However, when the cursor is configured as non-sticky and <code>getNext</code>
|
||
|
returns <code>NOTFOUND</code> in the example above, the cursor position will
|
||
|
be uninitialized, as if it had just been opened. Also, the lock on the
|
||
|
first record will have been released (except when repeatable-read or
|
||
|
serializable isolation is configured.) To move to the first record (and
|
||
|
lock it), <code>getFirst</code> must be called again.
|
||
|
<p>
|
||
|
Also note that in certain circumstances, internal algorithms require
|
||
|
that the prior position is retained, and the operation will behave as if
|
||
|
the cursor is sticky. Specifically, these are only the following
|
||
|
methods, and only when called on a database with duplicates configured:
|
||
|
<ul>
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html#putNoOverwrite-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-"><code>Cursor.putNoOverwrite(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry)</code></a></li>
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html#getNextDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-"><code>Cursor.getNextDup(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.LockMode)</code></a>}</li>
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html#getPrevDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-"><code>Cursor.getPrevDup(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.LockMode)</code></a>}</li>
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html#getNextNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-"><code>Cursor.getNextNoDup(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.LockMode)</code></a>}</li>
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html#getPrevNoDup-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.DatabaseEntry-com.sleepycat.je.LockMode-"><code>Cursor.getPrevNoDup(com.sleepycat.je.DatabaseEntry, com.sleepycat.je.DatabaseEntry, com.sleepycat.je.LockMode)</code></a>}</li>
|
||
|
</ul></div>
|
||
|
<dl>
|
||
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
|
<dd><code>nonSticky</code> - if false (the default), the prior position is
|
||
|
maintained by cursor movement operations, and the cursor stays at the
|
||
|
prior position when <code>NOTFOUND</code> is returned. If true, the prior
|
||
|
position is not maintained, and the cursor is reinitialized when
|
||
|
<code>NOTFOUND</code> is returned.</dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>this</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="getNonSticky--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>getNonSticky</h4>
|
||
|
<pre>public boolean getNonSticky()</pre>
|
||
|
<div class="block">Returns the non-sticky setting.</div>
|
||
|
<dl>
|
||
|
<dt><span class="seeLabel">See Also:</span></dt>
|
||
|
<dd><a href="../../../com/sleepycat/je/CursorConfig.html#setNonSticky-boolean-"><code>setNonSticky(boolean)</code></a></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="clone--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockList">
|
||
|
<li class="blockList">
|
||
|
<h4>clone</h4>
|
||
|
<pre>public <a href="../../../com/sleepycat/je/CursorConfig.html" title="class in com.sleepycat.je">CursorConfig</a> clone()</pre>
|
||
|
<div class="block">Returns a copy of this configuration object.</div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
<dd><code>clone</code> in class <code>java.lang.Object</code></dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<a name="toString--">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="blockListLast">
|
||
|
<li class="blockList">
|
||
|
<h4>toString</h4>
|
||
|
<pre>public java.lang.String toString()</pre>
|
||
|
<div class="block">Returns the values for each configuration attribute.</div>
|
||
|
<dl>
|
||
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
||
|
<dd><code>toString</code> in class <code>java.lang.Object</code></dd>
|
||
|
<dt><span class="returnLabel">Returns:</span></dt>
|
||
|
<dd>the values for each configuration attribute.</dd>
|
||
|
</dl>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</li>
|
||
|
</ul>
|
||
|
</div>
|
||
|
</div>
|
||
|
<!-- ========= END OF CLASS DATA ========= -->
|
||
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
|
<div class="bottomNav"><a name="navbar.bottom">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
|
<a name="navbar.bottom.firstrow">
|
||
|
<!-- -->
|
||
|
</a>
|
||
|
<ul class="navList" title="Navigation">
|
||
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
|
<li><a href="package-summary.html">Package</a></li>
|
||
|
<li class="navBarCell1Rev">Class</li>
|
||
|
<li><a href="class-use/CursorConfig.html">Use</a></li>
|
||
|
<li><a href="package-tree.html">Tree</a></li>
|
||
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
||
|
<li><a href="../../../index-all.html">Index</a></li>
|
||
|
<li><a href="../../../help-doc.html">Help</a></li>
|
||
|
</ul>
|
||
|
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="subNav">
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../com/sleepycat/je/Cursor.html" title="class in com.sleepycat.je"><span class="typeNameLink">Prev Class</span></a></li>
|
||
|
<li><a href="../../../com/sleepycat/je/CustomStats.html" title="interface in com.sleepycat.je"><span class="typeNameLink">Next Class</span></a></li>
|
||
|
</ul>
|
||
|
<ul class="navList">
|
||
|
<li><a href="../../../index.html?com/sleepycat/je/CursorConfig.html" target="_top">Frames</a></li>
|
||
|
<li><a href="CursorConfig.html" target="_top">No Frames</a></li>
|
||
|
</ul>
|
||
|
<ul class="navList" id="allclasses_navbar_bottom">
|
||
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
|
</ul>
|
||
|
<div>
|
||
|
<script type="text/javascript"><!--
|
||
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
|
if(window==top) {
|
||
|
allClassesLink.style.display = "block";
|
||
|
}
|
||
|
else {
|
||
|
allClassesLink.style.display = "none";
|
||
|
}
|
||
|
//-->
|
||
|
</script>
|
||
|
</div>
|
||
|
<div>
|
||
|
<ul class="subNavList">
|
||
|
<li>Summary: </li>
|
||
|
<li>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) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
|
||
|
</body>
|
||
|
</html>
|