Berkeley DB: DbEnv::dbremove
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# DbEnv::dbremove |

`

###

    #include <db_cxx.h>

    int
    DbEnv::dbremove(DbTxn *txnid,
        const char *file, const char *database, u_int32_t flags);

# Description

The DbEnv::dbremove method 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 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 will fail.

If the operation is to be transaction-protected, the txnid parameter is a transaction handle returned from DbEnv::txn_begin; otherwise, NULL.

The flags value must be set to 0 or the following value:

DB_AUTO_COMMIT
  Enclose the DbEnv::dbremove 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.

The DbEnv::dbremove 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
  The environment variable DB_HOME may be used as the path of the database environment home.

  DbEnv::dbremove 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 DbEnv::dbremove method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  A database in the file is currently open.

  Called before DbEnv::open was called.

If the file or directory does not exist, the DbEnv::dbremove method will fail and and either return ENOENT or throw a FileNotFoundException exception.

The DbEnv::dbremove 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 DbEnv::dbremove method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DbEnv

# See Also

Database Environments and Related Methods`

Copyright Sleepycat Software