Library Version 18.1.40

Db::remove()
Prev | Chapter 2. The Db Handle | Next

## Db::remove()

    #include <db_cxx.h>

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

The `Db::remove()` method removes the database specified by the file and database parameters. If no database is specified, the underlying file represented by file is removed, incidentally removing all of the databases it contained.

Applications should never remove databases with open Db handles, or in the case of removing a file, when any database in the file has an open handle. For example, some architectures do not permit the removal of files with open system handles. On these architectures, attempts to remove databases currently in use by any thread of control in the system may fail.

The `Db::remove()` method should not be called if the remove is intended to be transactionally safe; the DbEnv::dbremove() method should be used instead.

The `Db::remove()` method can not be called for sliced databases; the DbEnv::dbremove() method should be used instead.

The `Db::remove()` method may not be called after calling the Db::open() method on any Db handle. If the Db::open() method has already been called on a Db handle, close the existing handle and create a new one before calling `Db::remove. ()`

The Db handle may not be accessed again after `Db::remove()` is called, regardless of its return.

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.

### Parameters

#### file

The file parameter is the physical file which contains the database(s) to be removed.

#### database

The database parameter is the database to be removed.

#### flags

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

### Environment Variables

If the database was opened within a database environment, the environment variable `DB_HOME` may be used as the path of the database environment home.

`Db::remove()` is affected by any database directory specified using the DbEnv::add_data_dir() method, or by setting the "add_data_dir" string in the environment's DB_CONFIG file.

### Errors

The `Db::remove()` method may fail and throw a DbException exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

#### EINVAL

If the method was called after Db::open() was called; if this method was called on a sliced database; or if an invalid flag value or parameter was specified.

#### ENOENT

The file or directory does not exist.

#### DB_META_CHKSUM_FAIL

Checksum mismatch detected on a database metadata page. Either the database is corrupted or the file is not a Berkeley DB database file.

### Class

Db

### See Also

Database and Related Methods

Prev | Up | Next
Db::put() | Home | Db::rename()