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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DbEnv::dbrename()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="env.html" title="Chapter 5. The DbEnv Handle" />
<link rel="prev" href="envdbremove.html" title="DbEnv::dbremove()" />
<link rel="next" href="enverr.html" title="DbEnv::err()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::dbrename()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envdbremove.html">Prev</a> </td>
<th width="60%" align="center">Chapter 5.
The DbEnv Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="enverr.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="envdbrename"></a>DbEnv::dbrename()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::dbrename(DbTxn *txnid, const char *file,
const char *database, const char *newname, u_int32_t flags);</pre>
<p>
The <code class="methodname">DbEnv::dbrename()</code> method renames the database specified by the
<span class="bold"><strong>file</strong></span> and <span class="bold"><strong>database</strong></span> parameters to <span class="bold"><strong>newname</strong></span>. If no <span class="bold"><strong>database</strong></span> is specified, the underlying file
represented by <span class="bold"><strong>file</strong></span> is renamed
using the value supplied to <span class="bold"><strong>newname</strong></span>,
incidentally renaming all of the databases it contained.
</p>
<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 <code class="methodname">DbEnv::dbrename()</code> method is called.
</p>
<p>
The <code class="methodname">DbEnv::dbrename()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<p>
<code class="methodname">DbEnv::dbrename()</code> is affected by any database directory specified using the
<a class="xref" href="envset_data_dir.html" title="DbEnv::set_data_dir()">DbEnv::set_data_dir()</a>
method, or by setting the <code class="literal">set_data_dir</code> string in the environment's
<a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6707816"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6708008"></a>txnid</h4>
</div>
</div>
</div>
<p>
If the operation is part of an application-specified transaction, the
<span class="bold"><strong>txnid</strong></span> parameter is a transaction
handle returned from <a class="xref" href="txnbegin.html" title="DbEnv::txn_begin()">DbEnv::txn_begin()</a>; if the
operation is part of a Berkeley DB Concurrent Data Store group, the
<span class="bold"><strong>txnid</strong></span> parameter is a handle returned
from <a class="xref" href="envcdsgroup_begin.html" title="DbEnv::cdsgroup_begin()">DbEnv::cdsgroup_begin()</a>;
otherwise NULL. If no transaction handle is specified, but the
<code class="literal">DB_AUTO_COMMIT</code> flag is specified to either this method or the
environment handle, the operation will be implicitly
transaction protected.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6709064"></a>file</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>file</strong></span> parameter is the physical
file which contains the database(s) to be renamed.
</p>
<p>
When using a Unicode build on Windows (the default), the
<span class="bold"><strong>file</strong></span> argument will
be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin
characters.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6685512"></a>database</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>database</strong></span> parameter is the
database to be renamed.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6703744"></a>newname</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>newname</strong></span> parameter is the new name
of the database or file.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6705288"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter
must be set to 0 or the following value:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_AUTO_COMMIT</code>
</p>
<p>
Enclose the <code class="methodname">DbEnv::dbrename()</code>
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>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6716864"></a>Environment Variables</h3>
</div>
</div>
</div>
<p>
The environment variable <code class="literal">DB_HOME</code> may be used as the path of
the database environment home.
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6705936"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::dbrename()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6717944"></a><span>DbDeadlockException or </span>DB_LOCK_DEADLOCK</h4>
</div>
</div>
</div>
<p>
A transactional database environment operation was selected to resolve
a deadlock.
</p>
<p>
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_DEADLOCK</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6709344"></a><span>DbLockNotGrantedException or </span>DB_LOCK_NOTGRANTED</h4>
</div>
</div>
</div>
<p>
A Berkeley DB Concurrent Data Store database environment configured
for lock timeouts was unable to grant a lock in the allowed time.
</p>
<p>
You attempted to open a database handle that is configured
for no waiting exclusive locking, but the exclusive lock could not be
immediately obtained. See
<a class="xref" href="dbset_lk_exclusive.html" title="Db::set_lk_exclusive()">Db::set_lk_exclusive()</a>
for more information.
</p>
<p>
<a class="xref" href="dblocknotgranted.html" title="DbLockNotGrantedException">DbLockNotGrantedException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_NOTGRANTED</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6692944"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the method was called before <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a>
was called; or if an invalid flag value or parameter was specified.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp6678568"></a>ENOENT</h4>
</div>
</div>
</div>
<p>
The file or directory does not exist.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6721464"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp6709880"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envdbremove.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="env.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="enverr.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::dbremove() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::err()</td>
</tr>
</table>
</div>
</body>
</html>
|
