#include <db_cxx.h>

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

Description: Db::remove

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 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

database

The database parameter is the database to be removed.

file

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

On Windows, the file argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters.

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::set_data_dir method, or by setting the "set_data_dir" string in the environment's DB_CONFIG file.

Errors

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

EINVAL

If Db::remove called after Db::open was called; or if an invalid flag value or parameter was specified.

ENOENT

The file or directory does not exist.

Class

See Also