1<!--$Id: db_rename.so,v 10.3 2002/08/18 21:15:51 bostic Exp $--> 2<!--$Id: env_dbrename.so,v 10.37 2004/12/16 19:13:01 bostic Exp $--> 3<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 4<!--See the file LICENSE for redistribution information.--> 5<html> 6<head> 7<title>Berkeley DB: Db::rename</title> 8<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 9<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 10</head> 11<body bgcolor=white> 12<table width="100%"><tr valign=top> 13<td> 14<b>Db::rename</b> 15</td> 16<td align=right> 17<a href="/api_cxx/api_core.html"><img src="/images/api.gif" alt="API"></a> 18<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td> 19</tr></table> 20<hr size=1 noshade> 21<tt> 22<b><pre> 23#include <db_cxx.h> 24<p> 25int 26Db::rename(const char *file, 27 const char *database, const char *newname, u_int32_t flags); 28</pre></b> 29<hr size=1 noshade> 30<b>Description: Db::rename</b> 31<p>The Db::rename method renames the database specified by the 32<b>file</b> and <b>database</b> parameters to <b>newname</b>. If no 33<b>database</b> is specified, the underlying file represented by 34<b>file</b> is renamed, incidentally renaming all of the databases it 35contained.</p> 36<p>Applications should not rename databases that are currently in use. If 37an underlying file is being renamed and logging is currently enabled in 38the database environment, no database in the file may be open when the 39Db::rename method is called. In particular, some architectures do 40not permit renaming files with open handles. On these architectures, 41attempts to rename databases that are currently in use by any thread of 42control in the system may fail.</p> 43<p>The Db::rename method should not be called if the rename is intended 44to be transactionally safe; the <a href="/api_cxx/env_dbrename.html">DbEnv::dbrename</a> method should be used 45instead.</p> 46<p>The Db::rename method may not be called after calling the 47<a href="/api_cxx/db_open.html">Db::open</a> method on any <a href="/api_cxx/db_class.html">Db</a> handle. If the <a href="/api_cxx/db_open.html">Db::open</a> method 48has already been called on a <a href="/api_cxx/db_class.html">Db</a> handle, close the existing 49handle and create a new one before calling Db::rename.</p> 50<p>The <a href="/api_cxx/db_class.html">Db</a> handle may not be accessed again after Db::rename is 51called, regardless of its return.</p> 52<p>The Db::rename method 53either returns a non-zero error value 54or throws an exception that encapsulates a non-zero error value on 55failure, and returns 0 on success. 56</p> 57<b>Parameters</b> <br> 58 <b>database</b><ul compact><li>The <b>database</b> parameter is the database to be renamed.</ul> 59 <b>file</b><ul compact><li>The <b>file</b> parameter is the physical file which contains the 60database(s) to be renamed.</ul> 61<p>When using a Unicode build on Windows (the default), the <b>file</b> 62argument will be interpreted as a UTF-8 string, which is equivalent to 63ASCII for Latin characters.</p> 64 <b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul> 65 <b>newname</b><ul compact><li>The <b>newname</b> parameter is the new name of the database or file.</ul> 66<br> 67<br><b>Environment Variables</b> 68<p>If the database was opened within a database environment, the 69environment variable <b>DB_HOME</b> may be used as the path of the 70database environment home.</p> 71<p>Db::rename is affected by any database directory specified using 72the <a href="/api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a> method, or by setting the "set_data_dir" string 73in the environment's <a href="/ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file.</p> 74<br><b>Errors</b> 75<p>The Db::rename method 76may fail and throw 77<a href="/api_cxx/except_class.html">DbException</a>, 78encapsulating one of the following non-zero errors, or return one of 79the following non-zero errors:</p> 80<br> 81<b>EINVAL</b><ul compact><li>If Db::rename called after <a href="/api_cxx/db_open.html">Db::open</a> was called; or if an 82invalid flag value or parameter was specified.</ul> 83<br> 84<br> 85<b>ENOENT</b><ul compact><li>The file or directory does not exist.</ul> 86<br> 87<hr size=1 noshade> 88<br><b>Class</b> 89<a href="/api_cxx/db_class.html">Db</a> 90<br><b>See Also</b> 91<a href="/api_cxx/db_list.html">Databases and Related Methods</a> 92</tt> 93<table width="100%"><tr><td><br></td><td align=right> 94<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> 95</td></tr></table> 96<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 97</body> 98</html> 99