#include <db_cxx.h>
int
Db::rename(const char *file,
const char *database, const char *newname, u_int32_t flags);
The Db::rename() 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::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 may fail.
The Db::rename() method should not be called if the rename is
intended to be transactionally safe; the
DbEnv::dbrename() method
should be used instead.
The Db::rename() method may not be called after calling the
Db::open() method on any
Db handle. If the
Db::open() method has already
been called on a Db
handle, close the existing handle and create a new one before calling
Db::rename().
The Db handle may not be
accessed again after Db::rename() is called, regardless of its
return.
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.
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.
If the database was opened within a database environment, the
environment variable DB_HOME may be used as the path of the
database environment home.
Db::rename() 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.
The Db::rename()
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:
If the method was called after Db::open() was called; or if an invalid flag value or parameter was specified.