#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);
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
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 DB_ENV->dbrename() method is called.
The DB_ENV->dbrename()
method returns a non-zero error value on failure and 0 on success.
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.
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.
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.
If the operation is part of an application-specified transaction, the
txnid parameter is a transaction
handle returned from DB_ENV->txn_begin(); if the
operation is part of a Berkeley DB Concurrent Data Store group, the
txnid parameter is a handle returned
from DB_ENV->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.
The environment variable DB_HOME may be used as the path of
the database environment home.
The DB_ENV->dbrename()
method may fail and return one of the following non-zero errors:
A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time.
If the method was called before DB_ENV->open() was called; or if an invalid flag value or parameter was specified.