1<!--$Id: env_dbremove.so,v 10.49 2004/12/16 19:13:01 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: DB_ENV->dbremove</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>DB_ENV->dbremove</b> 14</td> 15<td align=right> 16<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a> 17<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db.h> 23<p> 24int 25DB_ENV->dbremove(DB_ENV *dbenv, DB_TXN *txnid, 26 const char *file, const char *database, u_int32_t flags); 27</pre></b> 28<hr size=1 noshade> 29<b>Description: DB_ENV->dbremove</b> 30<p>The DB_ENV->dbremove method removes the database specified by the 31<b>file</b> and <b>database</b> parameters. If no <b>database</b> 32is specified, the underlying file represented by <b>file</b> is 33removed, incidentally removing all of the databases it contained.</p> 34<p>Applications should never remove databases with open <a href="/api_c/db_class.html">DB</a> handles, 35or in the case of removing a file, when any database in the file has an 36open handle. For example, some architectures do not permit the removal 37of files with open system handles. On these architectures, attempts to 38remove databases currently in use by any thread of control in the system 39may fail.</p> 40<p>The DB_ENV->dbremove method 41returns a non-zero error value on failure 42and 0 on success. 43</p> 44<b>Parameters</b> <br> 45 <b>database</b><ul compact><li>The <b>database</b> parameter is the database to be removed.</ul> 46 <b>file</b><ul compact><li>The <b>file</b> parameter is the physical file which contains the 47database(s) to be removed.</ul> 48<p>When using a Unicode build on Windows (the default), the <b>file</b> 49argument will be interpreted as a UTF-8 string, which is equivalent to 50ASCII for Latin characters.</p> 51 <b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or 52the following value: 53<br> 54<b><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a></b><ul compact><li>Enclose the DB_ENV->dbremove call within a transaction. If the call succeeds, 55changes made by the operation will be recoverable. If the call fails, 56the operation will have made no changes.</ul> 57<br></ul> 58 <b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the 59<b>txnid</b> parameter is a transaction handle returned from 60<a href="/api_c/txn_begin.html">DB_ENV->txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the 61<b>txnid</b> parameter is a handle returned from 62<a href="/api_c/env_cdsgroup_begin.html">DB_ENV->cdsgroup_begin</a>; otherwise NULL. 63If no transaction handle is 64specified, but the 65DB_AUTO_COMMIT flag is specified, 66the operation will be implicitly transaction protected. 67</ul> 68<br> 69<br><b>Environment Variables</b> 70<p>The 71environment variable <b>DB_HOME</b> may be used as the path of the 72database environment home.</p> 73<p>DB_ENV->dbremove is affected by any database directory specified using 74the <a href="/api_c/env_set_data_dir.html">DB_ENV->set_data_dir</a> method, or by setting the "set_data_dir" string 75in the environment's <a href="/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.</p> 76<br><b>Errors</b> 77<p>The DB_ENV->dbremove method 78may fail and return one of the following non-zero errors:</p> 79<br> 80<b>DB_LOCK_DEADLOCK</b><ul compact><li>A transactional database environment operation was selected to resolve 81a deadlock.</ul> 82<b>DB_LOCK_NOTGRANTED</b><ul compact><li>A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable 83to grant a lock in the allowed time.</ul> 84<br> 85<br> 86<b>EINVAL</b><ul compact><li>If DB_ENV->dbremove called before <a href="/api_c/env_open.html">DB_ENV->open</a> was called; or if an 87invalid flag value or parameter was specified.</ul> 88<br> 89<br> 90<b>ENOENT</b><ul compact><li>The file or directory does not exist.</ul> 91<br> 92<hr size=1 noshade> 93<br><b>Class</b> 94<a href="/api_c/env_class.html">DB_ENV</a> 95<br><b>See Also</b> 96<a href="/api_c/env_list.html">Database Environments and Related Methods</a> 97</tt> 98<table width="100%"><tr><td><br></td><td align=right> 99<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a> 100</td></tr></table> 101<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 102</body> 103</html> 104
