<!--$Id: env_dbrename.so,v 10.31 2003/11/08 19:17:27 bostic Exp $-->
<!--Copyright 1997-2003 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::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>
<h3>DbEnv::dbrename</h3>
</td>
<td align=right>
<a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a>
<a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
int
DbEnv::dbrename(DbTxn *txnid, const char *file,
const char *database, const char *newname, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::dbrename</h3>
<p>The DbEnv::dbrename method renames the database specified by the
<b>file</b> and <b>database</b> parameters to <b>newname</b>. If no
<b>database</b> is specified, the underlying file represented by
<b>file</b> is renamed, 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
DbEnv::dbrename 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>
<p>The DbEnv::dbrename 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.
</p>
<h3>Parameters</h3>
<p><dl compact>
<p><dt><b>database</b><dd>
The <b>database</b> parameter is the database to be removed.
<p><dt><b>file</b><dd>
The <b>file</b> parameter is the physical file which contains the
database(s) to be removed.
<p><dt><b>flags</b><dd>
The <b>flags</b> parameter must be set to 0 or
the following value:
<p><dl compact>
<p><dt><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a><dd>Enclose the DbEnv::dbrename 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.
</dl>
<p><dt><b>newname</b><dd>
The <b>newname</b> parameter is the new name of the database or file.
<p><dt><b>txnid</b><dd>
If the operation is to be transaction-protected,
the <b>txnid</b> parameter is a transaction handle returned from
<a href="../../db42-devel-4.2.52/api_cxx/txn_begin.html">DbEnv::txn_begin</a>; otherwise, NULL.
</dl>
<h3>Environment Variables</h3>
<p>The
environment variable <b>DB_HOME</b> may be used as the path of the
database environment home.</p>
<p>DbEnv::dbrename is affected by any database directory specified using
the <a href="../../db42-devel-4.2.52/api_cxx/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.</p>
<h3>Errors</h3>
<p>The DbEnv::dbrename method
may fail and throw
<a href="../../db42-devel-4.2.52/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:</p>
<p><dl compact>
<p><dt>DB_FILEOPEN<dd>An attempt was made to rename the underlying file and a database in the
file was currently open.
</dl>
<p><dl compact>
<p><dt>EINVAL<dd>If DbEnv::dbrename called before <a href="../../db42-devel-4.2.52/api_cxx/env_open.html">DbEnv::open</a> was called; or if an
invalid flag value or parameter was specified.
</dl>
<p><dl compact>
<p><dt>ENOENT<dd>The file or directory does not exist.
</dl>
<p>If a transactional database environment operation was selected to
resolve a deadlock, the DbEnv::dbrename method will fail and
either return <a href="../../db42-devel-4.2.52/ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or
throw a <a href="../../db42-devel-4.2.52/api_cxx/deadlock_class.html">DbDeadlockException</a> exception.</p>
<p>If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable
to grant a lock in the allowed time, the DbEnv::dbrename method will fail and
either return <a href="../../db42-devel-4.2.52/ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a> or
throw a <a href="../../db42-devel-4.2.52/api_cxx/lockng_class.html">DbLockNotGrantedException</a> exception.</p>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../../db42-devel-4.2.52/api_cxx/env_class.html">DbEnv</a>
<h3>See Also</h3>
<a href="../../db42-devel-4.2.52/api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a><a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../../db42-devel-4.2.52/sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
distrib
>
Mandriva
>
2007.0
>
x86_64
>
media
>
main-release
>
by-pkgid
>
a4c98df40e78f6c892308fd6841f950a
>
files
>
268
