stasis/je-7.5.11/docs/java/com/sleepycat/je/rep/util/DbResetRepGroup.html

417 lines
17 KiB
HTML
Raw Normal View History

2019-06-25 20:12:40 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_151) on Tue Oct 31 17:36:46 EDT 2017 -->
<title>DbResetRepGroup (Oracle - Berkeley DB Java Edition API)</title>
<meta name="date" content="2017-10-31">
<link rel="stylesheet" type="text/css" href="../../../../../style.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DbResetRepGroup (Oracle - Berkeley DB Java Edition API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DbResetRepGroup.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/sleepycat/je/rep/util/DbPing.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/sleepycat/je/rep/util/ReplicationGroupAdmin.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/sleepycat/je/rep/util/DbResetRepGroup.html" target="_top">Frames</a></li>
<li><a href="DbResetRepGroup.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.je.rep.util</div>
<h2 title="Class DbResetRepGroup" class="title">Class DbResetRepGroup</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.je.rep.util.DbResetRepGroup</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">DbResetRepGroup</span>
extends java.lang.Object</pre>
<div class="block">A utility to reset the members of a replication group, replacing the group
with a new group consisting of a single new member as described by the
arguments supplied to the utility.
<p>
This utility is useful when a copy of an existing replicated environment
needs to be used at a different site, with the same data, but with a
different initial node that can be used to grow the replication group as
usual. The utility can also be used to change the group name associated with
the environment.
<p>
The reset environment has a different identity from the environment before
the reset operation although it contains the same application data. To avoid
confusion, the reset environment is assigned a new internal unique id. The
unique id is checked whenever nodes attempt to communicate with each other
and ensure that all nodes in a group are dealing with the same data.
<p>
The reset process is typically accomplished using the steps outlined below.
It's good practice to back up your environment before running any utilities
that modify an environment.
<ol>
<li>Use <code>DbResetRepGroup</code> to reset an existing environment.
<code>DbResetRepGroup</code> can be used as a command line utility, and must be
executed locally on the host specified in the -nodeHostPort argument. The
host must also contain the environment directory.
Alternatively, <code>DbResetRepGroup</code> may be used programmatically through
the provided APIs.</li>
<li>Once reset, the environment can be opened with a
<code>ReplicatedEnvironment</code>, using the same node configuration as the one
that was passed in to the utility. No helper host configuration is needed.
Since the group consists of a single node, it will assume the role of a
Master, so long as it is created as an electable node.
<li>Additional nodes may now be created and can join the group as newly
created replicas, as described in <code>ReplicatedEnvironment</code>. Since these
new nodes are empty, they should be configured to use the new master as
their helper node, and will go through the
<a href="../../../../../../ReplicationGuide/lifecycle.html#lifecycle-nodestartup"> replication node lifecycle</a>
to populate their environment directories. In this case, there will be data
in the converted master that can only be transferred to the replica through
a file copy executed with the help of a
<a href="../../../../../com/sleepycat/je/rep/NetworkRestore.html" title="class in com.sleepycat.je.rep"><code>NetworkRestore</code></a></li>
</ol>
<p>
For example:
<pre class="code">
// Run the utility on a copy of an existing replicated environment. Usually
// this environment will have originated on a different node and its
// replication group information will contain meta data referring to its
// previous host. The utility will reset this metadata so that it has a
// rep group (UniversalRepGroup) with a single node named nodeMars. The node
// is associated with the machine mars and will communicate on port 5001.
DbResetRepGroup resetUtility =
new DbResetRepGroup(envDirMars, // env home dir
"UniversalRepGroup", // group name
"nodeMars", // node name
"mars:5001"); // node host,port
resetUtility.reset();
// Open the reset environment; it will take on the role of master.
ReplicatedEnvironment nodeMars = new ReplicatedEnvironment(envDirMars, ...);
...
// Bring up additional nodes, which will be initialized from
// nodeMars. For example, from the machine venus you can now add a new
// member to the group(UniversalRepGroup) as below.
ReplicationConfig repConfig = null;
try {
repConfig = new ReplicationConfig("UniversalRepGroup", // groupName
"nodeVenus", // nodeName
"venus:5008"); // nodeHostPort
repConfig.setHelperHosts("mars:5001");
nodeVenus = new ReplicatedEnvironment(envDirB, repConfig, envConfig);
} catch (InsufficientLogException insufficientLogEx) {
// log files will be copied from another node in the group
NetworkRestore restore = new NetworkRestore();
restore.execute(insufficientLogEx, new NetworkRestoreConfig());
// try opening the node now that the environment files have been
// restored on this machine.
nodeVenus = new ReplicatedEnvironment(envDirVenus,
repConfig,
envConfig);
}
...
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbResetRepGroup.html#DbResetRepGroup-java.io.File-java.lang.String-java.lang.String-java.lang.String-">DbResetRepGroup</a></span>(java.io.File&nbsp;envHome,
java.lang.String&nbsp;groupName,
java.lang.String&nbsp;nodeName,
java.lang.String&nbsp;nodeHostPort)</code>
<div class="block">Create a DbResetRepGroup object for this node.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbResetRepGroup.html#main-java.lang.String:A-">main</a></span>(java.lang.String[]&nbsp;args)</code>
<div class="block">Usage:</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbResetRepGroup.html#reset--">reset</a></span>()</code>
<div class="block">Replaces the existing group with the new group having a single new node
as described by the constructor arguments.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DbResetRepGroup-java.io.File-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DbResetRepGroup</h4>
<pre>public&nbsp;DbResetRepGroup(java.io.File&nbsp;envHome,
java.lang.String&nbsp;groupName,
java.lang.String&nbsp;nodeName,
java.lang.String&nbsp;nodeHostPort)</pre>
<div class="block">Create a DbResetRepGroup object for this node.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>envHome</code> - The node's replicated environment directory. The
directory must be accessible on this host.</dd>
<dd><code>groupName</code> - The name of the new replication group</dd>
<dd><code>nodeName</code> - The node's name</dd>
<dd><code>nodeHostPort</code> - The host and port for this node. The utility
must be executed on this host.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="main-java.lang.String:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>main</h4>
<pre>public static&nbsp;void&nbsp;main(java.lang.String[]&nbsp;args)</pre>
<div class="block">Usage:
<pre>
java -cp je.jar com.sleepycat.je.rep.util.DbResetRepGroup
-h &lt;dir&gt; # environment home directory
-groupName &lt;group name&gt; # replication group name
-nodeName &lt;node name&gt; # replicated node name
-nodeHostPort &lt;host name:port number&gt; # host name or IP address
and port number to use
for this node
</pre></div>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block">Replaces the existing group with the new group having a single new node
as described by the constructor arguments.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../com/sleepycat/je/rep/util/DbResetRepGroup.html" title="class in com.sleepycat.je.rep.util"><code>DbResetRepGroup</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DbResetRepGroup.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB Java Edition</b><br><font size=\"-1\"> version 7.5.11</font>
</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../com/sleepycat/je/rep/util/DbPing.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/sleepycat/je/rep/util/ReplicationGroupAdmin.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/sleepycat/je/rep/util/DbResetRepGroup.html" target="_top">Frames</a></li>
<li><a href="DbResetRepGroup.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 2002, 2017 Oracle and/or its affiliates. All rights reserved.</font> </small></p>
</body>
</html>