env_set_cachesize.html [plain text]
<!--$Id: env_set_cachesize.html,v 1.1.1.1 2003/02/15 04:55:51 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv.set_cachesize</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 width="100%"><tr valign=top>
<td>
<h1>DbEnv.set_cachesize</h1>
</td>
<td align=right>
<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>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public int set_cachesize(int gbytes, int bytes, in ncache)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>Set the size of the shared memory buffer pool -- that is, the cache --
to <b>gbytes</b> gigabytes plus <b>bytes</b>. The cache should be
the size of the normal working data set of the application, with some
small amount of additional memory for unusual situations. (Note: the
working set is not the same as the number of pages accessed
simultaneously, and should be quite a bit larger!)
<p>The default cache size is 256KB, and may not be specified as less than
20KB. Any cache size less than 500MB is automatically increased by 25%
to account for buffer pool overhead; cache sizes larger than 500MB are
used as specified. The current maximum size of a single cache is 4GB.
For information on tuning the Berkeley DB cache size, see
<a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>.
<p>It is possible to specify caches to Berkeley DB that are large enough so that
they cannot be allocated contiguously on some architectures. For
example, some releases of Solaris limit the amount of memory that may
be allocated contiguously by a process. If <b>ncache</b> is 0 or 1,
the cache will be allocated contiguously in memory. If it is greater
than 1, the cache will be broken up into <b>ncache</b> equally sized,
separate pieces of memory.
<p>The DbEnv.set_cachesize method configures a database environment, not only operations
performed using the specified <a href="../api_java/env_class.html">DbEnv</a> handle.
<p>The DbEnv.set_cachesize interface may not be called after the <a href="../api_java/env_open.html">DbEnv.open</a>
interface is called.
If the database environment already exists when
<a href="../api_java/env_open.html">DbEnv.open</a> is called, the information specified to DbEnv.set_cachesize
will be ignored.
<p>The DbEnv.set_cachesize method throws an exception that encapsulates a non-zero error value on
failure.
<p>The database environment's cache size may also be set using the environment's
<b>DB_CONFIG</b> file. The syntax of the entry in that file is a
single line with the string "set_cachesize", one or more whitespace characters,
and the three arguments specified to this interface, separated by whitespace
characters, for example, "set_cachesize 1 500 2". Because the <b>DB_CONFIG</b> file is read when the database
environment is opened, it will silently overrule configuration done
before that time.
<h1>Errors</h1>
<p>The DbEnv.set_cachesize method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>The specified cache size was impossibly small.
<p>Called after
<a href="../api_java/env_open.html">DbEnv.open</a>
was called.
</dl>
<p>The DbEnv.set_cachesize method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the DbEnv.set_cachesize method may fail and
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_java/env_class.html">DbEnv</a>
<h1>See Also</h1>
<a href="../api_java/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>