summaryrefslogtreecommitdiff
path: root/db/docs/api_tcl/env_dbrename.html
blob: e21dcba9546bfb3a43849b6ea9639cbdba058309 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<!--Id: env_dbrename.so,v 11.2 2002/06/24 14:49:56 bostic Exp -->
<!--Id: m4.tcl,v 11.25 2002/02/22 18:59:43 bostic Exp -->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--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,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><i>env</i> <b>dbrename</b></h1>
</td>
<td align=right>
<a href="../api_tcl/tcl_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>env dbrename
	[-auto_commit]
	[-txn txnid]
	[--]
	file
	newname
</pre></h3>
<h1>Description</h1>
<p>Rename the Berkeley DB database <b>file</b> to <b>newname</b>.
<p>The options are as follows:
<p><dl compact>
<p><dt>-auto_commit<dd>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.
<p><dt>-txn txnid<dd>If the operation is to be
transaction-protected (other than by specifying the -auto_commit flag),
the <b>txnid</b> parameter is a transaction handle returned from
<i>env</i> <b>txn</b>.
</dl>
<p>The <i>env</i> <b>dbrename</b> command returns 0 on success, and in the case of error, a Tcl error
is thrown.
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_tcl/tcl_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>