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)
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 Dbt representing the
application supplied key; the second is the current tree's key.
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 well-ordered. 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 Db.set_bt_prefix for more
information), the comparison routine may be passed a prefix of any
database key. The data and size fields of the
Dbt 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 data field refers may be assumed.
If no comparison function is specified, the keys are compared lexically,
with shorter keys collating before longer keys.
The Db.set_bt_compare method configures operations performed using the specified
Db handle, not all operations performed on the underlying
The Db.set_bt_compare interface may not be called after the Db.open
interface is called.
If the database already exists when
Db.open 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.
The Db.set_bt_compare method throws an exception that encapsulates a non-zero error value on
The Db.set_bt_compare method may fail and throw an exception encapsulating a non-zero error for the following conditions:
- An invalid flag value or parameter was specified.
Called after Db.open was called.
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 DbRunRecoveryException,
in which case all subsequent Berkeley DB calls will fail in the same way.
Databases and Related Methods
Copyright Sleepycat Software