DB->del(DB *db, DB_TXN *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
returns a non-zero error value on failure
and 0 on success.
- The flags parameter is currently unused, and must be set to 0.
- The key DBT operated on.
- If the operation is part of an application-specified
transaction, the txnid parameter is a transaction handle
returned from DB_ENV->txn_begin; otherwise NULL. If no transaction
handle is specified, but the
operation occurs in a transactional
the operation will be implicitly transaction protected.
The DB->del method
may fail and return one of the following non-zero errors:
- A transactional database environment operation was selected to resolve
- A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable
to grant a lock in the allowed time.
- The database handle has been invalidated because a replication election
unrolled a committed transaction.
- The operation was blocked by client/master synchronization.
- A secondary index references a nonexistent primary key.
- An attempt was made to modify a read-only database.
invalid flag value or parameter was specified.
Databases and Related Methods
Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.