← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_java/db_set_bt_prefix.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_java/db_set_bt_prefix.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: Db.set_bt_prefix</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>Db.set_bt_prefix</h1>
16
 
</td>
17
 
<td align=right>
18
 
<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>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
import com.sleepycat.db.*;
24
 
<p>
25
 
public interface DbBtreePrefix
26
 
{
27
 
    public abstract int bt_prefix(Db db, Dbt dbt1, Dbt dbt2);
28
 
}
29
 
public class Db
30
 
{
31
 
    public void set_bt_prefix(DbBtreePrefix bt_prefix)
32
 
        throws DbException;
33
 
    ...
34
 
}
35
 
</pre></h3>
36
 
<h1>Description</h1>
37
 
<p>Set the Btree prefix function.  The prefix function must return the
38
 
number of bytes of the second key argument that would be required by
39
 
the Btree key comparison function to determine the second key argument's
40
 
ordering relationship with respect to the first key argument.  If the
41
 
two keys are equal, the key length should be returned.  The prefix
42
 
function must correctly handle any key values used by the application
43
 
(possibly including zero-length keys).  The <b>data</b> and
44
 
<b>size</b> fields of the <a href="../api_java/dbt_class.html">Dbt</a> are the only fields that may be
45
 
used for the purposes of this determination, and no particular alignment
46
 
of the memory to which the <b>data</b> field refers may be assumed.
47
 
<p>The prefix function is used to determine the amount by which keys stored
48
 
on the Btree internal pages can be safely truncated without losing their
49
 
uniqueness.  See the <a href="../ref/am_conf/bt_prefix.html">Btree
50
 
prefix comparison</a> section of the Berkeley DB Reference Guide for more details
51
 
about how this works.  The usefulness of this is data-dependent, but
52
 
can produce significantly reduced tree sizes and search times in some
53
 
data sets.
54
 
<p>If no prefix function or key comparison function is specified by the
55
 
application, a default lexical comparison function is used as the prefix
56
 
function.  If no prefix function is specified and a key comparison
57
 
function is specified, no prefix function is used.  It is an error to
58
 
specify a prefix function without also specifying a key comparison
59
 
function.
60
 
<p>The Db.set_bt_prefix method configures operations performed using the specified
61
 
<a href="../api_java/db_class.html">Db</a> handle, not all operations performed on the underlying
62
 
database.
63
 
<p>The Db.set_bt_prefix interface may not be called after the <a href="../api_java/db_open.html">Db.open</a>
64
 
interface is called.
65
 
If the database already exists when
66
 
<a href="../api_java/db_open.html">Db.open</a> is called, the information specified to Db.set_bt_prefix must
67
 
be the same as that historically used to create the database or
68
 
corruption can occur.
69
 
<p>The Db.set_bt_prefix method throws an exception that encapsulates a non-zero error value on
70
 
failure.
71
 
<h1>Errors</h1>
72
 
<p>The Db.set_bt_prefix method may fail and throw an exception encapsulating a non-zero error for the following conditions:
73
 
<p><dl compact>
74
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
75
 
<p>Called after <a href="../api_java/db_open.html">Db.open</a> was called.
76
 
</dl>
77
 
<p>The Db.set_bt_prefix method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
78
 
If a catastrophic error has occurred, the Db.set_bt_prefix method may fail and
79
 
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
80
 
in which case all subsequent Berkeley DB calls will fail in the same way.
81
 
<h1>Class</h1>
82
 
<a href="../api_java/db_class.html">Db</a>
83
 
<h1>See Also</h1>
84
 
<a href="../api_java/db_list.html">Databases and Related Methods</a>
85
 
</tt>
86
 
<table width="100%"><tr><td><br></td><td align=right>
87
 
<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>
88
 
</td></tr></table>
89
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
90
 
</body>
91
 
</html>