|
|
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);
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.
On Windows, the file argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters.
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.
The DB_ENV->dbrename method may fail and return one of the following non-zero errors:
Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.