Berkeley DB: txn_discard
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++

# txn_discard |

`

###

    #include <db.h>

    int
    txn_discard(DB_TXN *tid, u_int32_t flags);

# Description

The txn_discard function frees up all the per-process resources associated with the specified DB_TXN handle, neither committing nor aborting the transaction. This call may be used only after calls to txn_recover when there are multiple global transaction managers recovering transactions in a single Berkeley DB environment. Any transactions returned by txn_recover that are not handled by the current global transaction manager should be discarded using txn_discard.

The flags parameter is currently unused, and must be set to 0.

The txn_discard function returns EINVAL if the transaction handle does not refer to a transaction that was recovered into a prepared but not yet completed state.

Otherwise, the txn_discard function returns a non-zero error value on failure and 0 on success.

After txn_discard has been called, regardless of its return, the DB_TXN handle may not be accessed again.

# Errors

The txn_discard function may fail and return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  The transaction handle does not refer to a transaction that was recovered into a prepared but not yet completed state.

The txn_discard function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the txn_discard function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# See Also

DB_ENV->set_tx_max, DB_ENV->set_tx_recover, DB_ENV->set_tx_timestamp, txn_abort, txn_begin, txn_checkpoint, txn_commit, txn_discard, txn_id, txn_prepare, txn_recover, and txn_stat.`

Copyright Sleepycat Software