← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/env_set_cachesize.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_cxx/env_set_cachesize.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: DbEnv::set_cachesize</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>DbEnv::set_cachesize</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
int
26
 
DbEnv::set_cachesize(u_int32_t gbytes, u_int32_t bytes, int ncache);
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>Set the size of the shared memory buffer pool -- that is, the cache --
30
 
to <b>gbytes</b> gigabytes plus <b>bytes</b>.  The cache should be
31
 
the size of the normal working data set of the application, with some
32
 
small amount of additional memory for unusual situations.  (Note: the
33
 
working set is not the same as the number of pages accessed
34
 
simultaneously, and should be quite a bit larger!)
35
 
<p>The default cache size is 256KB, and may not be specified as less than
36
 
20KB.  Any cache size less than 500MB is automatically increased by 25%
37
 
to account for buffer pool overhead; cache sizes larger than 500MB are
38
 
used as specified.  The current maximum size of a single cache is 4GB.
39
 
For information on tuning the Berkeley DB cache size, see
40
 
<a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>.
41
 
<p>It is possible to specify caches to Berkeley DB that are large enough so that
42
 
they cannot be allocated contiguously on some architectures.  For
43
 
example, some releases of Solaris limit the amount of memory that may
44
 
be allocated contiguously by a process.  If <b>ncache</b> is 0 or 1,
45
 
the cache will be allocated contiguously in memory.  If it is greater
46
 
than 1, the cache will be broken up into <b>ncache</b> equally sized,
47
 
separate pieces of memory.
48
 
<p>The DbEnv::set_cachesize method configures a database environment, not only operations
49
 
performed using the specified <a href="../api_cxx/env_class.html">DbEnv</a> handle.
50
 
<p>The DbEnv::set_cachesize interface may not be called after the <a href="../api_cxx/env_open.html">DbEnv::open</a>
51
 
interface is called.
52
 
If the database environment already exists when
53
 
<a href="../api_cxx/env_open.html">DbEnv::open</a> is called, the information specified to DbEnv::set_cachesize
54
 
will be ignored.
55
 
<p>The DbEnv::set_cachesize method either returns a non-zero error value or throws an exception that
56
 
encapsulates a non-zero error value on failure, and returns 0 on success.
57
 
<p>The database environment's cache size may also be set using the environment's
58
 
<b>DB_CONFIG</b> file.  The syntax of the entry in that file is a
59
 
single line with the string "set_cachesize", one or more whitespace characters,
60
 
and the three arguments specified to this interface, separated by whitespace
61
 
characters, for example, "set_cachesize 1 500 2".  Because the <b>DB_CONFIG</b> file is read when the database
62
 
environment is opened, it will silently overrule configuration done
63
 
before that time.
64
 
<h1>Errors</h1>
65
 
<p>The DbEnv::set_cachesize method may fail and throw an exception or return a non-zero error for the following conditions:
66
 
<p><dl compact>
67
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
68
 
<p>The specified cache size was impossibly small.
69
 
<p>Called after
70
 
<a href="../api_cxx/env_open.html">DbEnv::open</a>
71
 
was called.
72
 
</dl>
73
 
<p>The DbEnv::set_cachesize method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.
74
 
If a catastrophic error has occurred, the DbEnv::set_cachesize method may fail and
75
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
76
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
77
 
in which case all subsequent Berkeley DB calls will fail in the same way.
78
 
<h1>Class</h1>
79
 
<a href="../api_cxx/env_class.html">DbEnv</a>
80
 
<h1>See Also</h1>
81
 
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
82
 
</tt>
83
 
<table width="100%"><tr><td><br></td><td align=right>
84
 
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
85
 
</td></tr></table>
86
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
87
 
</body>
88
 
</html>