394 lines
16 KiB
HTML
394 lines
16 KiB
HTML
<!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>DbEnableReplication (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="DbEnableReplication (Oracle - Berkeley DB Java Edition API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":9};
|
|
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/DbEnableReplication.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/AtomicLongMax.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/sleepycat/je/rep/util/DbEnableReplication.html" target="_top">Frames</a></li>
|
|
<li><a href="DbEnableReplication.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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 DbEnableReplication" class="title">Class DbEnableReplication</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.je.rep.util.DbEnableReplication</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">DbEnableReplication</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">A utility to convert an existing, non replicated JE environment for
|
|
replication. This is useful when the user wants to initially prototype and
|
|
develop a standalone transactional application, and then add replication as
|
|
a second stage.
|
|
<p>
|
|
JE HA environment log files contain types of log records and metadata used
|
|
only by replication. Non replicated environments are lacking that
|
|
information and must undergo a one time conversion process to add that
|
|
metadata and enable replication. The conversion process is one way. Once an
|
|
environment directory is converted, the rules that govern <a href="../../../../../com/sleepycat/je/rep/ReplicatedEnvironment.html" title="class in com.sleepycat.je.rep"><code>ReplicatedEnvironment</code></a> apply; namely, the directory cannot be opened by a
|
|
read/write standalone <a href="../../../../../com/sleepycat/je/Environment.html" title="class in com.sleepycat.je"><code>Environment</code></a>. Only a minimum
|
|
amount of replication metadata is added, and the conversion process is not
|
|
dependent on the size of the existing directory.
|
|
<p>
|
|
The conversion process takes these steps:
|
|
<ol>
|
|
<li> Use <code>DbEnableReplication</code> to convert an existing environment
|
|
directory. <code>DbEnableReplication</code> can be used as a command line
|
|
utility, and must be executed locally on the host which houses the
|
|
environment directory. Alternatively, <code>DbEnableReplication</code> may be
|
|
used programmatically through the provided APIs.
|
|
</li>
|
|
<li> Once converted, the environment directory may be treated as an existing
|
|
master node, and can be opened with a <code>ReplicatedEnvironment</code>. No
|
|
helper host configuration is needed.
|
|
<li> Additional nodes may 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 converted 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">
|
|
// Create the first node using an existing environment
|
|
DbEnableReplication converter =
|
|
new DbEnableReplication(envDirMars, // env home dir
|
|
"UniversalRepGroup", // group name
|
|
"nodeMars", // node name
|
|
"mars:5001"); // node host,port
|
|
converter.convert();
|
|
|
|
ReplicatedEnvironment nodeMars = new ReplicatedEnvironment(envDirMars, ...);
|
|
|
|
// Bring up additional nodes, which will be initialized from
|
|
// nodeMars.
|
|
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
|
|
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"> </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/DbEnableReplication.html#DbEnableReplication-java.io.File-java.lang.String-java.lang.String-java.lang.String-">DbEnableReplication</a></span>(java.io.File envHome,
|
|
java.lang.String groupName,
|
|
java.lang.String nodeName,
|
|
java.lang.String nodeHostPort)</code>
|
|
<div class="block">Create a DbEnableReplication 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"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbEnableReplication.html#convert--">convert</a></span>()</code>
|
|
<div class="block">Modify the log files in the environment directory to add a modicum of
|
|
replication required metadata.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/sleepycat/je/rep/util/DbEnableReplication.html#main-java.lang.String:A-">main</a></span>(java.lang.String[] args)</code>
|
|
<div class="block">Usage:</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 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="DbEnableReplication-java.io.File-java.lang.String-java.lang.String-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>DbEnableReplication</h4>
|
|
<pre>public DbEnableReplication(java.io.File envHome,
|
|
java.lang.String groupName,
|
|
java.lang.String nodeName,
|
|
java.lang.String nodeHostPort)</pre>
|
|
<div class="block">Create a DbEnableReplication object for this node.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>envHome</code> - The node's environment directory</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</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 void main(java.lang.String[] args)</pre>
|
|
<div class="block">Usage:
|
|
<pre>
|
|
java -cp je.jar com.sleepycat.je.rep.util.DbEnableReplication
|
|
-h <dir> # environment home directory
|
|
-groupName <group name> # replication group name
|
|
-nodeName <node name> # replicated node name
|
|
-nodeHostPort <host name:port number> # host name or IP address
|
|
and port number to use
|
|
for this node
|
|
</pre></div>
|
|
</li>
|
|
</ul>
|
|
<a name="convert--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>convert</h4>
|
|
<pre>public void convert()</pre>
|
|
<div class="block">Modify the log files in the environment directory to add a modicum of
|
|
replication required metadata.</div>
|
|
</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/DbEnableReplication.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/AtomicLongMax.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../../../../com/sleepycat/je/rep/util/DbGroupAdmin.html" title="class in com.sleepycat.je.rep.util"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../../index.html?com/sleepycat/je/rep/util/DbEnableReplication.html" target="_top">Frames</a></li>
|
|
<li><a href="DbEnableReplication.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../../../allclasses-noframe.html">All 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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>
|