txn_abort.html   [plain text]


<!--$Id: txn_abort.html,v 1.1.1.1 2003/02/15 04:55:54 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbTxn.abort</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>DbTxn.abort</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 abort()
    throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The DbTxn.abort method causes an abnormal termination of the transaction.
The log is played backward, and any necessary recovery operations are
initiated through the <b>recover</b> function specified to
<a href="../api_java/env_open.html">DbEnv.open</a>.  After the log processing is completed, all locks
held by the transaction are released.  As is the case for
<a href="../api_java/txn_commit.html">DbTxn.commit</a>, applications that require strict two-phase locking
should not explicitly release any locks.
<p>In the case of nested transactions, aborting a parent transaction causes
all children (unresolved or not) of the parent transaction to be aborted.
<p>All cursors opened within the transaction must be closed before the
transaction is aborted.
<p>After DbTxn.abort has been called, regardless of its return, the
<a href="../api_java/txn_class.html">DbTxn</a> handle may not be accessed again.
<p>The DbTxn.abort method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The DbTxn.abort 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 DbTxn.abort 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>