#include <db_cxx.h>

int
Dbc::del(u_int32_t flags);

Description: Dbc::del

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 cursor position is unchanged after a delete, and subsequent calls to cursor functions expecting the cursor to refer to an existing key will fail.

The Dbc::del method will return DB_KEYEMPTY if the element has already been deleted. Unless otherwise specified, the Dbc::del method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Parameters

flags

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

Errors

The Dbc::del method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

DB_REP_HANDLE_DEAD

The database handle has been invalidated because a replication election unrolled a committed transaction.

DB_REP_LOCKOUT

The operation was blocked by client/master synchronization.

DB_SECONDARY_BAD

A secondary index references a nonexistent primary key.

EACCES

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

EINVAL

If the cursor has not been initialized; or if an invalid flag value or parameter was specified.

EPERM

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

If a transactional database environment operation was selected to resolve a deadlock, the Dbc::del method will fail and either return DB_LOCK_DEADLOCK or throw a DbDeadlockException exception.

If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the Dbc::del method will fail and either return DB_LOCK_NOTGRANTED or throw a DbLockNotGrantedException exception.

Class

See Also