<?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::set_metadata_dir()</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="envset_memory_max.html" title="DbEnv::set_memory_max()" /> <link rel="next" href="envset_message_stream.html" title="DbEnv::set_message_stream()" /> </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::set_metadata_dir()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="envset_memory_max.html">Prev</a> </td> <th width="60%" align="center">Chapter 5. The DbEnv Handle </th> <td width="20%" align="right"> <a accesskey="n" href="envset_message_stream.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="envset_metadata_dir"></a>DbEnv::set_metadata_dir()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::set_metadata_dir(const char *dir);</pre> <p> The <code class="methodname">DbEnv::set_metadata_dir()</code> method sets the directory where persistent metadata is stored. By default, persistent metadata is stored in the environment home directory. </p> <p> When used in a replicated application, the metadata directory must be the same location for all sites within a replication group. </p> <p> The <code class="methodname">DbEnv::set_metadata_dir()</code> method may not be called after the <a class="xref" href="envopen.html" title="DbEnv::open()">DbEnv::open()</a> method is called. The directory identified by this method must already exist when the <code class="methodname">DbEnv::open()</code> method is called. The directory identified by this method is added to the environment's list of data directories, if this directory is not already included on that list. </p> <p> The database environment's metadata directory may also be configured using the environment's <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file. The syntax of the entry in that file is a single line with the string "set_metadata_dir", one or more whitespace characters, followed by the directory location. Because the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is read when the database environment is opened, it will silently overrule configuration done before that time. </p> <p> The <code class="methodname">DbEnv::set_metadata_dir()</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> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp7540800"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp7541400"></a>dir</h4> </div> </div> </div> <p> The <span class="bold"><strong>dir</strong></span> parameter identifies the directory used to store persistent metadata files. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp7534456"></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="idp7490808"></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>, <a class="xref" href="envget_metadata_dir.html" title="DbEnv::get_metadata_dir()">DbEnv::get_metadata_dir()</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="envset_memory_max.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="envset_message_stream.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::set_memory_max() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::set_message_stream()</td> </tr> </table> </div> </body> </html>