docs/api_reference/CXX/repmgr_site_parameter.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6     <title>repmgr_site</title>
   7     <link rel="stylesheet" href="apiReference.css" type="text/css" />
   8     <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
   9     <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
  10     <link rel="up" href="configuration_reference.html" title="Appendix B. DB_CONFIG Parameter Reference" />
  11     <link rel="prev" href="repmgr_set_ack_policy_parameter.html" title="repmgr_set_ack_policy" />
  12     <link rel="next" href="set_cachesize_parameter.html" title="set_cachesize" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">repmgr_site</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="repmgr_set_ack_policy_parameter.html">Prev</a> </td>
  25           <th width="60%" align="center">Appendix B. DB_CONFIG Parameter Reference</th>
  26           <td width="20%" align="right"> <a accesskey="n" href="set_cachesize_parameter.html">Next</a></td>
  27         </tr>
  28       </table>
  29       <hr />
  30     </div>
  31     <div class="sect1" lang="en" xml:lang="en">
  32       <div class="titlepage">
  33         <div>
  34           <div>
  35             <h2 class="title" style="clear: both"><a id="repmgr_site_parameter"></a>repmgr_site</h2>
  36           </div>
  37         </div>
  38       </div>
  39       <p>
  40                 Identifies a Replication Manager site.
  41             </p>
  42       <p>
  43                  The syntax of this parameter in the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is a
  44                  single line with the string
  45                  <code class="literal">repmgr_site</code>, one or more
  46                  whitespace characters, the host and port parameters
  47                  specified as a string and an integer respectively.
  48                  This can optionally be followed by one or more
  49                  space-delimited keywords and
  50                  <code class="literal">on</code>/<code class="literal">off</code>. For
  51                  example:
  52             </p>
  53       <pre class="programlisting">repmgr_site example.com 49200 db_local_site on db_legacy off</pre>
  54       <p>
  55                 Available keywords are:
  56             </p>
  57       <div class="itemizedlist">
  58         <ul type="disc">
  59           <li>
  60             <p>
  61                         <code class="literal">db_bootstrap_helper</code>
  62                     </p>
  63             <p>
  64                         If turned <code class="literal">on</code>, the identified
  65                         site may be used as a "helper" when the local site
  66                         is first joining the replication group.  Once the
  67                         local site has been established as a member of the
  68                         group, this setting is ignored.
  69                     </p>
  70           </li>
  71           <li>
  72             <p>
  73                         <code class="literal">db_group_creator</code>
  74                     </p>
  75             <p>
  76                         If turned <code class="literal">on</code>, this site should
  77                         create the initial membership database contents,
  78                         defining a "group" of just the one site, rather
  79                         than trying to join an existing group when it
  80                         starts for the first time.  This setting is only
  81                         used on the local site, and is ignored when
  82                         configured on a remote site.
  83                     </p>
  84           </li>
  85           <li>
  86             <p>
  87                         <code class="literal">db_legacy</code>
  88                     </p>
  89             <p>
  90                         If turned <code class="literal">on</code>, specifies that the
  91                         site is already part of an existing group. This
  92                         setting causes the site to be upgraded from a
  93                         previous version of BDB. All sites in the legacy
  94                         group must specify this setting for themselves (the
  95                         local site) and for all other sites currently
  96                         existing in the group. Once the upgrade has been
  97                         completed, this setting is no longer required.
  98                     </p>
  99           </li>
 100           <li>
 101             <p>
 102                         <code class="literal">db_local_site</code>
 103                     </p>
 104             <p>
 105                         If turned <code class="literal">on</code>, specifies that
 106                         this site is the local site within the replication
 107                         group. The application must identify exactly one
 108                         site as the local site before replication is
 109                         started.
 110                     </p>
 111           </li>
 112           <li>
 113             <p>
 114                         <code class="literal">db_repmgr_peer</code>
 115                     </p>
 116             <p>
 117                         If turned <code class="literal">on</code>, specifies that the
 118                         site may be used as a target for "client-to-client"
 119                         synchronization messages. This setting is ignored
 120                         if it is turned <code class="literal">on</code> for the local site.
 121                     </p>
 122           </li>
 123         </ul>
 124       </div>
 125       <p>
 126                 For more information, see
 127                 <a class="xref" href="dbsite_set_config.html" title="DbSite::set_config()">DbSite::set_config()</a>.
 128             </p>
 129     </div>
 130     <div class="navfooter">
 131       <hr />
 132       <table width="100%" summary="Navigation footer">
 133         <tr>
 134           <td width="40%" align="left"><a accesskey="p" href="repmgr_set_ack_policy_parameter.html">Prev</a> </td>
 135           <td width="20%" align="center">
 136             <a accesskey="u" href="configuration_reference.html">Up</a>
 137           </td>
 138           <td width="40%" align="right"> <a accesskey="n" href="set_cachesize_parameter.html">Next</a></td>
 139         </tr>
 140         <tr>
 141           <td width="40%" align="left" valign="top">repmgr_set_ack_policy </td>
 142           <td width="20%" align="center">
 143             <a accesskey="h" href="index.html">Home</a>
 144           </td>
 145           <td width="40%" align="right" valign="top"> set_cachesize</td>
 146         </tr>
 147       </table>
 148     </div>
 149   </body>
 150 </html>