2011-09-13 17:44:24 +00:00
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" / >
< title > DbEnv::dbremove()< / title >
< link rel = "stylesheet" href = "apiReference.css" type = "text/css" / >
< meta name = "generator" content = "DocBook XSL Stylesheets V1.73.2" / >
< link rel = "start" href = "index.html" title = "Berkeley DB C++ API Reference" / >
< link rel = "up" href = "env.html" title = "Chapter / >
< link rel = "prev" href = "envcreate.html" title = "DbEnv" / >
< link rel = "next" href = "envdbrename.html" title = "DbEnv::dbrename()" / >
< / head >
< body >
< div xmlns = "" class = "navheader" >
< div class = "libver" >
< p > Library Version 11.2.5.2< / p >
< / div >
< table width = "100%" summary = "Navigation header" >
< tr >
< th colspan = "3" align = "center" > DbEnv::dbremove()< / th >
< / tr >
< tr >
< td width = "20%" align = "left" > < a accesskey = "p" href = "envcreate.html" > Prev< / a > < / td >
< th width = "60%" align = "center" > Chapter
The DbEnv Handle
< / th >
< td width = "20%" align = "right" > < a accesskey = "n" href = "envdbrename.html" > Next< / a > < / td >
< / tr >
< / table >
< hr / >
< / div >
< div class = "sect1" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
< h2 class = "title" style = "clear: both" > < a id = "envdbremove" > < / a > DbEnv::dbremove()< / h2 >
< / div >
< / div >
< / div >
< pre class = "programlisting" > #include < db_cxx.h>
int
DbEnv::dbremove(DbTxn *txnid,
const char *file, const char *database, u_int32_t flags);< / pre >
< p >
The < code class = "methodname" > DbEnv::dbremove()< / code > method removes the database specified by the
< span class = "bold" > < strong > file< / strong > < / span > and < span class = "bold" > < strong > database< / strong > < / span > parameters. If no < span class = "bold" > < strong > database< / strong > < / span > is specified, the underlying file
represented by < span class = "bold" > < strong > file< / strong > < / span > is removed,
incidentally removing all of the databases it contained.
< / p >
< p >
Applications should never remove databases with open
< a class = "link" href = "db.html" title = "Chapter > Db< / a > handles, or in the case of
removing a file, when any database in the file has an open handle.
< / p >
< p >
The < code class = "methodname" > DbEnv::dbremove()< / code > < span >
< span >
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.
< / span >
< / span >
< / p >
< p >
< code class = "methodname" > DbEnv::dbremove()< / code > is affected by any database directory specified using the
< a class = "xref" href = "envset_data_dir.html" title = "DbEnv::set_data_dir()" > DbEnv::set_data_dir()< / a >
method, or by setting the < code class = "literal" > set_data_dir< / code > string in the environment's
< a href = "../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class = "olink" > DB_CONFIG< / a > file.
< / p >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3593348" > < / a > Parameters< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3593351" > < / a > txnid< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
If the operation is part of an application-specified transaction, the
< span class = "bold" > < strong > txnid< / strong > < / span > parameter is a transaction
handle returned from
< a class = "xref" href = "txnbegin.html" title = "DbEnv::txn_begin()" > DbEnv::txn_begin()< / a > ; if the
operation is part of a Berkeley DB Concurrent Data Store group, the
< span class = "bold" > < strong > txnid< / strong > < / span > parameter is a handle returned
from < a class = "xref" href = "envcdsgroup_begin.html" title = "DbEnv::cdsgroup_begin()" > DbEnv::cdsgroup_begin()< / a > ;
otherwise NULL. If no transaction handle is specified, but the
< code class = "literal" > DB_AUTO_COMMIT< / code > flag is specified to either this method
or the environment handle, the operation will be implicitly transaction protected.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3593368" > < / a > file< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The < span class = "bold" > < strong > file< / strong > < / span > parameter is the physical
file which contains the database(s) to be removed.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3592963" > < / a > database< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The < span class = "bold" > < strong > database< / strong > < / span > parameter is the
database to be removed.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3593280" > < / a > flags< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The < span class = "bold" > < strong > flags< / strong > < / span > parameter must
be set to 0 or the following value:
< / p >
< div class = "itemizedlist" >
< ul type = "disc" >
< li >
< p >
< code class = "literal" > DB_AUTO_COMMIT< / code >
< / p >
< p >
Enclose the < code class = "classname" > DbEnv::dbremove()< / code >
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.
< / p >
< / li >
< / ul >
< / div >
< / div >
< / div >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3593469" > < / a > Environment Variables< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The environment variable < code class = "literal" > DB_HOME< / code > may be used as the path of
the database environment home.
< / p >
< / div >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3593362" > < / a > Errors< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The < code class = "methodname" > DbEnv::dbremove()< / code > < span >
< span >
method may fail and throw a < a class = "link" href = "dbexception.html" title = "Chapter > DbException< / a >
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
< / span >
< / span >
< / p >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3593613" > < / a > < span > DbDeadlockException or < / span > DB_LOCK_DEADLOCK< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
A transactional database environment operation was selected to resolve
a deadlock.
< / p >
< p >
< a class = "xref" href = "dbdeadlock.html" title = "DbDeadlockException" > DbDeadlockException< / a > is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, < code class = "literal" > DB_LOCK_DEADLOCK< / code > is returned.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3593408" > < / a > < span > DbLockNotGrantedException or < / span > DB_LOCK_NOTGRANTED< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
A Berkeley DB Concurrent Data Store database environment configured
for lock timeouts was unable to grant a lock in the allowed time.
< / p >
< p >
< a class = "xref" href = "dblocknotgranted.html" title = "DbLockNotGrantedException" > DbLockNotGrantedException< / a > is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, < code class = "literal" > DB_LOCK_NOTGRANTED< / code > is returned.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3588867" > < / a > EINVAL< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
If the method was called before < a class = "xref" href = "envopen.html" title = "DbEnv::open()" > DbEnv::open()< / a >
was called; or if an invalid flag value or parameter was specified.
< / p >
< / div >
< div class = "sect3" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h4 class = "title" > < a id = "id3593146" > < / a > ENOENT< / h4 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
The file or directory does not exist.
< / p >
< / div >
< / div >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3593543" > < / a > Class< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
< a class = "link" href = "env.html" title = "Chapter > DbEnv< / a >
< / p >
< / div >
< div class = "sect2" lang = "en" xml:lang = "en" >
< div class = "titlepage" >
< div >
< div >
2011-12-20 00:07:10 +00:00
< h3 class = "title" > < a id = "id3593128" > < / a > See Also< / h3 >
2011-09-13 17:44:24 +00:00
< / div >
< / div >
< / div >
< p >
< a class = "xref" href = "env.html#envlist" title = "Database Environments and Related Methods" > Database Environments and Related Methods< / a >
< / p >
< / div >
< / div >
< div class = "navfooter" >
< hr / >
< table width = "100%" summary = "Navigation footer" >
< tr >
< td width = "40%" align = "left" > < a accesskey = "p" href = "envcreate.html" > Prev< / a > < / td >
< td width = "20%" align = "center" >
< a accesskey = "u" href = "env.html" > Up< / a >
< / td >
< td width = "40%" align = "right" > < a accesskey = "n" href = "envdbrename.html" > Next< / a > < / td >
< / tr >
< tr >
< td width = "40%" align = "left" valign = "top" > DbEnv < / td >
< td width = "20%" align = "center" >
< a accesskey = "h" href = "index.html" > Home< / a >
< / td >
< td width = "40%" align = "right" valign = "top" > < / td >
< / tr >
< / table >
< / div >
< / body >
< / html >
