Whole document tree

Whole document tree

Berkeley DB: DB->set_bt_prefix



#include <db.h>

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


Set the Btree prefix function. The prefix function must return the number of bytes of the second key argument that would be required by the Btree key comparison function to determine the second key argument's ordering relationship with respect to the first key argument. If the two keys are equal, the key length should be returned. The prefix 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 determination.

The prefix 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 comparison 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 no prefix function or key comparison function is specified by the application, a default lexical comparison function is used as the prefix function. If no prefix function is specified and a key comparison function is specified, no prefix function is used. It is an error to specify a prefix function without also specifying a key comparison function.

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.


An invalid flag value or parameter was specified.

Called after DB->open was called.

See Also

db_create, DB->close, DB->cursor, DB->del, DB->err, DB->fd, DB->get, DB->get_byteswapped, DB->get_type, DB->join, DB->key_range, DB->open, DB->put, DB->remove, DB->set_bt_compare, DB->set_bt_minkey, DB->set_bt_prefix, DB->set_cachesize, DB->set_dup_compare, DB->set_errcall, DB->set_errfile, DB->set_errpfx, DB->set_flags, DB->set_h_ffactor, DB->set_h_hash, DB->set_h_nelem, DB->set_lorder, DB->set_malloc, DB->set_pagesize, DB->set_paniccall, DB->set_q_extentsize, DB->set_realloc, DB->set_re_delim, DB->set_re_len, DB->set_re_pad, DB->set_re_source, DB->stat, DB->sync, DB->upgrade and DB->verify.


Copyright Sleepycat Software