#include <db_cxx.h>

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

Description

The Db::rename interface renames the database specified by the file and database arguments to newname. If no database is specified, the underlying file represented by file is renamed, incidentally renaming all databases that 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 Db::rename 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 flags parameter is currently unused, and must be set to 0.

After Db::rename has been called, regardless of its return, the Db handle may not be accessed again.

The Db::rename 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::rename is affected by the configuration value DB_DATA_DIR.

Errors

The Db::rename 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::rename 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::rename 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

See Also