#include <db_cxx.h>

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

Description: DbEnv::dbrename

The DbEnv::dbrename method renames the database specified by the file and database parameters to newname. If no database is specified, the underlying file represented by file is renamed, incidentally renaming all of the databases it contained.

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

The DbEnv::dbrename 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.

flags

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

DB_AUTO_COMMIT

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

newname

The newname parameter is the new name of the database or file.

txnid

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

Environment Variables

The environment variable DB_HOME may be used as the path of the database environment home.

DbEnv::dbrename 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::dbrename method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

DB_FILEOPEN

An attempt was made to rename the underlying file and a database in the file was currently open.

EINVAL

If DbEnv::dbrename called before DbEnv::open was called; or if an invalid flag value or parameter was specified.

ENOENT

The file or directory does not exist.

If a transactional database environment operation was selected to resolve a deadlock, the DbEnv::dbrename method will fail and either return DB_LOCK_DEADLOCK or throw a DbDeadlockException exception.

If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the DbEnv::dbrename method will fail and either return DB_LOCK_NOTGRANTED or throw a DbLockNotGrantedException exception.

Class

See Also