1<!--$Id: env_dbrename.so,v 10.37 2004/12/16 19:13:01 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: DbEnv::dbrename</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>DbEnv::dbrename</b> 14</td> 15<td align=right> 16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a> 17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db_cxx.h> 23<p> 24int 25DbEnv::dbrename(DbTxn *txnid, const char *file, 26 const char *database, const char *newname, u_int32_t flags); 27</pre></b> 28<hr size=1 noshade> 29<b>Description: DbEnv::dbrename</b> 30<p>The DbEnv::dbrename method renames the database specified by the 31<b>file</b> and <b>database</b> parameters to <b>newname</b>. If no 32<b>database</b> is specified, the underlying file represented by 33<b>file</b> is renamed, incidentally renaming all of the databases it 34contained.</p> 35<p>Applications should not rename databases that are currently in use. If 36an underlying file is being renamed and logging is currently enabled in 37the database environment, no database in the file may be open when the 38DbEnv::dbrename method is called. In particular, some architectures do 39not permit renaming files with open handles. On these architectures, 40attempts to rename databases that are currently in use by any thread of 41control in the system may fail.</p> 42<p>The DbEnv::dbrename method 43either returns a non-zero error value 44or throws an exception that encapsulates a non-zero error value on 45failure, and returns 0 on success. 46</p> 47<b>Parameters</b> <br> 48 <b>database</b><ul compact><li>The <b>database</b> parameter is the database to be renamed.</ul> 49 <b>file</b><ul compact><li>The <b>file</b> parameter is the physical file which contains the 50database(s) to be renamed.</ul> 51<p>When using a Unicode build on Windows (the default), the <b>file</b> 52argument will be interpreted as a UTF-8 string, which is equivalent to 53ASCII for Latin characters.</p> 54 <b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or 55the following value: 56<br> 57<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, 58changes made by the operation will be recoverable. If the call fails, 59the operation will have made no changes.</ul> 60<br></ul> 61 <b>newname</b><ul compact><li>The <b>newname</b> parameter is the new name of the database or file.</ul> 62 <b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the 63<b>txnid</b> parameter is a transaction handle returned from 64<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 65<b>txnid</b> parameter is a handle returned from 66<a href="../api_cxx/env_cdsgroup_begin.html">DbEnv::cdsgroup_begin</a>; otherwise NULL. 67If no transaction handle is 68specified, but the 69DB_AUTO_COMMIT flag is specified, 70the operation will be implicitly transaction protected. 71</ul> 72<br> 73<br><b>Environment Variables</b> 74<p>The 75environment variable <b>DB_HOME</b> may be used as the path of the 76database environment home.</p> 77<p>DbEnv::dbrename is affected by any database directory specified using 78the <a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a> method, or by setting the "set_data_dir" string 79in the environment's <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.</p> 80<br><b>Errors</b> 81<p>The DbEnv::dbrename method 82may fail and throw 83<a href="../api_cxx/except_class.html">DbException</a>, 84encapsulating one of the following non-zero errors, or return one of 85the following non-zero errors:</p> 86<br> 87<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 88invalid flag value or parameter was specified.</ul> 89<br> 90<br> 91<b>ENOENT</b><ul compact><li>The file or directory does not exist.</ul> 92<br> 93<p>If a transactional database environment operation was selected to 94resolve a deadlock, the DbEnv::dbrename method will fail and 95either return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or 96throw a <a href="../api_cxx/deadlock_class.html">DbDeadlockException</a> exception.</p> 97<p>If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable 98to grant a lock in the allowed time, the DbEnv::dbrename method will fail and 99either return <a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a> or 100throw a <a href="../api_cxx/lockng_class.html">DbLockNotGrantedException</a> exception.</p> 101<hr size=1 noshade> 102<br><b>Class</b> 103<a href="../api_cxx/env_class.html">DbEnv</a> 104<br><b>See Also</b> 105<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a> 106</tt> 107<table width="100%"><tr><td><br></td><td align=right> 108<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> 109</td></tr></table> 110<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 111</body> 112</html> 113
