env_dbrename.html   [plain text]


<!--$Id: env_dbrename.so,v 11.4 2004/12/16 19:13:05 bostic Exp $-->
<!--$Id: m4.tcl,v 11.28 2004/12/16 19:13:05 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: env dbrename</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<b><i>env</i> <b>dbrename</b></b>
</td>
<td align=right>
<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></td>
</tr></table>
<hr size=1 noshade>
<tt>
<b><pre>env dbrename
	[-auto_commit]
	[-txn txnid]
	[--]
	file
	newname
</pre></b>
<b>Description(env dbrename)</b>
<p>Rename the Berkeley DB database <b>file</b> to <b>newname</b>.</p>
<p>The options are as follows:</p>
<br>
<b>-auto_commit</b><ul compact><li>Enclose the call within a transaction. If the call succeeds, changes
made by the operation will be recoverable. If the call fails, the
operation will have made no changes.</ul>
<b>-txn txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the
<b>txnid</b> parameter is a transaction handle returned from
<i>env</i> <b>txn</b>.  If no transaction handle is specified, but the
-auto_commit flag is specified,
the operation will be implicitly transaction protected.</ul>
<br>
<p>The <i>env</i> <b>dbrename</b> command returns 0 on success, and in the case of error, a Tcl error
is thrown.</p>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
</body>
</html>