Berkeley DB: DbEnv::set_cachesize
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# DbEnv::set_cachesize |

`

###

    #include <db_cxx.h>

    int
    DbEnv::set_cachesize(u_int32_t gbytes, u_int32_t bytes, int ncache);

# Description

Set the size of the database's shared memory buffer pool, i.e., the cache, to gbytes gigabytes plus bytes. 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 simultaneously referenced pages, and should be quite a bit larger!)

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. For information on tuning the Berkeley DB cache size, see Selecting a cache size.

It is possible to specify caches to Berkeley DB that are large enough so that they cannot be allocated contiguously on some architectures, e.g., some releases of Solaris limit the amount of memory that may be allocated contiguously by a process. If ncache 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 ncache equally sized separate pieces of memory.

The DbEnv::set_cachesize interface may only be used to configure Berkeley DB before the DbEnv::open interface is called.

The DbEnv::set_cachesize 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.

The environment's cache size may also be set using the environment's DB_CONFIG 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". Configuration in the DB_CONFIG file silently overrules configuration done using the DbEnv::set_cachesize method.

# Errors

EINVAL
  An invalid flag value or parameter was specified.

  Called after DbEnv::open was called.

  The specified cache size was impossibly small.

### Class

DbEnv

# See Also

DbEnv::close, DbEnv::open, DbEnv::remove, DbEnv::err, DbEnv::strerror, DbEnv::version, DbEnv::set_cachesize, DbEnv::set_errcall, DbEnv::set_errfile, DbEnv::set_error_stream, DbEnv::set_errpfx, DbEnv::set_paniccall, and DbEnv::set_verbose.`

Copyright Sleepycat Software