<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Db::set_bt_minkey()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="db.html" title="Chapter 2. The Db Handle" />
<link rel="prev" href="dbset_bt_compress.html" title="Db::set_bt_compress()" />
<link rel="next" href="dbset_bt_prefix.html" title="Db::set_bt_prefix()" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Db::set_bt_minkey()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbset_bt_compress.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2.
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbset_bt_prefix.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="dbset_bt_minkey"></a>Db::set_bt_minkey()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
Db::set_bt_minkey(u_int32_t bt_minkey);</pre>
<p>
Set the minimum number of key/data pairs intended to be stored on any
single Btree leaf page.
</p>
<p>
This value is used to determine if key or data items will be stored on
overflow pages instead of Btree leaf pages. For more information on
the specific algorithm used, see <a href="../../programmer_reference/bt_conf.html#am_conf_bt_minkey" class="olink">Minimum keys per page</a>.
The <span class="bold"><strong>bt_minkey</strong></span> value specified must be
at least 2; if <span class="bold"><strong>bt_minkey</strong></span> is not
explicitly set, a value of 2 is used.
</p>
<p>
The <code class="methodname">Db::set_bt_minkey()</code> method configures a database, not only
operations performed using the specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
handle.
</p>
<p>
The <code class="methodname">Db::set_bt_minkey()</code> method may not be called after the
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> method is called. If
the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the information specified to <code class="methodname">Db::set_bt_minkey()</code> will be ignored.
</p>
<p>
The <code class="methodname">Db::set_bt_minkey()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1644490"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id1644487"></a>bt_minkey</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>bt_minkey</strong></span> parameter is the
minimum number of key/data pairs intended to be stored on any single
Btree leaf page.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1644621"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">Db::set_bt_minkey()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id1644498"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the method was called after <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
was called; or if an invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1644493"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1644363"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbset_bt_compress.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbset_bt_prefix.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::set_bt_compress() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::set_bt_prefix()</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
a00abf5f94bf470fd4cc9e10b2d135e0
>
files
>
482
