.. $Id: dbtxn.rst,v ada052aa83b3 2012/12/20 13:50:15 jcea $

=====
DBTxn
=====

Read :Oracle:`Oracle documentation <programmer_reference/index.html>`
for better understanding.

:OracleAPIC:`More info... <txn.html>`

DBTxn Methods
-------------

.. function:: abort()

   Aborts the transaction
   :OracleAPIC:`More info... <txnabort.html>`

.. function:: commit(flags=0)

   Ends the transaction, committing any changes to the databases.
   :OracleAPIC:`More info... <txncommit.html>`

.. function:: id()

   The txn_id function returns the unique transaction id associated with
   the specified transaction.
   :OracleAPIC:`More info... <txnid.html>`

.. function:: prepare(gid)

   Initiates the beginning of a two-phase commit. A global identifier
   parameter is required, which is a value unique across all processes
   involved in the commit. It must be a string of DB_GID_SIZE bytes.
   :OracleAPIC:`More info... <txnprepare.html>`

.. function:: discard()

   This method frees up all the per-process resources associated with
   the specified transaction, neither committing nor aborting the
   transaction. The transaction will be keep in "unresolved" state. This
   call may be used only after calls to "dbenv.txn_recover()". A
   "unresolved" transaction will be returned again thru new calls to
   "dbenv.txn_recover()".
   
   For example, when there are multiple global transaction managers
   recovering transactions in a single Berkeley DB environment, any
   transactions returned by "dbenv.txn_recover()" that are not handled
   by the current global transaction manager should be discarded using
   "txn.discard()".

   :OracleAPIC:`More info... <txndiscard.html>`

.. function:: set_timeout(timeout, flags)

   Sets timeout values for locks or transactions for the specified
   transaction.
   :OracleAPIC:`More info... <txnset_timeout.html>`

.. function:: get_name(name)

   Returns the string associated with the transaction.
   :OracleAPIC:`More info... <txnget_name.html>`

.. function:: set_name(name)

   Associates the specified string with the transaction.
   :OracleAPIC:`More info... <txnset_name.html>`

