txn_recover.html   [plain text]


<!--$Id: txn_recover.html,v 1.1 2003/02/15 04:55:55 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.txn_recover</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.txn_recover</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 DbPreplist[] txn_recover(int count, int flags)
    throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The DbEnv.txn_recover interface returns a list of prepared but not
yet resolved transactions.  The DbEnv.txn_recover method should only be
called after the environment has been recovered.  Because database
environment state must be preserved between recovery and the application
calling DbEnv.txn_recover, applications must either call
DbEnv.txn_recover using the same environment handle used when recovery
is done, or the database environment must not be configured using the
<a href="../api_java/env_open.html#DB_PRIVATE">Db.DB_PRIVATE</a> flag.
<p>The DbEnv.txn_recover method returns a list of transactions that must be
resolved by the application (committed, aborted or discarded).  The
return value is an array of objects of type DbPreplist; the following
DbPreplist fields will be filled in:
<p><dl compact>
<p><dt>public DbTxn txn;<dd>The transaction handle for the transaction.
<p><dt>public byte[] gid;<dd>The global transaction ID for the transaction.  The global transaction
ID is the one specified when the transaction was prepared.  The
application is responsible for ensuring uniqueness among global
transaction IDs.
</dl>
<p>The application must call <a href="../api_java/txn_abort.html">DbTxn.abort</a>, <a href="../api_java/txn_commit.html">DbTxn.commit</a> or
<a href="../api_java/txn_discard.html">DbTxn.discard</a> on each returned <a href="../api_java/txn_class.html">DbTxn</a> handle before
starting any new operations.
<p>The <b>count</b> parameter specifies the number of maximum size of the
array that should be returned.
<p>The <b>flags</b> value must be set to one of the following values:
<p><dl compact>
<p><dt><a name="Db.DB_FIRST">Db.DB_FIRST</a><dd>Begin returning a list of prepared, but not yet resolved transactions.
<p><dt><a name="Db.DB_NEXT">Db.DB_NEXT</a><dd>Continue returning a list of prepared, but not yet resolved transactions,
starting where the last call to DbEnv.txn_recover left off.
</dl>
<p>The DbEnv.txn_recover method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The DbEnv.txn_recover 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.txn_recover 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>