db_set_bt_compare.html [plain text]
<!--$Id: db_set_bt_compare.html,v 1.1 2003/02/15 04:55:50 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db.set_bt_compare</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>Db.set_bt_compare</h1>
</td>
<td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public interface DbBtreeCompare
{
public abstract int bt_compare(Db db, Dbt dbt1, Dbt dbt2);
}
public class Db
{
public void set_bt_compare(DbBtreeCompare bt_compare)
throws DbException;
...
}
</pre></h3>
<h1>Description</h1>
<p>Set the Btree key comparison function. The comparison function is
called when it is necessary to compare a key specified by the
application with a key currently stored in the tree. The first argument
to the comparison function is the <a href="../api_java/dbt_class.html">Dbt</a> representing the
application supplied key; the second is the current tree's key.
<p>The comparison function must return an integer value less than, equal
to, or greater than zero if the first key argument is considered to be
respectively less than, equal to, or greater than the second key
argument. In addition, the comparison function must cause the keys in
the database to be <i>well-ordered</i>. The comparison function
must correctly handle any key values used by the application (possibly
including zero-length keys). In addition, when Btree key prefix
comparison is being performed (see <a href="../api_java/db_set_bt_prefix.html">Db.set_bt_prefix</a> for more
information), the comparison routine may be passed a prefix of any
database key. The <b>data</b> and <b>size</b> fields of the
<a href="../api_java/dbt_class.html">Dbt</a> are the only fields that may be used for the purposes of
this comparison, and no particular alignment of the memory to which
by the <b>data</b> field refers may be assumed.
<p>If no comparison function is specified, the keys are compared lexically,
with shorter keys collating before longer keys.
<p>The Db.set_bt_compare method configures operations performed using the specified
<a href="../api_java/db_class.html">Db</a> handle, not all operations performed on the underlying
database.
<p>The Db.set_bt_compare interface may not be called after the <a href="../api_java/db_open.html">Db.open</a>
interface is called.
If the database already exists when
<a href="../api_java/db_open.html">Db.open</a> is called, the information specified to Db.set_bt_compare must
be the same as that historically used to create the database or
corruption can occur.
<p>The Db.set_bt_compare method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The Db.set_bt_compare method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>Called after <a href="../api_java/db_open.html">Db.open</a> was called.
</dl>
<p>The Db.set_bt_compare method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the Db.set_bt_compare method may fail and
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_java/db_class.html">Db</a>
<h1>See Also</h1>
<a href="../api_java/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>