# DB_ENV->dbrename

`

###

    #include <db.h>

    int
    DB_ENV->dbrename(DB_ENV *dbenv, DB_TXN *txnid, const char *file,
        const char *database, const char *newname, u_int32_t flags);

# Description

The DB_ENV->dbrename method 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_ENV->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.

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

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

DB_AUTO_COMMIT
  Enclose the DB_ENV->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.

The DB_ENV->dbrename method returns a non-zero error value on failure and 0 on success.

# Environment Variables

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

  DB_ENV->dbrename is affected by any database directory specified using the DB_ENV->set_data_dir method, or by setting the "set_data_dir" string in the environment's DB_CONFIG file.

# Errors

The DB_ENV->dbrename method may fail and return a non-zero error for the following conditions:

DB_LOCK_DEADLOCK
  The operation was selected to resolve a deadlock.

EINVAL
  An invalid flag value or parameter was specified.

  A database in the file is currently open.

  Called before DB_ENV->open was called.

The DB_ENV->dbrename method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DB_ENV->dbrename method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DB_ENV

# See Also

Database Environments and Related Methods`

Copyright Sleepycat Software