mirror of
https://github.com/yasuhirokimura/db18
synced 2026-06-08 18:29:23 +00:00
Yasuhiro KIMURA
1277 lines
79 KiB
HTML
1277 lines
79 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>SecondaryCursor (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="SecondaryCursor (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,"i16":10,"i17":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/SecondaryCursor.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>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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 SecondaryCursor" class="title">Class SecondaryCursor</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li><a href="Cursor.html" title="class in com.sleepycat.db">com.sleepycat.db.Cursor</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.db.SecondaryCursor</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">SecondaryCursor</span>
|
|
extends <a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a></pre>
|
|
<div class="block">A database cursor for a secondary database. Cursors are not thread safe
|
|
and the application is responsible for coordinating any multithreaded
|
|
access to a single cursor object.
|
|
<p>
|
|
Secondary cursors are returned by
|
|
<a href="SecondaryDatabase.html#openCursor-com.sleepycat.db.Transaction-com.sleepycat.db.CursorConfig-"><code>SecondaryDatabase.openCursor</code></a> and
|
|
<a href="SecondaryDatabase.html#openSecondaryCursor-com.sleepycat.db.Transaction-com.sleepycat.db.CursorConfig-"><code>SecondaryDatabase.openSecondaryCursor</code></a>. The distinguishing characteristics
|
|
of a secondary cursor are:
|
|
<ul>
|
|
<li>Direct calls to <code>put()</code> methods on a secondary cursor are
|
|
prohibited.
|
|
<li>The <a href="Cursor.html#delete--"><code>Cursor.delete()</code></a> method of a secondary cursor will delete the primary
|
|
record and as well as all its associated secondary records.
|
|
<li>Calls to all get methods will return the data from the associated
|
|
primary database.
|
|
<li>Additional get method signatures are provided to return the primary key
|
|
in an additional pKey parameter.
|
|
<li>Calls to <a href="#dup-boolean-"><code>dup(boolean)</code></a> will return a <a href="SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a>.
|
|
<li>The <a href="#dupSecondary-boolean-"><code>dupSecondary(boolean)</code></a> method is provided to return a <a href="SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a> that doesn't require casting.
|
|
</ul>
|
|
<p>
|
|
To obtain a secondary cursor with default attributes:
|
|
<blockquote><pre>
|
|
SecondaryCursor cursor = myDb.openSecondaryCursor(txn, null);
|
|
</pre></blockquote>
|
|
To customize the attributes of a cursor, use a CursorConfig object.
|
|
<blockquote><pre>
|
|
CursorConfig config = new CursorConfig();
|
|
config.setDirtyRead(true);
|
|
SecondaryCursor cursor = myDb.openSecondaryCursor(txn, config);
|
|
</pre></blockquote></div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========== 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><a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dup-boolean-">dup</a></span>​(boolean samePosition)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns a new <code>SecondaryCursor</code> for the same transaction as
|
|
the original cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dupSecondary-boolean-">dupSecondary</a></span>​(boolean samePosition)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns a new copy of the cursor as a <code>SecondaryCursor</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrent-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getCurrent</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the key/data pair to which the cursor refers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getFirst</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the first key/data pair of the database, and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getLast</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the last key/data pair of the database, and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNext-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNext</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the next key/data pair and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNextDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, move the cursor to the next key/data pair
|
|
of the database and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNextNoDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the next non-duplicate key/data pair and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrev-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrev</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the previous key/data pair and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrevDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrevDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, move the cursor to the previous key/data
|
|
pair of the database and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrevNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrevNoDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the previous non-duplicate key/data pair and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getRecordNumber</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> primaryRecno,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the record number associated with the cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchBoth-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchBoth</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the specified secondary and primary key, where both
|
|
the primary and secondary key items must match.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchBothRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchBothRange</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the specified secondary key and closest matching primary
|
|
key of the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchKey-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchKey</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the given key of the database, and return the datum
|
|
associated with the given key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchKeyRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchKeyRange</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the closest matching key of the database, and return
|
|
the data item associated with the matching key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchRecordNumber</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the specific numbered record of the database, and
|
|
return the associated key/data pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecondaryDatabase--">getSecondaryDatabase</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the SecondaryDatabase handle associated with this Cursor.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.com.sleepycat.db.Cursor">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class com.sleepycat.db.<a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a></h3>
|
|
<code><a href="Cursor.html#close--">close</a>, <a href="Cursor.html#compare-com.sleepycat.db.Cursor-">compare</a>, <a href="Cursor.html#count--">count</a>, <a href="Cursor.html#delete--">delete</a>, <a href="Cursor.html#getConfig--">getConfig</a>, <a href="Cursor.html#getCurrent-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getCurrent</a>, <a href="Cursor.html#getDatabase--">getDatabase</a>, <a href="Cursor.html#getFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getFirst</a>, <a href="Cursor.html#getLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getLast</a>, <a href="Cursor.html#getNext-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNext</a>, <a href="Cursor.html#getNextDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNextDup</a>, <a href="Cursor.html#getNextNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNextNoDup</a>, <a href="Cursor.html#getPrev-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrev</a>, <a href="Cursor.html#getPrevDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrevDup</a>, <a href="Cursor.html#getPrevNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrevNoDup</a>, <a href="Cursor.html#getPriority--">getPriority</a>, <a href="Cursor.html#getRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getRecordNumber</a>, <a href="Cursor.html#getSearchBoth-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchBoth</a>, <a href="Cursor.html#getSearchBothRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchBothRange</a>, <a href="Cursor.html#getSearchKey-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchKey</a>, <a href="Cursor.html#getSearchKeyRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchKeyRange</a>, <a href="Cursor.html#getSearchRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchRecordNumber</a>, <a href="Cursor.html#openDatabaseStream-com.sleepycat.db.DatabaseStreamConfig-">openDatabaseStream</a>, <a href="Cursor.html#put-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">put</a>, <a href="Cursor.html#putAfter-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putAfter</a>, <a href="Cursor.html#putBefore-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putBefore</a>, <a href="Cursor.html#putCurrent-com.sleepycat.db.DatabaseEntry-">putCurrent</a>, <a href="Cursor.html#putKeyFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putKeyFirst</a>, <a href="Cursor.html#putKeyLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putKeyLast</a>, <a href="Cursor.html#putNoDupData-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putNoDupData</a>, <a href="Cursor.html#putNoOverwrite-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putNoOverwrite</a>, <a href="Cursor.html#setPriority-com.sleepycat.db.CacheFilePriority-">setPriority</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">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="getSecondaryDatabase--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSecondaryDatabase</h4>
|
|
<pre class="methodSignature">public <a href="SecondaryDatabase.html" title="class in com.sleepycat.db">SecondaryDatabase</a> getSecondaryDatabase()</pre>
|
|
<div class="block">Return the SecondaryDatabase handle associated with this Cursor.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The SecondaryDatabase handle associated with this Cursor.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="dup-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>dup</h4>
|
|
<pre class="methodSignature">public <a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a> dup​(boolean samePosition)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Returns a new <code>SecondaryCursor</code> for the same transaction as
|
|
the original cursor.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
|
|
<dd><code><a href="Cursor.html#dup-boolean-">dup</a></code> in class <code><a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></dd>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>samePosition</code> - If true, the newly created cursor is initialized to refer to the
|
|
same position in the database as the original cursor (if any) and
|
|
hold the same locks (if any). If false, or the original cursor does
|
|
not hold a database position and locks, the returned cursor is
|
|
uninitialized and will behave like a newly created cursor.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A new cursor with the same transaction and locker ID as the original
|
|
cursor.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="dupSecondary-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>dupSecondary</h4>
|
|
<pre class="methodSignature">public <a href="SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a> dupSecondary​(boolean samePosition)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Returns a new copy of the cursor as a <code>SecondaryCursor</code>.
|
|
<p>
|
|
Calling this method is the equivalent of calling <a href="#dup-boolean-"><code>dup(boolean)</code></a> and
|
|
casting the result to <a href="SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>samePosition</code> - If true, the newly created cursor is initialized to refer to the
|
|
same position in the database as the original cursor (if any) and
|
|
hold the same locks (if any). If false, or the original cursor does
|
|
not hold a database position and locks, the returned cursor is
|
|
uninitialized and will behave like a newly created cursor.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a new cursor with the same transaction and locker ID as the original
|
|
cursor</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#dup-boolean-"><code>dup(boolean)</code></a></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCurrent-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrent</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getCurrent​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Returns the key/data pair to which the cursor refers.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor
|
|
position has been deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirst</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getFirst​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the first key/data pair of the database, and return
|
|
that pair. If the first key has duplicate values, the first data item
|
|
in the set of duplicates is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLast</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getLast​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the last key/data pair of the database, and return
|
|
that pair. If the last key has duplicate values, the last data item in
|
|
the set of duplicates is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNext-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNext</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNext​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the next key/data pair and return that pair. If
|
|
the matching key has duplicate values, the first data item in the set
|
|
of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next key/data pair of the database, and that pair
|
|
is returned. In the presence of duplicate key values, the value of the
|
|
key may not change.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNextDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, move the cursor to the next key/data pair
|
|
of the database and return that pair.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextNoDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNextNoDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the next non-duplicate key/data pair and return
|
|
that pair. If the matching key has duplicate values, the first data
|
|
item in the set of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next non-duplicate key of the database, and that
|
|
key/data pair is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrev-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrev</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrev​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the previous key/data pair and return that pair.
|
|
If the matching key has duplicate values, the last data item in the set
|
|
of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous key/data pair of the database, and that
|
|
pair is returned. In the presence of duplicate key values, the value of
|
|
the key may not change.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrevDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, move the cursor to the previous key/data
|
|
pair of the database and return that pair.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevNoDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrevNoDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the previous non-duplicate key/data pair and return
|
|
that pair. If the matching key has duplicate values, the last data item
|
|
in the set of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous non-duplicate key of the database, and
|
|
that key/data pair is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRecordNumber</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getRecordNumber​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> primaryRecno,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the record number associated with the cursor. The record number
|
|
will be returned in the data parameter.
|
|
<p>
|
|
For this method to be called, the underlying database must be of type
|
|
Btree, and it must have been configured to support record numbers.
|
|
<p>
|
|
When called on a cursor opened on a database that has been made into a
|
|
secondary index, the method returns the record numbers of both the
|
|
secondary and primary databases. If either underlying database is not of
|
|
type Btree or is not configured with record numbers, the out-of-band
|
|
record number of 0 is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>secondaryRecno</code> - the secondary record number
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>primaryRecno</code> - the primary record number
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKey-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKey</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchKey​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the given key of the database, and return the datum
|
|
associated with the given key. If the matching key has duplicate
|
|
values, the first data item in the set of duplicates is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKeyRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKeyRange</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchKeyRange​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the closest matching key of the database, and return
|
|
the data item associated with the matching key. If the matching key has
|
|
duplicate values, the first data item in the set of duplicates is returned.
|
|
<p>
|
|
The returned key/data pair is for the smallest key greater than or equal
|
|
to the specified key (as determined by the key comparison function),
|
|
permitting partial key matches and range searches.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
used as input and returned as output. It must be initialized with a non-null
|
|
byte array by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBoth-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBoth</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBoth​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the specified secondary and primary key, where both
|
|
the primary and secondary key items must match.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBothRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBothRange</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBothRange​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the specified secondary key and closest matching primary
|
|
key of the database.
|
|
<p>
|
|
In the case of any database supporting sorted duplicate sets, the returned
|
|
key/data pair is for the smallest primary key greater than or equal to the
|
|
specified primary key (as determined by the key comparison function),
|
|
permitting partial matches and range searches in duplicate data sets.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the secondary key
|
|
used as input and returned as output. It must be initialized with a non-null
|
|
byte array by the caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
used as input and returned as output. It must be initialized with a non-null
|
|
byte array by the caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>getSearchRecordNumber</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchRecordNumber​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> secondaryRecno,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the specific numbered record of the database, and
|
|
return the associated key/data pair.
|
|
<p>
|
|
The data field of the specified key must be a byte array containing a
|
|
record number, as described in <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>. This determines
|
|
the record to be retrieved.
|
|
<p>
|
|
For this method to be called, the underlying database must be of type
|
|
Btree, and it must have been configured to support record numbers.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>secondaryRecno</code> - the secondary record number
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>pKey</code> - the primary key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the primary data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></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/SecondaryCursor.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>Field | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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>
|