<!--$Id: env_dbrename.so,v 10.37 2004/12/16 19:13:01 bostic Exp $--> <!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbEnv::dbrename</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <table width="100%"><tr valign=top> <td> <b>DbEnv::dbrename</b> </td> <td align=right> <a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a> <a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> </tr></table> <hr size=1 noshade> <tt> <b><pre> #include <db_cxx.h> <p> int DbEnv::dbrename(DbTxn *txnid, const char *file, const char *database, const char *newname, u_int32_t flags); </pre></b> <hr size=1 noshade> <b>Description: DbEnv::dbrename</b> <p>The DbEnv::dbrename method renames the database specified by the <b>file</b> and <b>database</b> parameters to <b>newname</b>. If no <b>database</b> is specified, the underlying file represented by <b>file</b> is renamed, incidentally renaming all of the databases it contained.</p> <p>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 DbEnv::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.</p> <p>The DbEnv::dbrename 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. </p> <b>Parameters</b> <br> <b>database</b><ul compact><li>The <b>database</b> parameter is the database to be renamed.</ul> <b>file</b><ul compact><li>The <b>file</b> parameter is the physical file which contains the database(s) to be renamed.</ul> <p>When using a Unicode build on Windows (the default), the <b>file</b> argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters.</p> <b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or the following value: <br> <b><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a></b><ul compact><li>Enclose the DbEnv::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.</ul> <br></ul> <b>newname</b><ul compact><li>The <b>newname</b> parameter is the new name of the database or file.</ul> <b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the <b>txnid</b> parameter is a transaction handle returned from <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the <b>txnid</b> parameter is a handle returned from <a href="../api_cxx/env_cdsgroup_begin.html">DbEnv::cdsgroup_begin</a>; otherwise NULL. If no transaction handle is specified, but the DB_AUTO_COMMIT flag is specified, the operation will be implicitly transaction protected. </ul> <br> <br><b>Environment Variables</b> <p>The environment variable <b>DB_HOME</b> may be used as the path of the database environment home.</p> <p>DbEnv::dbrename is affected by any database directory specified using the <a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a> method, or by setting the "set_data_dir" string in the environment's <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.</p> <br><b>Errors</b> <p>The DbEnv::dbrename method may fail and throw <a href="../api_cxx/except_class.html">DbException</a>, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:</p> <br> <b>EINVAL</b><ul compact><li>If DbEnv::dbrename called before <a href="../api_cxx/env_open.html">DbEnv::open</a> was called; or if an invalid flag value or parameter was specified.</ul> <br> <br> <b>ENOENT</b><ul compact><li>The file or directory does not exist.</ul> <br> <p>If a transactional database environment operation was selected to resolve a deadlock, the DbEnv::dbrename method will fail and either return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or throw a <a href="../api_cxx/deadlock_class.html">DbDeadlockException</a> exception.</p> <p>If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the DbEnv::dbrename method will fail and either return <a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a> or throw a <a href="../api_cxx/lockng_class.html">DbLockNotGrantedException</a> exception.</p> <hr size=1 noshade> <br><b>Class</b> <a href="../api_cxx/env_class.html">DbEnv</a> <br><b>See Also</b> <a href="../api_cxx/env_list.html">Database Environments and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> </body> </html>