← Back to branch summary

~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_c/db_set_bt_minkey.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
Import upstream version 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
db/docs/api_c/db_set_bt_minkey.html
 
1
<!--$Id: db_set_bt_minkey.so,v 10.18 2001/06/18 20:12:22 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: DB-&gt;set_bt_minkey</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>DB-&gt;set_bt_minkey</h1>
 
15
</td>
 
16
<td align=right>
 
17
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
#include &lt;db.h&gt;
 
23
<p>
 
24
int
 
25
DB-&gt;set_bt_minkey(DB *db, u_int32_t bt_minkey);
 
26
</pre></h3>
 
27
<h1>Description</h1>
 
28
<p>Set the minimum number of key/data pairs intended to be stored on any
 
29
single Btree leaf page.
 
30
<p>This value is used to determine if key or data items will be stored on
 
31
overflow pages instead of Btree leaf pages.  For more information on
 
32
the specific algorithm used, see <a href="../ref/am_conf/bt_minkey.html">Minimum keys per page</a>.  The <b>bt_minkey</b> value specified must
 
33
be at least 2; if <b>bt_minkey</b> is not explicitly set, a value of
 
34
2 is used.
 
35
<p>The DB-&gt;set_bt_minkey interface may be used only to configure Berkeley DB before
 
36
the <a href="../api_c/db_open.html">DB-&gt;open</a> interface is called.
 
37
<p>The DB-&gt;set_bt_minkey function returns a non-zero error value on failure and 0 on success.
 
38
<h1>Errors</h1>
 
39
<p>The DB-&gt;set_bt_minkey function may fail and return a non-zero error for the following conditions:
 
40
<p><dl compact>
 
41
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
 
42
<p>Called after <a href="../api_c/db_open.html">DB-&gt;open</a> was called.
 
43
</dl>
 
44
<p>The DB-&gt;set_bt_minkey function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
 
45
If a catastrophic error has occurred, the DB-&gt;set_bt_minkey function may fail and return
 
46
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
 
47
in the same way.
 
48
<h1>See Also</h1>
 
49
<a href="../api_c/db_create.html">db_create</a>,
 
50
<a href="../api_c/db_associate.html">DB-&gt;associate</a>,
 
51
<a href="../api_c/db_close.html">DB-&gt;close</a>,
 
52
<a href="../api_c/db_cursor.html">DB-&gt;cursor</a>,
 
53
<a href="../api_c/db_del.html">DB-&gt;del</a>,
 
54
<a href="../api_c/db_err.html">DB-&gt;err</a>, <a href="../api_c/db_err.html">DB-&gt;errx</a>
 
55
<a href="../api_c/db_fd.html">DB-&gt;fd</a>,
 
56
<a href="../api_c/db_get.html">DB-&gt;get</a>,
 
57
<a href="../api_c/db_get.html">DB-&gt;pget</a>,
 
58
<a href="../api_c/db_get_byteswapped.html">DB-&gt;get_byteswapped</a>,
 
59
<a href="../api_c/db_get_type.html">DB-&gt;get_type</a>,
 
60
<a href="../api_c/db_join.html">DB-&gt;join</a>,
 
61
<a href="../api_c/db_key_range.html">DB-&gt;key_range</a>,
 
62
<a href="../api_c/db_open.html">DB-&gt;open</a>,
 
63
<a href="../api_c/db_put.html">DB-&gt;put</a>,
 
64
<a href="../api_c/db_remove.html">DB-&gt;remove</a>,
 
65
<a href="../api_c/db_rename.html">DB-&gt;rename</a>,
 
66
<a href="../api_c/db_set_alloc.html">DB-&gt;set_alloc</a>,
 
67
<a href="../api_c/db_set_append_recno.html">DB-&gt;set_append_recno</a>,
 
68
<a href="../api_c/db_set_bt_compare.html">DB-&gt;set_bt_compare</a>,
 
69
<a href="../api_c/db_set_bt_minkey.html">DB-&gt;set_bt_minkey</a>,
 
70
<a href="../api_c/db_set_bt_prefix.html">DB-&gt;set_bt_prefix</a>,
 
71
<a href="../api_c/db_set_cachesize.html">DB-&gt;set_cachesize</a>,
 
72
<a href="../api_c/db_set_dup_compare.html">DB-&gt;set_dup_compare</a>,
 
73
<a href="../api_c/db_set_errcall.html">DB-&gt;set_errcall</a>,
 
74
<a href="../api_c/db_set_errfile.html">DB-&gt;set_errfile</a>,
 
75
<a href="../api_c/db_set_errpfx.html">DB-&gt;set_errpfx</a>,
 
76
<a href="../api_c/db_set_feedback.html">DB-&gt;set_feedback</a>,
 
77
<a href="../api_c/db_set_flags.html">DB-&gt;set_flags</a>,
 
78
<a href="../api_c/db_set_h_ffactor.html">DB-&gt;set_h_ffactor</a>,
 
79
<a href="../api_c/db_set_h_hash.html">DB-&gt;set_h_hash</a>,
 
80
<a href="../api_c/db_set_h_nelem.html">DB-&gt;set_h_nelem</a>,
 
81
<a href="../api_c/db_set_lorder.html">DB-&gt;set_lorder</a>,
 
82
<a href="../api_c/db_set_pagesize.html">DB-&gt;set_pagesize</a>,
 
83
<a href="../api_c/db_set_paniccall.html">DB-&gt;set_paniccall</a>,
 
84
<a href="../api_c/db_set_q_extentsize.html">DB-&gt;set_q_extentsize</a>,
 
85
<a href="../api_c/db_set_re_delim.html">DB-&gt;set_re_delim</a>,
 
86
<a href="../api_c/db_set_re_len.html">DB-&gt;set_re_len</a>,
 
87
<a href="../api_c/db_set_re_pad.html">DB-&gt;set_re_pad</a>,
 
88
<a href="../api_c/db_set_re_source.html">DB-&gt;set_re_source</a>,
 
89
<a href="../api_c/db_stat.html">DB-&gt;stat</a>,
 
90
<a href="../api_c/db_sync.html">DB-&gt;sync</a>,
 
91
<a href="../api_c/db_truncate.html">DB-&gt;truncate</a>,
 
92
<a href="../api_c/db_upgrade.html">DB-&gt;upgrade</a>,
 
93
and
 
94
<a href="../api_c/db_verify.html">DB-&gt;verify</a>.
 
95
</tt>
 
96
<table width="100%"><tr><td><br></td><td align=right>
 
97
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
98
</td></tr></table>
 
99
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
100
</body>
 
101
</html>