#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: DB_ENV->dbrename

The DB_ENV->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 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 may fail.

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

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.

On Windows, 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 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.

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 DB_ENV->txn_begin; otherwise NULL. If no transaction handle is specified, but the DB_AUTO_COMMIT flag is specified, 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.

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 one of the following non-zero errors:

DB_LOCK_DEADLOCK

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

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.

EINVAL

If DB_ENV->dbrename called before DB_ENV->open was called; or if an invalid flag value or parameter was specified.

ENOENT

The file or directory does not exist.

Class

See Also