db_set_pagesize.html [plain text]
<!--$Id: db_set_pagesize.so,v 10.40 2005/12/16 01:19:35 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db::set_pagesize</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b>Db::set_pagesize</b>
</td>
<td align=right>
<a href="../api_cxx/api_core.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>
<b><pre>
#include <db_cxx.h>
<p>
int
Db::set_pagesize(u_int32_t pagesize);
<p>
int
Db::get_pagesize(u_int32_t *pagesizep);
</pre></b>
<hr size=1 noshade>
<b>Description: Db::set_pagesize</b>
<p>Set the size of the pages used to hold items in the database, in bytes.
The minimum page size is 512 bytes, the maximum page size is 64K bytes,
and the page size must be a power-of-two. If the page size is not
explicitly set, one is selected based on the underlying filesystem I/O
block size. The automatically selected size has a lower limit of 512
bytes and an upper limit of 16K bytes.</p>
<p>For information on tuning the Berkeley DB page size, see
<a href="../ref/am_conf/pagesize.html">Selecting a page size</a>.</p>
<p>The Db::set_pagesize method configures a database, not only operations performed
using the specified <a href="../api_cxx/db_class.html">Db</a> handle.</p>
<p>The Db::set_pagesize method may not be called after the <a href="../api_cxx/db_open.html">Db::open</a> method is called.
If the database already exists when
<a href="../api_cxx/db_open.html">Db::open</a> is called, the information specified to Db::set_pagesize will
be ignored.
</p>
If creating additional databases in a single physical file, information
specified to Db::set_pagesize will be ignored and the page size
of the existing databases will be used.
<p>The Db::set_pagesize 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.
</p>
<b>Parameters</b> <br>
<b>pagesize</b><ul compact><li>The <b>pagesize</b> parameter sets the database page size.</ul>
<br>
<br><b>Errors</b>
<p>The Db::set_pagesize method
may fail and throw
<a href="../api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<br>
<b>EINVAL</b><ul compact><li>If the method was called after <a href="../api_cxx/db_open.html">Db::open</a> was called; or if an
invalid flag value or parameter was specified.</ul>
<br>
<hr size=1 noshade>
<b>Description: Db::get_pagesize</b>
<p>The Db::get_pagesize method returns the page size.</p>
<p>The Db::get_pagesize method may be called at any time during the life of the
application.</p>
<p>The Db::get_pagesize 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.
</p>
<b>Parameters</b> <br>
<b>pagesizep</b><ul compact><li>The Db::get_pagesize method returns the
page size in <b>pagesizep</b>.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_cxx/db_class.html">Db</a>
<br><b>See Also</b>
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.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>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
</body>
</html>