diff options
| author | unknown <tim@threads.polyesthetic.msg> | 2001-03-04 19:42:05 -0500 |
|---|---|---|
| committer | unknown <tim@threads.polyesthetic.msg> | 2001-03-04 19:42:05 -0500 |
| commit | ec6ae091617bdfdca9e65e8d3e65b950d234f676 (patch) | |
| tree | 9dd732e08dba156ee3d7635caedc0dc3107ecac6 /bdb/docs/api_java/db_set_bt_prefix.html | |
| parent | 87d70fb598105b64b538ff6b81eef9da626255b1 (diff) | |
| download | mariadb-git-ec6ae091617bdfdca9e65e8d3e65b950d234f676.tar.gz | |
Import changeset
Diffstat (limited to 'bdb/docs/api_java/db_set_bt_prefix.html')
| -rw-r--r-- | bdb/docs/api_java/db_set_bt_prefix.html | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/bdb/docs/api_java/db_set_bt_prefix.html b/bdb/docs/api_java/db_set_bt_prefix.html new file mode 100644 index 00000000000..a6e823969ca --- /dev/null +++ b/bdb/docs/api_java/db_set_bt_prefix.html @@ -0,0 +1,106 @@ +<!--$Id: db_set_bt_prefix.so,v 10.25 2000/09/08 21:35:26 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: Db.set_bt_prefix</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><tr valign=top> +<td> +<h1>Db.set_bt_prefix</h1> +</td> +<td width="1%"> +<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.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 DbBtreePrefix +{ + public abstract int bt_prefix(Db db, Dbt dbt1, Dbt dbt2); +} +public class Db +{ + public void set_bt_prefix(DbBtreePrefix bt_prefix) + throws DbException; + ... +} +</pre></h3> +<h1>Description</h1> +<p>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 <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 determination. +<p>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 <a href="../ref/am_conf/bt_prefix.html">Btree +prefix comparison</a> 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. +<p>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. +<p>The Db.set_bt_prefix interface may only be used to configure Berkeley DB before +the <a href="../api_java/db_open.html">Db.open</a> interface is called. +<p>The Db.set_bt_prefix method throws an exception that encapsulates a non-zero error value on +failure. +<h1>Errors</h1> +<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> +<h3>Class</h3> +<a href="../api_java/db_class.html">Db</a> +<h1>See Also</h1> +<a href="../api_java/db_close.html">Db.close</a>, +<a href="../api_java/db_cursor.html">Db.cursor</a>, +<a href="../api_java/db_del.html">Db.del</a>, +<a href="../api_java/db_fd.html">Db.fd</a>, +<a href="../api_java/db_get.html">Db.get</a>, +<a href="../api_java/db_get_byteswapped.html">Db.get_byteswapped</a>, +<a href="../api_java/db_get_type.html">Db.get_type</a>, +<a href="../api_java/db_join.html">Db.join</a>, +<a href="../api_java/db_key_range.html">Db.key_range</a>, +<a href="../api_java/db_open.html">Db.open</a>, +<a href="../api_java/db_put.html">Db.put</a>, +<a href="../api_java/db_remove.html">Db.remove</a>, +<a href="../api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a>, +<a href="../api_java/db_set_cachesize.html">Db.set_cachesize</a>, +<a href="../api_java/db_set_errcall.html">Db.set_errcall</a>, +<a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a>, +<a href="../api_java/db_set_flags.html">Db.set_flags</a>, +<a href="../api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a>, +<a href="../api_java/db_set_h_nelem.html">Db.set_h_nelem</a>, +<a href="../api_java/db_set_lorder.html">Db.set_lorder</a>, +<a href="../api_java/db_set_pagesize.html">Db.set_pagesize</a>, +<a href="../api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a>, +<a href="../api_java/db_set_re_delim.html">Db.set_re_delim</a>, +<a href="../api_java/db_set_re_len.html">Db.set_re_len</a>, +<a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a>, +<a href="../api_java/db_set_re_source.html">Db.set_re_source</a>, +<a href="../api_java/db_stat.html">Db.stat</a>, +<a href="../api_java/db_sync.html">Db.sync</a>, +<a href="../api_java/db_upgrade.html">Db.upgrade</a> +and +<a href="../api_java/db_verify.html">Db.verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.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> |