1<!--$Id: db_rename.so,v 11.7 2002/09/26 17:34:02 bostic Exp $-->
2<!--$Id: m4.tcl,v 11.28 2004/12/16 19:13:05 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: berkdb dbrename</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><b>berkdb dbrename</b></b>
15</td>
16<td align=right>
17<a href="../api_tcl/api_tcl.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>berkdb rename
23	[-encrypt]
24	[-encryptaes passwd]
25	[-encryptany passwd]
26	[-env env]
27	[--]
28	file
29	[database
30	newname]
31</pre></b>
32<b>Description(berkdb dbrename)</b>
33<p>Renames the Berkeley DB database specified by the database name <b>file</b> and
34[database] name arguments to the new name given.
35If no <b>database</b> is specified,
36the physical file represented by <b>file</b> is renamed.</p>
37<p>No reference count of database use is maintained by Berkeley DB.  Applications
38should not rename databases that are currently in use.</p>
39<p>The options are as follows:</p>
40<br>
41<b>-encrypt</b><ul compact><li>Specify the database in an environment is encrypted with the
42same password that is being used in the environment.</ul>
43<b>-encryptaes passwd</b><ul compact><li>Specify the database is encrypted with the given password
44using the Rijndael/AES (also known as the Advanced Encryption Standard
45and Federal Information Processing Standard (FIPS) 197) algorithm.</ul>
46<b>-encryptany passwd</b><ul compact><li>Specify the already existing database is encrypted
47with the given password.  This option is used if the database is
48known to be encrypted, but the specific algorithm used is not known.</ul>
49<b>-env env</b><ul compact><li>If a <b>-env</b> argument is given, the database in the specified Berkeley DB
50environment is renamed.</ul>
51<b>--</b><ul compact><li>Mark the end of the command arguments.</ul>
52<br>
53<p>The <b>berkdb dbrename</b> command returns 0 on success, and in the case of error, a Tcl error
54is thrown.</p>
55</tt>
56<table width="100%"><tr><td><br></td><td align=right>
57<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
58</td></tr></table>
59<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
60</body>
61</html>
62