Berkeley DB: DBcursor->del
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++

DBcursor->del |

`

    #include <db.h>

    int
    DBcursor->del(DBC *DBcursor, u_int32_t flags);

Description: DBcursor->del

The DBcursor->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 DBcursor->del method will return DB_KEYEMPTY if the element has already been deleted. Unless otherwise specified, the DBcursor->del method returns a non-zero error value on failure and 0 on success.

Parameters
flags

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

Errors

The DBcursor->del method may fail and return one of the following non-zero errors:

DB_LOCK_DEADLOCK

- A transactional database environment operation was selected to resolve a deadlock.

DB_LOCK_NOTGRANTED

- A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time.

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 DB_ENV->open.

Class DBC
See Also Database Cursors and Related Methods`

Copyright (c) 1996,2008 Oracle. All rights reserved.