env_set_lg_max.html [plain text]
<!--$Id: env_set_lg_max.html,v 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_lg_max</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_lg_max</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 void set_lg_max(int lg_max)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>Set the maximum size of a single file in the log, in bytes. By default,
or if the <b>lg_max</b> argument is set to 0, a size of 10MB is used.
Because <a href="../api_java/lsn_class.html">DbLsn</a> file offsets are unsigned four-byte values, the
set value may not be larger than the maximum unsigned four-byte value.
The size of the log file must be at least four times the size of the
in-memory log buffer (see <a href="../api_java/env_set_lg_bsize.html">DbEnv.set_lg_bsize</a>).
<p>See <a href="../ref/log/limits.html">Log File Limits</a>
for more information.
<p>The DbEnv.set_lg_max 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_lg_max interface may be called at any time during the life of
the application.
If no size is specified by the application, the size last specified for
the database region will be used, or if no database region previously
existed, the default will be used.
<p>The DbEnv.set_lg_max method throws an exception that encapsulates a non-zero error value on
failure.
<p>The database environment's log file 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_lg_max", one or more whitespace characters,
and the size in bytes. 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_lg_max 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>Called after <a href="../api_java/env_open.html">DbEnv.open</a> was called.
<p>The size of the log file is less than four times the size of the in-memory
log buffer.
<p>The specified log file size was too large.
</dl>
<p>The DbEnv.set_lg_max 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_lg_max 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>, <a href="../api_java/logc_class.html">DbLogc</a>, <a href="../api_java/lsn_class.html">DbLsn</a>
<h1>See Also</h1>
<a href="../api_java/log_list.html">Logging Subsystem 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>