Db::remove
|

|
#include <db_cxx.h>
int
Db::remove(const char *name, const char *subname, u_int32_t flags);
Description
The Db::remove interface removes the database (or subdatabase)
represented by the name and subname combination.
If no subdatabase is specified, the physical file represented by
name is removed, incidentally removing all subdatabases
that it contained.
No reference count of database use is maintained by Berkeley DB. Applications
should not remove databases that are currently in use.
The flags parameter is currently unused, and must be set to 0.
Once Db::remove has been called, regardless of its return, the
Db handle may not be accessed again.
The Db::remove
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.
Environment Variables
- DB_HOME
- If the dbenv argument to db_create was initialized using
DbEnv::open the environment variable DB_HOME may be used
as the path of the database home for the interpretation of the dir.
Specifically, Db::remove is affected by the configuration string value of
DB_DATA_DIR.
Errors
If a fatal error occurs in Berkeley DB, the Db::remove method will fail and either
return DB_RUNRECOVERY or throw an exception encapsulating
DB_RUNRECOVERY, at which point all subsequent database calls will
fail in the same way.
In addition, the Db::remove method may fail and
throw an exception or return a non-zero error
for errors specified for other Berkeley DB and C library or system methods.
Class
Db
See Also
Db::close,
Db::cursor,
Db::del,
Db::err,
Db::fd,
Db::get,
Db::get_byteswapped,
Db::get_type,
Db::join,
Db::open,
Db::put,
Db::remove,
Db::set_bt_compare,
Db::set_bt_minkey,
Db::set_bt_prefix,
Db::set_cachesize,
Db::set_dup_compare,
Db::set_errcall,
Db::set_errfile,
Db::set_errpfx,
Db::set_flags,
Db::set_h_ffactor,
Db::set_h_hash,
Db::set_h_nelem,
Db::set_lorder,
Db::set_malloc,
Db::set_pagesize,
Db::set_paniccall,
Db::set_realloc,
Db::set_re_delim,
Db::set_re_len,
Db::set_re_pad,
Db::set_re_source,
Db::stat,
Db::sync
and
Db::upgrade.
Copyright Sleepycat Software