#include <db.h>

int
DB->set_bt_prefix(DB *db,
    size_t (*bt_prefix_fcn)(const DBT *, const DBT *));

Description

Set the Btree prefix comparison function. The bt_prefix_fcn function must return the number of bytes of the second key argument that are necessary to determine that it is greater than the first key argument. If the keys are equal, the key length should be returned. The prefix comparison function must correctly handle any key values used by the application (possibly including zero-length keys). The data and size fields of the DBT are the only fields that may be used for the purposes of this comparison.

This function is used to determine the amount by which keys stored on the btree internal pages can be safely truncated without losing their uniqueness. See the Btree prefix function section of the Reference Guide for more details about how this works. The usefulness of this is data dependent, but in some data sets can produce significantly reduced tree sizes and search times.

If bt_prefix is not explicitly set, and no key comparison method is specified, a default lexical comparison method is used. If bt_prefix is not explicitly set and a key comparison method is specified, no prefix comparison is done. It is an error to set bt_prefix without also specifying a key comparison method.

The DB->set_bt_prefix interface may only be used to configure Berkeley DB before the DB->open interface is called.

The DB->set_bt_prefix function returns a non-zero error value on failure and 0 on success.

Errors

EINVAL

An invalid flag value or parameter was specified.

Called after DB->open was called.

See Also