<!--$Id: db_del.html,v 1.1.1.1 2003/02/15 04:55:50 zarzycki Exp $--> <!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Db.del</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h1>Db.del</h1> </td> <td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> import com.sleepycat.db.*; <p> public int del(DbTxn txnid, Dbt key, int flags) throws DbException; </pre></h3> <h1>Description</h1> <p>The Db.del method removes key/data pairs from the database. The key/data pair associated with the specified <b>key</b> is discarded from the database. In the presence of duplicate key values, all records associated with the designated key will be discarded. <p>When called on a database that has been made into a secondary index using the <a href="../api_java/db_associate.html">Db.associate</a> method, the Db.del method deletes the key/data pair from the primary database and all secondary indices. <p>If the operation is to be transaction-protected (other than by specifying the Db.DB_AUTO_COMMIT flag), the <b>txnid</b> parameter is a transaction handle returned from <a href="../api_java/txn_begin.html">DbEnv.txn_begin</a>; otherwise, null. <p>The <b>flags</b> value must be set to 0 or the following value: <p><dl compact> <p><dt><a name="Db.DB_AUTO_COMMIT">Db.DB_AUTO_COMMIT</a><dd>Enclose the Db.del call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. </dl> <p> If the specified key is not in the database, the Db.del method will return Db.DB_NOTFOUND. Otherwise, the Db.del method throws an exception that encapsulates a non-zero error value on failure. <h1>Errors</h1> <p>The Db.del method may fail and throw an exception encapsulating a non-zero error for the following conditions: <p><dl compact> <p><dt>Db.DB_SECONDARY_BAD<dd>A secondary index references a nonexistent primary key. </dl> <p><dl compact> <p><dt>EACCES<dd>An attempt was made to modify a read-only database. </dl> <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <p>If the operation was selected to resolve a deadlock, the Db.del method will fail and throw a <a href="../api_java/deadlock_class.html">DbDeadlockException</a> exception. <p>The Db.del method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Db.del method may fail and throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_java/db_class.html">Db</a> <h1>See Also</h1> <a href="../api_java/db_list.html">Databases and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> </html>