|
|
Db::del |
#include <db_cxx.h>int Db::del(DbTxn *txnid, Dbt *key, u_int32_t flags);
The Db::del method 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.
When called 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 Db::del method will return DB_NOTFOUND if the specified key is not in the database. The Db::del method will return DB_KEYEMPTY if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted. Unless otherwise specified, the Db::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.
The Db::del method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:
If a transactional database environment operation was selected to resolve a deadlock, the Db::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 Db::del method will fail and either return DB_LOCK_NOTGRANTED or throw a DbLockNotGrantedException exception.
Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.