<!--$Id: db_rename.html,v 1.1 2003/02/15 04:55:50 zarzycki Exp $--> <!--$Id: db_rename.html,v 1.1 2003/02/15 04:55:50 zarzycki Exp $--> <!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Db.rename</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h1>Db.rename</h1> </td> <td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> import com.sleepycat.db.*; import java.io.FileNotFoundException; <p> public void rename(String file, String database, String newname, int flags) throws DbException, FileNotFoundException; </pre></h3> <h1>Description</h1> <p>The Db.rename method renames the database specified by the <b>file</b> and <b>database</b> arguments to <b>newname</b>. If no <b>database</b> is specified, the underlying file represented by <b>file</b> is renamed, incidentally renaming all databases that it contained. <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 Db.rename 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 will fail. <p>The <b>flags</b> parameter is currently unused, and must be set to 0. <p>The <a href="../api_java/db_class.html">Db</a> handle may not be accessed again after Db.rename is called, regardless of its return. <p>The Db.rename method throws an exception that encapsulates a non-zero error value on failure. <h1>Environment Variables</h1> <p><dl compact> <p><dt>DB_HOME<dd>If a <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was specified, the environment variable <b>DB_HOME</b> may be used as the path of the database environment home. <p>Db.rename is affected by any database directory specified using the <a href="../api_java/env_set_data_dir.html">DbEnv.set_data_dir</a> method, or by setting the "set_data_dir" string in the environment's <b>DB_CONFIG</b> file. </dl> <h1>Errors</h1> <p>The Db.rename method may fail and throw an exception encapsulating a non-zero error for the following conditions: <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. <p>A database in the file is currently open. <p>Called after <a href="../api_java/db_open.html">Db.open</a> was called. </dl> <p>If the file or directory does not exist, the Db.rename method will fail and throw a FileNotFoundException exception. <p>The Db.rename method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Db.rename method may fail and throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_java/db_class.html">Db</a> <h1>See Also</h1> <a href="../api_java/db_list.html">Databases and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> </html>