Berkeley DB: txn_begin
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_begin |

`

###

    #include <db.h>

    int
    txn_begin(DB_ENV *env,
    	DB_TXN *parent, DB_TXN **tid, u_int32_t flags);

# Description

The txn_begin method creates a new transaction in the environment and copies a pointer to a DB_TXN that uniquely identifies it into the memory to which tid refers.

If the parent argument is non-NULL, the new transaction will be a nested transaction, with the transaction indicated by parent as its parent. Transactions may be nested to any level. In the presence of distributed transactions and two-phase commit, only the parental transaction, that is a transaction without a parent specified, should be passed as an argument to txn_prepare.

The flags value must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values:

DB_DIRTY_READ
  All read operations performed by the transaction will read modified but not yet committed data. Silently ignored if the DB_DIRTY_READ flag was not specified when the underlying database was opened.

DB_TXN_NOSYNC
  Do not synchronously flush the log when this transaction commits or prepares. This means the transaction will exhibit the ACI (atomicity, consistency, and isolation) properties, but not D (durability); that is, database integrity will be maintained but it is possible that this transaction may be undone during recovery.

  This behavior may be set for a Berkeley DB environment using the DB_ENV->set_flags interface. Any value specified in this interface overrides that setting.

DB_TXN_NOWAIT
  If a lock is unavailable for any Berkeley DB operation performed in the context of this transaction, return immediately instead of blocking on the lock. The error return in the case will be DB_LOCK_NOTGRANTED.

DB_TXN_SYNC
  Synchronously flush the log when this transaction commits or prepares. This means the transaction will exhibit all of the ACID (atomicity, consistency, isolation, and durability) properties.

  This behavior is the default for Berkeley DB environments unless the DB_TXN_NOSYNC flag was specified to the DB_ENV->set_flags interface. Any value specified in this interface overrides that setting.

Note: A transaction may not span threads; that is, each transaction must begin and end in the same thread, and each transaction may be used only by a single thread.

Note: Cursors may not span transactions; that is, each cursor must be opened and closed within a single transaction.

Note: A parent transaction may not issue any Berkeley DB operations -- except for txn_begin, txn_abort and txn_commit -- while it has active child transactions (child transactions that have not yet been committed or aborted).

The txn_begin function returns a non-zero error value on failure and 0 on success.

# Errors

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

ENOMEM
  The maximum number of concurrent transactions has been reached.

The txn_begin 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_begin 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