# Db.cursor |

`

###

    import com.sleepycat.db.*;

    public Dbc cursor(DbTxn txnid, int flags)
    	throws DbException;

# Description

The Db.cursor method creates a cursor.

A cursor is a structure used to provide sequential access through a database. This interface and its associated functions replaces the functionality provided by the seq function in previous releases of Berkeley DB.

If the file is being accessed under transaction protection, the txnid parameter is a transaction ID returned from DbEnv.txn_begin, otherwise, NULL. If transaction protection is enabled, 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.

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

DB_WRITECURSOR
  Specify that the cursor will be used to update the database. This flag should only be set when the Db.DB_INIT_CDB flag was specified to DbEnv.open.

The Db.cursor method throws an exception that encapsulates a non-zero error value on failure.

# Errors

If a fatal error occurs in Berkeley DB, the Db.cursor method will fail and throw a DbRunRecoveryException, at which point all subsequent database calls will fail in the same way.

In addition, the Db.cursor method may fail and throw an exception encapsulating a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

In addition, the Db.cursor method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.

### Class

Db

# See Also

Db.close, Db.cursor, Db.del, Db.fd, Db.get, Db.get_byteswapped, Db.get_type, Db.join, Db.open, Db.put, Db.remove, Db.set_bt_minkey, Db.set_cachesize, Db.set_errcall, Db.set_errpfx, Db.set_flags, Db.set_h_ffactor, Db.set_h_nelem, Db.set_lorder, Db.set_pagesize, Db.set_re_delim, Db.set_re_len, Db.set_re_pad, Db.set_re_source, Db.stat, Db.sync and Db.upgrade.`

Copyright Sleepycat Software