Whole document tree

Whole document tree

Berkeley DB: DB->del



#include <db.h>

int DB->del(DB *db, DB_TXN *txnid, DBT *key, u_int32_t flags);


The DB->del function removes key/data pairs from the database. The key/data pair associated with the specified key is discarded from the database. In the presence of duplicate key values, all records associated with the designated key will be discarded.

If the file is being accessed under transaction protection, the txnid parameter is a transaction ID returned from txn_begin, otherwise, NULL.

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

The DB->del function returns a non-zero error value on failure, 0 on success, and DB_NOTFOUND if the specified key did not exist in the file.


The DB->del function may fail and return a non-zero error for the following conditions:

The operation was selected to resolve a deadlock.

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

An invalid flag value or parameter was specified.

The DB->del function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DB->del function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

See Also

db_create, DB->close, DB->cursor, DB->del, DB->err, DB->fd, DB->get, DB->get_byteswapped, DB->get_type, DB->join, DB->key_range, DB->open, DB->put, DB->remove, DB->set_bt_compare, DB->set_bt_minkey, DB->set_bt_prefix, DB->set_cachesize, DB->set_dup_compare, DB->set_errcall, DB->set_errfile, DB->set_errpfx, DB->set_flags, DB->set_h_ffactor, DB->set_h_hash, DB->set_h_nelem, DB->set_lorder, DB->set_malloc, DB->set_pagesize, DB->set_paniccall, DB->set_q_extentsize, DB->set_realloc, DB->set_re_delim, DB->set_re_len, DB->set_re_pad, DB->set_re_source, DB->stat, DB->sync, DB->upgrade and DB->verify.


Copyright Sleepycat Software