# Db::remove |

`

###

    #include <db_cxx.h>

    int
    Db::remove(const char *file, const char *database, u_int32_t flags);

# Description

The Db::remove interface removes the database specified by the file and database arguments. If no database is specified, the underlying file represented by file is removed, incidentally removing all databases that it contained.

Applications should not remove databases that are currently in use. If an underlying file is being removed and logging is currently enabled in the database environment, no database in the file may be open when the Db::remove method is called. In particular, some architectures do not permit the removal of files with open handles. On these architectures, attempts to remove databases that are currently in use by any thread of control in the system will fail.

The flags parameter is currently unused, and must be set to 0.

After 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 environment home. Specifically, Db::remove is affected by the configuration value DB_DATA_DIR.

# Errors

The Db::remove method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  A database in the file is currently open.

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. If a catastrophic error has occurred, the Db::remove method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

Db

# See Also

Db::associate, Db::close, Db::cursor, Db::del, Db::err, Db::errx Db::fd, Db::get, Db::pget, Db::get_byteswapped, Db::get_type, Db::join, Db::key_range, Db::open, Db::put, Db::remove, Db::rename, Db::set_alloc, Db::set_append_recno, 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_feedback, Db::set_flags, Db::set_h_ffactor, Db::set_h_hash, Db::set_h_nelem, Db::set_lorder, Db::set_pagesize, Db::set_paniccall, Db::set_q_extentsize, Db::set_re_delim, Db::set_re_len, Db::set_re_pad, Db::set_re_source, Db::stat, Db::sync, Db::truncate, Db::upgrade, and Db::verify.`

Copyright Sleepycat Software