<?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_ENV->set_cache_max()</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="memp.html" title="Chapter 8. The DB_MPOOLFILE Handle" />
<link rel="prev" href="memptrickle.html" title="DB_ENV->memp_trickle()" />
<link rel="next" href="envset_cachesize.html" title="DB_ENV->set_cachesize()" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV->set_cache_max()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="memptrickle.html">Prev</a> </td>
<th width="60%" align="center">Chapter 8.
The DB_MPOOLFILE Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envset_cachesize.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="envset_cache_max"></a>DB_ENV->set_cache_max()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
int
DB_ENV->set_cache_max(DB_ENV *dbenv, u_int32_t gbytes, u_int32_t bytes); </pre>
<p>
The <code class="methodname">DB_ENV->set_cache_max()</code> method sets the maximum cache size, in
bytes. The specified size is rounded to the nearest multiple of the
cache region size, which is the initial cache size divided by the
number of regions specified to the
<a class="xref" href="envset_cachesize.html" title="DB_ENV->set_cachesize()">DB_ENV->set_cachesize()</a>
method. If no value is specified, it defaults to the initial cache
size.
</p>
<p>
The database environment's maximum cache size may also be configured using the
environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file. The
syntax of the entry in that file is a single line with the string "set_cache_max", one or
more whitespace characters, and the size in bytes. Because the
<a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is read when the
database environment is opened, it will silently overrule configuration done before that
time.
</p>
<p>
The <code class="methodname">DB_ENV->set_cache_max()</code> method configures a database environment,
not only operations performed using the specified
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> handle.
</p>
<p>
The <code class="methodname">DB_ENV->set_cache_max()</code> method may be called at any time during
the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV->set_cache_max()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1687687"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id1688170"></a>bytes</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>bytes</strong></span> parameter specifies the number of
bytes which, when added to the <span class="bold"><strong>gbytes</strong></span>
parameter, specifies the maximum size of the cache.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id1688317"></a>gbytes</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>gbytes</strong></span> parameter specifies the number of
bytes which, when added to the <span class="bold"><strong>bytes</strong></span>
parameter, specifies the maximum size of the cache.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1688340"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV->set_cache_max()</code> <span>
<span>
method may fail and 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="id1688097"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
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="id1688088"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id1687405"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments 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="memptrickle.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="memp.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envset_cachesize.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV->memp_trickle() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV->set_cachesize()</td>
</tr>
</table>
</div>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
a00abf5f94bf470fd4cc9e10b2d135e0
>
files
>
214
