DbEnv::dbrename()
Prev | Chapter 5. The DbEnv Handle | Next

## DbEnv::dbrename()

    #include <db_cxx.h>

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

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 using the value supplied to newname, 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.

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.

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

### Parameters

#### database

The database parameter is the database to be renamed.

#### file

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

When using a Unicode build on Windows (the default), the file argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters.

#### 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 part of an application-specified transaction, the txnid parameter is a transaction handle returned from DbEnv::txn_begin(); if the operation is part of a Berkeley DB Concurrent Data Store group, the txnid parameter is a handle returned from DbEnv::cdsgroup_begin(); otherwise NULL. If no transaction handle is specified, but the `DB_AUTO_COMMIT` flag is specified to either this method or the environment handle, the operation will be implicitly transaction protected.

### Environment Variables

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

### Errors

The `DbEnv::dbrename()` 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:

#### DbDeadlockException or DB_LOCK_DEADLOCK

A transactional database environment operation was selected to resolve a deadlock.

DbDeadlockException is thrown if your Berkeley DB API is configured to throw exceptions. Otherwise, `DB_LOCK_DEADLOCK` is returned.

#### DbLockNotGrantedException or DB_LOCK_NOTGRANTED

A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time.

DbLockNotGrantedException is thrown if your Berkeley DB API is configured to throw exceptions. Otherwise, `DB_LOCK_NOTGRANTED` is returned.

#### EINVAL

If the method was called before DbEnv::open() was called; or if an invalid flag value or parameter was specified.

#### ENOENT

The file or directory does not exist.

### Class

DbEnv

### See Also

Database Environments and Related Methods

Prev | Up | Next
DbEnv::dbremove() | Home | DbEnv::err()