diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/SecondaryDatabase.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/SecondaryDatabase.html | 1057 |
1 files changed, 517 insertions, 540 deletions
diff --git a/docs/java/com/sleepycat/db/SecondaryDatabase.html b/docs/java/com/sleepycat/db/SecondaryDatabase.html index 3c335cc8..cd06c9b2 100644 --- a/docs/java/com/sleepycat/db/SecondaryDatabase.html +++ b/docs/java/com/sleepycat/db/SecondaryDatabase.html @@ -1,130 +1,132 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:06 EDT 2012 --> -<TITLE> -SecondaryDatabase (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:54 EST 2015 --> +<title>SecondaryDatabase (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="SecondaryDatabase (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecondaryDatabase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/SecondaryDatabase.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryDatabase.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/SecondaryDatabase.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/SecondaryDatabase.html" target="_top">Frames</a></li> +<li><a href="SecondaryDatabase.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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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>Field | </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 ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.db</FONT> -<BR> -Class SecondaryDatabase</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">com.sleepycat.db.Database</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.SecondaryDatabase</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>SecondaryDatabase</B><DT>extends <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></DL> -</PRE> - -<P> -A secondary database handle. +<div class="header"> +<div class="subTitle">com.sleepycat.db</div> +<h2 title="Class SecondaryDatabase" class="title">Class SecondaryDatabase</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">com.sleepycat.db.Database</a></li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.SecondaryDatabase</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">SecondaryDatabase</span> +extends <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></pre> +<div class="block">A secondary database handle. <p> -Secondary databases are opened with <A HREF="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"><CODE>Environment.openSecondaryDatabase</CODE></A> and are +Secondary databases are opened with <a href="../../../com/sleepycat/db/Environment.html#openSecondaryDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.Database,%20com.sleepycat.db.SecondaryConfig)"><code>Environment.openSecondaryDatabase</code></a> and are always associated with a single primary database. The distinguishing characteristics of a secondary database are: <ul> <li>Records are automatically added to a secondary database when records are added, modified and deleted in the primary database. Direct calls to <code>put()</code> methods on a secondary database are prohibited.</li> -<li>The <A HREF="../../../com/sleepycat/db/Database.html#delete(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry)"><CODE>delete</CODE></A> method of a secondary database will delete +<li>The <a href="../../../com/sleepycat/db/Database.html#delete(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry)"><code>delete</code></a> method of a secondary database will delete the primary record and as well as all its associated secondary records.</li> <li>Calls to all <code>get()</code> methods will return the data from the associated primary database.</li> <li>Additional <code>get()</code> method signatures are provided to return the primary key in an additional <code>pKey</code> parameter.</li> -<li>Calls to <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><CODE>openCursor</CODE></A> will return a <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><CODE>SecondaryCursor</CODE></A>, which itself has <code>get()</code> methods that return +<li>Calls to <a href="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)"><code>openCursor</code></a> will return a <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a>, which itself has <code>get()</code> methods that return the data of the primary database and additional <code>get()</code> method signatures for returning the primary key.</li> -<li>The <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openSecondaryCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><CODE>openSecondaryCursor</CODE></A> method is provided -to return a <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><CODE>SecondaryCursor</CODE></A> that doesn't require casting.</li> +<li>The <a href="../../../com/sleepycat/db/SecondaryDatabase.html#openSecondaryCursor(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)"><code>openSecondaryCursor</code></a> method is provided +to return a <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a> that doesn't require casting.</li> </ul> <p> -Before opening or creating a secondary database you must implement the <A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db"><CODE>SecondaryKeyCreator</CODE></A> +Before opening or creating a secondary database you must implement the <a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db"><code>SecondaryKeyCreator</code></a> interface. <p> For example, to create a secondary database that supports duplicates: @@ -148,163 +150,152 @@ Note that the associations between primary and secondary databases are not stored persistently. Whenever a primary database is opened for write access by the application, the appropriate associated secondary databases should also be opened by the application. This is necessary to ensure data integrity when -changes are made to the primary database. -<P> - -<P> -<HR> - -<P> - +changes are made to the primary database.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#SecondaryDatabase(java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)">SecondaryDatabase</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase, - <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config)</CODE> - -<BR> - Open a database.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#SecondaryDatabase(java.lang.String,%20java.lang.String,%20com.sleepycat.db.Database,%20com.sleepycat.db.SecondaryConfig)">SecondaryDatabase</a></strong>(java.lang.String fileName, + java.lang.String databaseName, + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> primaryDatabase, + <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> config)</code> +<div class="block">Open a database.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">get</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Retrieves the key/data pair with the given key.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#getConfig()">getConfig</A></B>()</CODE> - -<BR> - Return this Database object's configuration.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#getPrimaryDatabase()">getPrimaryDatabase</A></B>()</CODE> - -<BR> - Returns the primary database associated with this secondary database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#getSearchBoth(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Retrieves the key/data pair with the specified secondary and primary key, that -is, both the primary and secondary key items must match.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#getSearchRecordNumber(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode)</CODE> - -<BR> - Retrieves the key/data pair associated with the specific numbered record of the database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#getSecondaryConfig()">getSecondaryConfig</A></B>()</CODE> - -<BR> - Returns a copy of the secondary configuration of this database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">openCursor</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config)</CODE> - -<BR> - Return a cursor into the database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openSecondaryCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">openSecondaryCursor</A></B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config)</CODE> - -<BR> - Obtain a cursor on a database, returning a <code>SecondaryCursor</code>.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_com.sleepycat.db.Database"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.db.<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">append</A>, <A HREF="../../../com/sleepycat/db/Database.html#close()">close</A>, <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)">close</A>, <A HREF="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)">compact</A>, <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)">consume</A>, <A HREF="../../../com/sleepycat/db/Database.html#delete(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry)">delete</A>, <A HREF="../../../com/sleepycat/db/Database.html#deleteMultiple(com.sleepycat.db.Transaction, com.sleepycat.db.MultipleEntry)">deleteMultiple</A>, <A HREF="../../../com/sleepycat/db/Database.html#deleteMultipleKey(com.sleepycat.db.Transaction, com.sleepycat.db.MultipleEntry)">deleteMultipleKey</A>, <A HREF="../../../com/sleepycat/db/Database.html#exists(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry)">exists</A>, <A HREF="../../../com/sleepycat/db/Database.html#get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">get</A>, <A HREF="../../../com/sleepycat/db/Database.html#getCacheFile()">getCacheFile</A>, <A HREF="../../../com/sleepycat/db/Database.html#getDatabaseFile()">getDatabaseFile</A>, <A HREF="../../../com/sleepycat/db/Database.html#getDatabaseName()">getDatabaseName</A>, <A HREF="../../../com/sleepycat/db/Database.html#getEnvironment()">getEnvironment</A>, <A HREF="../../../com/sleepycat/db/Database.html#getKeyRange(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry)">getKeyRange</A>, <A HREF="../../../com/sleepycat/db/Database.html#getSearchBoth(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchBoth</A>, <A HREF="../../../com/sleepycat/db/Database.html#getSearchRecordNumber(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)">getSearchRecordNumber</A>, <A HREF="../../../com/sleepycat/db/Database.html#getStats(com.sleepycat.db.Transaction, com.sleepycat.db.StatsConfig)">getStats</A>, <A HREF="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[], com.sleepycat.db.JoinConfig)">join</A>, <A HREF="../../../com/sleepycat/db/Database.html#openSequence(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.SequenceConfig)">openSequence</A>, <A HREF="../../../com/sleepycat/db/Database.html#put(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">put</A>, <A HREF="../../../com/sleepycat/db/Database.html#putMultiple(com.sleepycat.db.Transaction, com.sleepycat.db.MultipleEntry, com.sleepycat.db.MultipleEntry, boolean)">putMultiple</A>, <A HREF="../../../com/sleepycat/db/Database.html#putMultipleKey(com.sleepycat.db.Transaction, com.sleepycat.db.MultipleEntry, boolean)">putMultipleKey</A>, <A HREF="../../../com/sleepycat/db/Database.html#putNoDupData(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoDupData</A>, <A HREF="../../../com/sleepycat/db/Database.html#putNoOverwrite(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)">putNoOverwrite</A>, <A HREF="../../../com/sleepycat/db/Database.html#remove(java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)">remove</A>, <A HREF="../../../com/sleepycat/db/Database.html#removeSequence(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.SequenceConfig)">removeSequence</A>, <A HREF="../../../com/sleepycat/db/Database.html#rename(java.lang.String, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)">rename</A>, <A HREF="../../../com/sleepycat/db/Database.html#setConfig(com.sleepycat.db.DatabaseConfig)">setConfig</A>, <A HREF="../../../com/sleepycat/db/Database.html#sortMultipleKeyAndData(com.sleepycat.db.MultipleDataEntry, com.sleepycat.db.MultipleDataEntry)">sortMultipleKeyAndData</A>, <A HREF="../../../com/sleepycat/db/Database.html#sortMultipleKeyData(com.sleepycat.db.MultipleKeyDataEntry)">sortMultipleKeyData</A>, <A HREF="../../../com/sleepycat/db/Database.html#sortMultipleKeyOrData(com.sleepycat.db.MultipleDataEntry)">sortMultipleKeyOrData</A>, <A HREF="../../../com/sleepycat/db/Database.html#sync()">sync</A>, <A HREF="../../../com/sleepycat/db/Database.html#truncate(com.sleepycat.db.Transaction, boolean)">truncate</A>, <A HREF="../../../com/sleepycat/db/Database.html#upgrade(java.lang.String, com.sleepycat.db.DatabaseConfig)">upgrade</A>, <A HREF="../../../com/sleepycat/db/Database.html#verify(java.lang.String, java.lang.String, java.io.PrintStream, com.sleepycat.db.VerifyConfig, com.sleepycat.db.DatabaseConfig)">verify</A></CODE></TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#get(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)">get</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> +<div class="block">Retrieves the key/data pair with the given key.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#getConfig()">getConfig</a></strong>()</code> +<div class="block">Return this Database object's configuration.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#getPrimaryDatabase()">getPrimaryDatabase</a></strong>()</code> +<div class="block">Returns the primary database associated with this secondary database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#getSearchBoth(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)">getSearchBoth</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> +<div class="block">Retrieves the key/data pair with the specified secondary and primary key, that +is, both the primary and secondary key items must match.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#getSearchRecordNumber(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)">getSearchRecordNumber</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code> +<div class="block">Retrieves the key/data pair associated with the specific numbered record of the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#getSecondaryConfig()">getSecondaryConfig</a></strong>()</code> +<div class="block">Returns a copy of the secondary configuration of this database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">openCursor</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code> +<div class="block">Return a cursor into the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/SecondaryDatabase.html#openSecondaryCursor(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">openSecondaryCursor</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code> +<div class="block">Obtain a cursor on a database, returning a <code>SecondaryCursor</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_com.sleepycat.db.Database"> +<!-- --> +</a> +<h3>Methods inherited from class com.sleepycat.db.<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></h3> +<code><a href="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)">append</a>, <a href="../../../com/sleepycat/db/Database.html#close()">close</a>, <a href="../../../com/sleepycat/db/Database.html#close(boolean)">close</a>, <a href="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.CompactConfig)">compact</a>, <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)">consume</a>, <a href="../../../com/sleepycat/db/Database.html#delete(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry)">delete</a>, <a href="../../../com/sleepycat/db/Database.html#deleteMultiple(com.sleepycat.db.Transaction,%20com.sleepycat.db.MultipleEntry)">deleteMultiple</a>, <a href="../../../com/sleepycat/db/Database.html#deleteMultipleKey(com.sleepycat.db.Transaction,%20com.sleepycat.db.MultipleEntry)">deleteMultipleKey</a>, <a href="../../../com/sleepycat/db/Database.html#exists(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry)">exists</a>, <a href="../../../com/sleepycat/db/Database.html#get(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)">get</a>, <a href="../../../com/sleepycat/db/Database.html#getCacheFile()">getCacheFile</a>, <a href="../../../com/sleepycat/db/Database.html#getDatabaseFile()">getDatabaseFile</a>, <a href="../../../com/sleepycat/db/Database.html#getDatabaseName()">getDatabaseName</a>, <a href="../../../com/sleepycat/db/Database.html#getEnvironment()">getEnvironment</a>, <a href="../../../com/sleepycat/db/Database.html#getKeyRange(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry)">getKeyRange</a>, <a href="../../../com/sleepycat/db/Database.html#getSearchBoth(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)">getSearchBoth</a>, <a href="../../../com/sleepycat/db/Database.html#getSearchRecordNumber(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)">getSearchRecordNumber</a>, <a href="../../../com/sleepycat/db/Database.html#getStats(com.sleepycat.db.Transaction,%20com.sleepycat.db.StatsConfig)">getStats</a>, <a href="../../../com/sleepycat/db/Database.html#join(com.sleepycat.db.Cursor[],%20com.sleepycat.db.JoinConfig)">join</a>, <a href="../../../com/sleepycat/db/Database.html#openSequence(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.SequenceConfig)">openSequence</a>, <a href="../../../com/sleepycat/db/Database.html#printStats(com.sleepycat.db.StatsConfig)">printStats</a>, <a href="../../../com/sleepycat/db/Database.html#put(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)">put</a>, <a href="../../../com/sleepycat/db/Database.html#putMultiple(com.sleepycat.db.Transaction,%20com.sleepycat.db.MultipleEntry,%20com.sleepycat.db.MultipleEntry,%20boolean)">putMultiple</a>, <a href="../../../com/sleepycat/db/Database.html#putMultipleKey(com.sleepycat.db.Transaction,%20com.sleepycat.db.MultipleEntry,%20boolean)">putMultipleKey</a>, <a href="../../../com/sleepycat/db/Database.html#putNoDupData(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)">putNoDupData</a>, <a href="../../../com/sleepycat/db/Database.html#putNoOverwrite(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)">putNoOverwrite</a>, <a href="../../../com/sleepycat/db/Database.html#remove(java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)">remove</a>, <a href="../../../com/sleepycat/db/Database.html#removeSequence(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.SequenceConfig)">removeSequence</a>, <a href="../../../com/sleepycat/db/Database.html#rename(java.lang.String,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)">rename</a>, <a href="../../../com/sleepycat/db/Database.html#setConfig(com.sleepycat.db.DatabaseConfig)">setConfig</a>, <a href="../../../com/sleepycat/db/Database.html#setMsgfile(java.io.File)">setMsgfile</a>, <a href="../../../com/sleepycat/db/Database.html#sortMultipleKeyAndData(com.sleepycat.db.MultipleDataEntry,%20com.sleepycat.db.MultipleDataEntry)">sortMultipleKeyAndData</a>, <a href="../../../com/sleepycat/db/Database.html#sortMultipleKeyData(com.sleepycat.db.MultipleKeyDataEntry)">sortMultipleKeyData</a>, <a href="../../../com/sleepycat/db/Database.html#sortMultipleKeyOrData(com.sleepycat.db.MultipleDataEntry)">sortMultipleKeyOrData</a>, <a href="../../../com/sleepycat/db/Database.html#sync()">sync</a>, <a href="../../../com/sleepycat/db/Database.html#truncate(com.sleepycat.db.Transaction,%20boolean)">truncate</a>, <a href="../../../com/sleepycat/db/Database.html#upgrade(java.lang.String,%20com.sleepycat.db.DatabaseConfig)">upgrade</a>, <a href="../../../com/sleepycat/db/Database.html#verify(java.lang.String,%20java.lang.String,%20java.io.PrintStream,%20com.sleepycat.db.VerifyConfig,%20com.sleepycat.db.DatabaseConfig)">verify</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"> <!-- ========= CONSTRUCTOR DETAIL ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="SecondaryDatabase(java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"><!-- --></A><H3> -SecondaryDatabase</H3> -<PRE> -public <B>SecondaryDatabase</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> fileName, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> databaseName, - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> primaryDatabase, - <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A>, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></PRE> -<DL> -<DD>Open a database. +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="SecondaryDatabase(java.lang.String, java.lang.String, com.sleepycat.db.Database, com.sleepycat.db.SecondaryConfig)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SecondaryDatabase</h4> +<pre>public SecondaryDatabase(java.lang.String fileName, + java.lang.String databaseName, + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> primaryDatabase, + <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>, + java.io.FileNotFoundException</pre> +<div class="block">Open a database. <p> The database is represented by the file and database parameters. <p> @@ -317,7 +308,7 @@ record number. The Recno format supports fixed- or variable-length records, accessed sequentially or by logical record number, and optionally backed by a flat text file. <p> -Storage and retrieval are based on key/data pairs; see <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A> +Storage and retrieval are based on key/data pairs; see <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> for more information. <p> Opening a database is a relatively expensive operation, and maintaining @@ -330,50 +321,46 @@ null. Note that in-memory databases can only ever be shared by sharing the single database handle that created them, in circumstances where doing so is safe. The environment variable <code>TMPDIR</code> may be used as a directory in which to create temporary backing files. -<p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>fileName</CODE> - The name of an underlying file that will be used to back the database. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileName</code> - The name of an underlying file that will be used to back the database. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -<p><DD><CODE>databaseName</CODE> - An optional parameter that allows applications to have multiple +<p></dd><dd><code>databaseName</code> - An optional parameter that allows applications to have multiple databases in a single file. Although no databaseName parameter needs to be specified, it is an error to attempt to open a second database in a physical file that was not initially created using a databaseName parameter. Further, the databaseName parameter is not supported by the Queue format. -<p><DD><CODE>primaryDatabase</CODE> - a database handle for the primary database that is to be indexed. -<p><DD><CODE>config</CODE> - The secondary database open attributes. If null, default attributes are used. -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/FileNotFoundException.html?is-external=true" title="class or interface in java.io">FileNotFoundException</A></CODE></DL> -</DL> - +<p></dd><dd><code>primaryDatabase</code> - a database handle for the primary database that is to be indexed. +<p></dd><dd><code>config</code> - The secondary database open attributes. If null, default attributes are used.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd> +<dd><code>java.io.FileNotFoundException</code></dd></dl> +</li> +</ul> +</li> +</ul> <!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><!-- --></A><H3> -openCursor</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</A> <B>openCursor</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return a cursor into the database. - <p> -<P> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/sleepycat/db/Database.html#openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)">openCursor</A></CODE> in class <CODE><A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - To use a cursor for writing to a transactional database, an explicit +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openCursor</h4> +<pre>public <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db">Cursor</a> openCursor(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return a cursor into the database. + <p></div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/sleepycat/db/Database.html#openCursor(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)">openCursor</a></code> in class <code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - To use a cursor for writing to a transactional database, an explicit transaction must be specified. For read-only access to a transactional database, the transaction may be null. For a non-transactional database, the transaction must be null. @@ -381,30 +368,28 @@ public <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleep To transaction-protect cursor operations, cursors must be opened and closed within the context of a transaction, and the txn parameter specifies the transaction context in which the cursor will be used. - <p><DD><CODE>config</CODE> - The cursor attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>A database cursor. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="openSecondaryCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><!-- --></A><H3> -openSecondaryCursor</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</A> <B>openSecondaryCursor</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</A> config) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Obtain a cursor on a database, returning a <code>SecondaryCursor</code>. - Calling this method is the equivalent of calling <A HREF="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"><CODE>openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)</CODE></A> and - casting the result to <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><CODE>SecondaryCursor</CODE></A>. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - To use a cursor for writing to a transactional database, an explicit + <p></dd><dd><code>config</code> - The cursor attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A database cursor. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="openSecondaryCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>openSecondaryCursor</h4> +<pre>public <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a> openSecondaryCursor(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Obtain a cursor on a database, returning a <code>SecondaryCursor</code>. + Calling this method is the equivalent of calling <a href="../../../com/sleepycat/db/SecondaryDatabase.html#openCursor(com.sleepycat.db.Transaction,%20com.sleepycat.db.CursorConfig)"><code>openCursor(com.sleepycat.db.Transaction, com.sleepycat.db.CursorConfig)</code></a> and + casting the result to <a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><code>SecondaryCursor</code></a>. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - To use a cursor for writing to a transactional database, an explicit transaction must be specified. For read-only access to a transactional database, the transaction may be null. For a non-transactional database, the transaction must be null. @@ -412,272 +397,264 @@ public <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in To transaction-protect cursor operations, cursors must be opened and closed within the context of a transaction, and the txn parameter specifies the transaction context in which the cursor will be used. - <p><DD><CODE>config</CODE> - The cursor attributes. If null, default attributes are used. - <p> -<DT><B>Returns:</B><DD>A secondary database cursor. - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPrimaryDatabase()"><!-- --></A><H3> -getPrimaryDatabase</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A> <B>getPrimaryDatabase</B>()</PRE> -<DL> -<DD>Returns the primary database associated with this secondary database. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>the primary database associated with this secondary database.</DL> -</DD> -</DL> -<HR> - -<A NAME="getConfig()"><!-- --></A><H3> -getConfig</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> <B>getConfig</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Return this Database object's configuration. + <p></dd><dd><code>config</code> - The cursor attributes. If null, default attributes are used. + <p></dd> +<dt><span class="strong">Returns:</span></dt><dd>A secondary database cursor. + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getPrimaryDatabase()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPrimaryDatabase</h4> +<pre>public <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> getPrimaryDatabase()</pre> +<div class="block">Returns the primary database associated with this secondary database. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the primary database associated with this secondary database.</dd></dl> +</li> +</ul> +<a name="getConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getConfig</h4> +<pre>public <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> getConfig() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Return this Database object's configuration. <p> This may differ from the configuration used to open this object if the database existed previously. + <p></div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../com/sleepycat/db/Database.html#getConfig()">getConfig</a></code> in class <code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>This Database object's configuration. <p> -<P> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/sleepycat/db/Database.html#getConfig()">getConfig</A></CODE> in class <CODE><A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</A></CODE></DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>This Database object's configuration. - <p> - <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getSecondaryConfig()"><!-- --></A><H3> -getSecondaryConfig</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A> <B>getSecondaryConfig</B>() - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Returns a copy of the secondary configuration of this database. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>a copy of the secondary configuration of this database. - <p> + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getSecondaryConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSecondaryConfig</h4> +<pre>public <a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a> getSecondaryConfig() + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Returns a copy of the secondary configuration of this database. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a copy of the secondary configuration of this database. <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> -get</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>get</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Retrieves the key/data pair with the given key. If the matching key has + <p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> get(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Retrieves the key/data pair with the given key. If the matching key has duplicate values, the first data item in the set of duplicates is returned. -Retrieval of duplicates requires the use of <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> operations. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified to +Retrieval of duplicates requires the use of <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> operations. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - For a transactional database, an explicit transaction may be specified to transaction-protect the operation, or null may be specified to perform the operation without transaction protection. For a non-transactional database, null must be specified. -<p><DD><CODE>key</CODE> - the secondary key +<p></dd><dd><code>key</code> - the secondary key used as input. It must be initialized with a non-null byte array by the caller. -<p><DD><CODE>pKey</CODE> - the primary key +<p></dd><dd><code>pKey</code> - the primary key returned as output. Its byte array does not need to be initialized by the caller. -<p><DD><CODE>data</CODE> - the primary data +<p></dd><dd><code>data</code> - the primary data returned as output. Its byte array does not need to be initialized by the caller. -<p><DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. -<p> -<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is -found; <A HREF="../../../com/sleepycat/db/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="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. -<p> +<p></dd><dd><code>lockMode</code> - the locking attributes; if null, default attributes are used. +<p></dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is +found; <a href="../../../com/sleepycat/db/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="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>. <p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. -<p> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getSearchBoth(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> -getSearchBoth</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchBoth</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Retrieves the key/data pair with the specified secondary and primary key, that +<p></dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getSearchBoth(com.sleepycat.db.Transaction, 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>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBoth(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Retrieves the key/data pair with the specified secondary and primary key, that is, both the primary and secondary key items must match. -<p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>txn</CODE> - For a transactional database, an explicit transaction may be specified to +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - For a transactional database, an explicit transaction may be specified to transaction-protect the operation, or null may be specified to perform the operation without transaction protection. For a non-transactional database, -null must be specified.<DD><CODE>key</CODE> - the secondary key +null must be specified.</dd><dd><code>key</code> - the secondary key used as input. It must be initialized with a non-null byte array by the -caller.<DD><CODE>pKey</CODE> - the primary key +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><CODE>data</CODE> - the primary data +caller.</dd><dd><code>data</code> - the primary data returned as output. Its byte array does not need to be initialized by the caller. -<p><DD><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. +<p></dd><dd><code>lockMode</code> - the locking attributes; if null, default attributes are used. +<p></dd> +<dt><span class="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is +found; <a href="../../../com/sleepycat/db/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="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>. <p> -<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is -found; <A HREF="../../../com/sleepycat/db/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="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. -<p> -<p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. -<p> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getSearchRecordNumber(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><!-- --></A><H3> -getSearchRecordNumber</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</A> <B>getSearchRecordNumber</B>(<A HREF="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</A> txn, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> key, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> pKey, - <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> data, - <A HREF="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</A> lockMode) - throws <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></PRE> -<DL> -<DD>Retrieves the key/data pair associated with the specific numbered record of the database. +<p></dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getSearchRecordNumber(com.sleepycat.db.Transaction, 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>public <a href="../../../com/sleepycat/db/OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchRecordNumber(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> pKey, + <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data, + <a href="../../../com/sleepycat/db/LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode) + throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre> +<div class="block">Retrieves the key/data pair associated with the specific numbered record of the database. <p> The data field of the specified key must be a byte array containing a -record number, as described in <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><CODE>DatabaseEntry</CODE></A>. This determines +record number, as described in <a href="../../../com/sleepycat/db/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. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>key</CODE> - the secondary key +unchanged.</div> +<dl><dt><span class="strong">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><CODE>pKey</CODE> - the primary key +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><CODE>data</CODE> - the primary data +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="../../../com/sleepycat/db/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><CODE>lockMode</CODE> - the locking attributes; if null, default attributes are used. -<DT><B>Returns:</B><DD><A HREF="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><CODE>OperationStatus.NOTFOUND</CODE></A> if no matching key/data pair is -found; <A HREF="../../../com/sleepycat/db/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="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><CODE>OperationStatus.SUCCESS</CODE></A>. -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if a DatabaseEntry parameter is null or +that is a subclass of <a href="../../../com/sleepycat/db/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="strong">Returns:</span></dt><dd><a href="../../../com/sleepycat/db/OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is +found; <a href="../../../com/sleepycat/db/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="../../../com/sleepycat/db/OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd> +<dt><span class="strong">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><CODE><A HREF="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</A></CODE> - if the operation was selected to resolve a +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a deadlock. -<p> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if an invalid parameter was specified. -<p> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs. -<p></DL> -</DD> -</DL> +<p></dd> +<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified. +<p></dd> +<dd><code><a href="../../../com/sleepycat/db/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 ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SecondaryDatabase.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/SecondaryDatabase.html" target="_top"><B>FRAMES</B></A> - <A HREF="SecondaryDatabase.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/SecondaryDatabase.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/SecondaryCursor.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/SecondaryKeyCreator.html" title="interface in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/SecondaryDatabase.html" target="_top">Frames</a></li> +<li><a href="SecondaryDatabase.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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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>Field | </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 ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |