env_set_tx_max.html [plain text]
<!--$Id: env_set_tx_max.html,v 1.1.1.1 2003/02/15 04:55:52 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_tx_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_tx_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_tx_max(int tx_max)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>Set the maximum number of active transactions that are supported by the
environment. This value bounds the size of backing shared memory regions.
Note that child transactions must be counted as active until their
ultimate parent commits or aborts.
<p>When there are more than the specified number of concurrent transactions,
calls to <a href="../api_java/txn_begin.html">DbEnv.txn_begin</a> will fail (until some active transactions
complete). If no value is specified, a default value of 20 is used.
<p>The DbEnv.set_tx_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_tx_max 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_tx_max
will be ignored.
<p>The DbEnv.set_tx_max method throws an exception that encapsulates a non-zero error value on
failure.
<p>The database environment's maximum number of active transactions 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_tx_max", one or more whitespace characters,
and the number of transactions. 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_tx_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.
</dl>
<p>The DbEnv.set_tx_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_tx_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/txn_class.html">DbTxn</a>
<h1>See Also</h1>
<a href="../api_java/txn_list.html">Transaction 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>