Logo Search packages:      
Sourcecode: db4.2 version File versions  Download package

Dbc com::sleepycat::db::Db::cursor ( DbTxn  txnid,
int  flags 
) throws DbException [inline]

The Db.cursor method returns a created database cursor.

Parameters:
flags must be set to 0 or by bitwise inclusively OR 'ing together one or more of the following values:
  • Db.DB_DIRTY_READ

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

  • Db.DB_WRITECURSOR

    Specify that the cursor will be used to update the database. The underlying database environment must have been opened using the Db.DB_INIT_CDB flag.

Parameters:
txnid If the operation is to be transaction-protected, the txnid parameter is a transaction handle returned from DbEnv.txnBegin; otherwise, null. To transaction-protect cursor operations, cursors must be opened and closed within the context of a transaction, and the txnid parameter specifies the transaction context in which the cursor may be used.
Exceptions:
DbException The Db.cursor method may fail and throw DbException, encapsulating one of the following non-zero errors:
IllegalArgumentException The Db.cursor method will fail and throw a IllegalArgumentException exception if an invalid flag value or parameter was specified.
Returns:
The Db.cursor method throws an exception that encapsulates a non-zero error value on failure.

Definition at line 3338 of file Db.java.

Referenced by com::sleepycat::bdb::DataDb::openCursor().

                                                                 {
        long cPtr = db_javaJNI.Db_cursor(swigCPtr, DbTxn.getCPtr(txnid), flags);
        return (cPtr == 0) ? null : new Dbc(cPtr, false);
    }


Generated by  Doxygen 1.6.0   Back to index