Berkeley DB: Dbc.del
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++

# Dbc.del |

`

###

    import com.sleepycat.db.*;

    public int del(int flags)
        throws DbException;

# Description

The Dbc.del method deletes the key/data pair to which the cursor refers.

When called on a cursor opened on a database that has been made into a secondary index using the Db.associate method, the Db.del method deletes the key/data pair from the primary database and all secondary indices.

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

The cursor position is unchanged after a delete, and subsequent calls to cursor functions expecting the cursor to refer to an existing key will fail.

If the element has already been deleted, the Dbc.del method will return Db.DB_KEYEMPTY. If the cursor is not yet initialized, the Dbc.del method throws an exception that encapsulates Db.EINVAL. Otherwise, the Dbc.del method throws an exception that encapsulates a non-zero error value on failure.

# Errors

The Dbc.del method may fail and throw an exception encapsulating a non-zero error for the following conditions:

Db.DB_SECONDARY_BAD
  A secondary index references a nonexistent primary key.

EACCES
  An attempt was made to modify a read-only database.

EINVAL
  An invalid flag value or parameter was specified.

EPERM
  Write attempted on read-only cursor when the Db.DB_INIT_CDB flag was specified to DbEnv.open.

If the operation was selected to resolve a deadlock, the Dbc.del method will fail and throw a DbDeadlockException exception.

The Dbc.del method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Dbc.del method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

Dbc

# See Also

Database Cursors and Related Methods`

Copyright Sleepycat Software