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: DB_ENV->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>DB_ENV->dbrename</b> 14</td> 15<td align=right> 16<a href="/api_c/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.h> 23<p> 24int 25DB_ENV->dbrename(DB_ENV *dbenv, DB_TXN *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: DB_ENV->dbrename</b> 30<p>The DB_ENV->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 38DB_ENV->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 DB_ENV->dbrename method 43returns a non-zero error value on failure 44and 0 on success. 45</p> 46<b>Parameters</b> <br> 47 <b>database</b><ul compact><li>The <b>database</b> parameter is the database to be renamed.</ul> 48 <b>file</b><ul compact><li>The <b>file</b> parameter is the physical file which contains the 49database(s) to be renamed.</ul> 50<p>When using a Unicode build on Windows (the default), the <b>file</b> 51argument will be interpreted as a UTF-8 string, which is equivalent to 52ASCII for Latin characters.</p> 53 <b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or 54the following value: 55<br> 56<b><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a></b><ul compact><li>Enclose the DB_ENV->dbrename call within a transaction. If the call succeeds, 57changes made by the operation will be recoverable. If the call fails, 58the operation will have made no changes.</ul> 59<br></ul> 60 <b>newname</b><ul compact><li>The <b>newname</b> parameter is the new name of the database or file.</ul> 61 <b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the 62<b>txnid</b> parameter is a transaction handle returned from 63<a href="/api_c/txn_begin.html">DB_ENV->txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the 64<b>txnid</b> parameter is a handle returned from 65<a href="/api_c/env_cdsgroup_begin.html">DB_ENV->cdsgroup_begin</a>; otherwise NULL. 66If no transaction handle is 67specified, but the 68DB_AUTO_COMMIT flag is specified, 69the operation will be implicitly transaction protected. 70</ul> 71<br> 72<br><b>Environment Variables</b> 73<p>The 74environment variable <b>DB_HOME</b> may be used as the path of the 75database environment home.</p> 76<p>DB_ENV->dbrename is affected by any database directory specified using 77the <a href="/api_c/env_set_data_dir.html">DB_ENV->set_data_dir</a> method, or by setting the "set_data_dir" string 78in the environment's <a href="/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.</p> 79<br><b>Errors</b> 80<p>The DB_ENV->dbrename method 81may fail and return one of the following non-zero errors:</p> 82<br> 83<b>DB_LOCK_DEADLOCK</b><ul compact><li>A transactional database environment operation was selected to resolve 84a deadlock.</ul> 85<b>DB_LOCK_NOTGRANTED</b><ul compact><li>A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable 86to grant a lock in the allowed time.</ul> 87<br> 88<br> 89<b>EINVAL</b><ul compact><li>If DB_ENV->dbrename called before <a href="/api_c/env_open.html">DB_ENV->open</a> was called; or if an 90invalid flag value or parameter was specified.</ul> 91<br> 92<br> 93<b>ENOENT</b><ul compact><li>The file or directory does not exist.</ul> 94<br> 95<hr size=1 noshade> 96<br><b>Class</b> 97<a href="/api_c/env_class.html">DB_ENV</a> 98<br><b>See Also</b> 99<a href="/api_c/env_list.html">Database Environments and Related Methods</a> 100</tt> 101<table width="100%"><tr><td><br></td><td align=right> 102<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a> 103</td></tr></table> 104<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 105</body> 106</html> 107
