<?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>DB_ENV->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 DB_ENV Handle" /> <link rel="prev" href="envdbremove.html" title="DB_ENV->dbremove()" /> <link rel="next" href="enverr.html" title="DB_ENV->err()" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DB_ENV->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 DB_ENV 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>DB_ENV->dbrename()</h2> </div> </div> </div> <pre class="programlisting">#include <db.h> int DB_ENV->dbrename(DB_ENV *dbenv, DB_TXN *txnid, const char *file, const char *database, const char *newname, u_int32_t flags); </pre> <p> The <code class="methodname">DB_ENV->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">DB_ENV->dbrename()</code> method is called. </p> <p> The <code class="methodname">DB_ENV->dbrename()</code> <span> <span> method returns a non-zero error value on failure and 0 on success. </span> </span> </p> <p> <code class="methodname">DB_ENV->dbrename()</code> is affected by any database directory specified using the <a class="xref" href="envset_data_dir.html" title="DB_ENV->set_data_dir()">DB_ENV->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="id1661011"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1661629"></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="id1661791"></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="id1661797"></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">DB_ENV->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 class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1661904"></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="id1661697"></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="DB_ENV->txn_begin()">DB_ENV->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="DB_ENV->cdsgroup_begin()">DB_ENV->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> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1661811"></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="id1661419"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DB_ENV->dbrename()</code> <span> <span> method may fail and 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="id1661936"></a>DB_LOCK_DEADLOCK</h4> </div> </div> </div> <p> A transactional database environment operation was selected to resolve a deadlock. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1661632"></a>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> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1661660"></a>EINVAL</h4> </div> </div> </div> <p> If the method was called before <a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->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="id1661249"></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="id1661250"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1661710"></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">DB_ENV->dbremove() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DB_ENV->err()</td> </tr> </table> </div> </body> </html>