Published site at d5aaeee88b331e064830a2774f4fed238631457c.
[hbase-site.git] / devapidocs / org / apache / hadoop / hbase / backup / HBackupFileSystem.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc -->
6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 <title>HBackupFileSystem (Apache HBase 3.0.0-SNAPSHOT API)</title>
8 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../../../script.js"></script>
10 </head>
11 <body>
12 <script type="text/javascript"><!--
13 try {
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="HBackupFileSystem (Apache HBase 3.0.0-SNAPSHOT API)";
16 }
17 }
18 catch(err) {
19 }
20 //-->
21 var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
27 </script>
28 <noscript>
29 <div>JavaScript is disabled on your browser.</div>
30 </noscript>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
33 <!-- -->
34 </a>
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
37 <!-- -->
38 </a>
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/HBackupFileSystem.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../../../../index-all.html">Index</a></li>
47 <li><a href="../../../../../help-doc.html">Help</a></li>
48 </ul>
49 </div>
50 <div class="subNav">
51 <ul class="navList">
52 <li><a href="../../../../../org/apache/hadoop/hbase/backup/FailedArchiveException.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
53 <li><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
54 </ul>
55 <ul class="navList">
56 <li><a href="../../../../../index.html?org/apache/hadoop/hbase/backup/HBackupFileSystem.html" target="_top">Frames</a></li>
57 <li><a href="HBackupFileSystem.html" target="_top">No&nbsp;Frames</a></li>
58 </ul>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
61 </ul>
62 <div>
63 <script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
65 if(window==top) {
66 allClassesLink.style.display = "block";
67 }
68 else {
69 allClassesLink.style.display = "none";
70 }
71 //-->
72 </script>
73 </div>
74 <div>
75 <ul class="subNavList">
76 <li>Summary:&nbsp;</li>
77 <li>Nested&nbsp;|&nbsp;</li>
78 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
80 <li><a href="#method.summary">Method</a></li>
81 </ul>
82 <ul class="subNavList">
83 <li>Detail:&nbsp;</li>
84 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
86 <li><a href="#method.detail">Method</a></li>
87 </ul>
88 </div>
89 <a name="skip.navbar.top">
90 <!-- -->
91 </a></div>
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
94 <div class="header">
95 <div class="subTitle">org.apache.hadoop.hbase.backup</div>
96 <h2 title="Class HBackupFileSystem" class="title">Class HBackupFileSystem</h2>
97 </div>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
101 <li>
102 <ul class="inheritance">
103 <li>org.apache.hadoop.hbase.backup.HBackupFileSystem</li>
104 </ul>
105 </li>
106 </ul>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
110 <hr>
111 <br>
112 <pre>@InterfaceAudience.Private
113 public final class <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.40">HBackupFileSystem</a>
114 extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
115 <div class="block">View to an on-disk Backup Image FileSytem Provides the set of methods necessary to interact with
116 the on-disk Backup Image data.</div>
117 </li>
118 </ul>
119 </div>
120 <div class="summary">
121 <ul class="blockList">
122 <li class="blockList">
123 <!-- =========== FIELD SUMMARY =========== -->
124 <ul class="blockList">
125 <li class="blockList"><a name="field.summary">
126 <!-- -->
127 </a>
128 <h3>Field Summary</h3>
129 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
130 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
131 <tr>
132 <th class="colFirst" scope="col">Modifier and Type</th>
133 <th class="colLast" scope="col">Field and Description</th>
134 </tr>
135 <tr class="altColor">
136 <td class="colFirst"><code>static org.slf4j.Logger</code></td>
137 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#LOG">LOG</a></span></code>&nbsp;</td>
138 </tr>
139 </table>
140 </li>
141 </ul>
142 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
143 <ul class="blockList">
144 <li class="blockList"><a name="constructor.summary">
145 <!-- -->
146 </a>
147 <h3>Constructor Summary</h3>
148 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
149 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
150 <tr>
151 <th class="colFirst" scope="col">Modifier</th>
152 <th class="colLast" scope="col">Constructor and Description</th>
153 </tr>
154 <tr class="altColor">
155 <td class="colFirst"><code>private </code></td>
156 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#HBackupFileSystem--">HBackupFileSystem</a></span>()</code>
157 <div class="block">This is utility class.</div>
158 </td>
159 </tr>
160 </table>
161 </li>
162 </ul>
163 <!-- ========== METHOD SUMMARY =========== -->
164 <ul class="blockList">
165 <li class="blockList"><a name="method.summary">
166 <!-- -->
167 </a>
168 <h3>Method Summary</h3>
169 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
170 <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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
171 <tr>
172 <th class="colFirst" scope="col">Modifier and Type</th>
173 <th class="colLast" scope="col">Method and Description</th>
174 </tr>
175 <tr id="i0" class="altColor">
176 <td class="colFirst"><code>static void</code></td>
177 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#checkImageManifestExist-java.util.HashMap-org.apache.hadoop.hbase.TableName:A-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-">checkImageManifestExist</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>,<a href="../../../../../org/apache/hadoop/hbase/backup/impl/BackupManifest.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManifest</a>&gt;&nbsp;backupManifestMap,
178 <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>[]&nbsp;tableArray,
179 org.apache.hadoop.conf.Configuration&nbsp;conf,
180 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
181 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>
182 <div class="block">Check whether the backup image path and there is manifest file in the path.</div>
183 </td>
184 </tr>
185 <tr id="i1" class="rowColor">
186 <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td>
187 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getBackupPath-java.lang.String-java.lang.String-">getBackupPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
188 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>&nbsp;</td>
189 </tr>
190 <tr id="i2" class="altColor">
191 <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td>
192 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getBackupTmpDirPath-java.lang.String-">getBackupTmpDirPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir)</code>
193 <div class="block">Get backup temporary directory</div>
194 </td>
195 </tr>
196 <tr id="i3" class="rowColor">
197 <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td>
198 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getBackupTmpDirPathForBackupId-java.lang.String-java.lang.String-">getBackupTmpDirPathForBackupId</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRoot,
199 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>
200 <div class="block">Get backup tmp directory for backupId</div>
201 </td>
202 </tr>
203 <tr id="i4" class="altColor">
204 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
205 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getLogBackupDir-java.lang.String-java.lang.String-">getLogBackupDir</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
206 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>
207 <div class="block">Given the backup root dir and the backup id, return the log file location for an incremental
208 backup.</div>
209 </td>
210 </tr>
211 <tr id="i5" class="rowColor">
212 <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td>
213 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getLogBackupPath-java.lang.String-java.lang.String-">getLogBackupPath</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
214 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>&nbsp;</td>
215 </tr>
216 <tr id="i6" class="altColor">
217 <td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/hbase/backup/impl/BackupManifest.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManifest</a></code></td>
218 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getManifest-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-">getManifest</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
219 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
220 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>&nbsp;</td>
221 </tr>
222 <tr id="i7" class="rowColor">
223 <td class="colFirst"><code>private static org.apache.hadoop.fs.Path</code></td>
224 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getManifestPath-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-">getManifestPath</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf,
225 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
226 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>&nbsp;</td>
227 </tr>
228 <tr id="i8" class="altColor">
229 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
230 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getTableBackupDataDir-java.lang.String-java.lang.String-org.apache.hadoop.hbase.TableName-">getTableBackupDataDir</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
231 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId,
232 <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</code>&nbsp;</td>
233 </tr>
234 <tr id="i9" class="rowColor">
235 <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
236 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getTableBackupDir-java.lang.String-java.lang.String-org.apache.hadoop.hbase.TableName-">getTableBackupDir</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
237 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId,
238 <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</code>
239 <div class="block">Given the backup root dir, backup id and the table name, return the backup image location,
240 which is also where the backup manifest file is.</div>
241 </td>
242 </tr>
243 <tr id="i10" class="altColor">
244 <td class="colFirst"><code>static org.apache.hadoop.fs.Path</code></td>
245 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html#getTableBackupPath-org.apache.hadoop.hbase.TableName-org.apache.hadoop.fs.Path-java.lang.String-">getTableBackupPath</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName,
246 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
247 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</code>
248 <div class="block">Given the backup root dir, backup id and the table name, return the backup image location,
249 which is also where the backup manifest file is.</div>
250 </td>
251 </tr>
252 </table>
253 <ul class="blockList">
254 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
255 <!-- -->
256 </a>
257 <h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
258 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
259 </ul>
260 </li>
261 </ul>
262 </li>
263 </ul>
264 </div>
265 <div class="details">
266 <ul class="blockList">
267 <li class="blockList">
268 <!-- ============ FIELD DETAIL =========== -->
269 <ul class="blockList">
270 <li class="blockList"><a name="field.detail">
271 <!-- -->
272 </a>
273 <h3>Field Detail</h3>
274 <a name="LOG">
275 <!-- -->
276 </a>
277 <ul class="blockListLast">
278 <li class="blockList">
279 <h4>LOG</h4>
280 <pre>public static final&nbsp;org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.41">LOG</a></pre>
281 </li>
282 </ul>
283 </li>
284 </ul>
285 <!-- ========= CONSTRUCTOR DETAIL ======== -->
286 <ul class="blockList">
287 <li class="blockList"><a name="constructor.detail">
288 <!-- -->
289 </a>
290 <h3>Constructor Detail</h3>
291 <a name="HBackupFileSystem--">
292 <!-- -->
293 </a>
294 <ul class="blockListLast">
295 <li class="blockList">
296 <h4>HBackupFileSystem</h4>
297 <pre>private&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.46">HBackupFileSystem</a>()</pre>
298 <div class="block">This is utility class.</div>
299 </li>
300 </ul>
301 </li>
302 </ul>
303 <!-- ============ METHOD DETAIL ========== -->
304 <ul class="blockList">
305 <li class="blockList"><a name="method.detail">
306 <!-- -->
307 </a>
308 <h3>Method Detail</h3>
309 <a name="getTableBackupDir-java.lang.String-java.lang.String-org.apache.hadoop.hbase.TableName-">
310 <!-- -->
311 </a>
312 <ul class="blockList">
313 <li class="blockList">
314 <h4>getTableBackupDir</h4>
315 <pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.60">getTableBackupDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
316 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId,
317 <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</pre>
318 <div class="block">Given the backup root dir, backup id and the table name, return the backup image location,
319 which is also where the backup manifest file is. return value look like:
320 "hdfs://backup.hbase.org:9000/user/biadmin/backup/backup_1396650096738/default/t1_dn/", where
321 "hdfs://backup.hbase.org:9000/user/biadmin/backup" is a backup root directory</div>
322 <dl>
323 <dt><span class="paramLabel">Parameters:</span></dt>
324 <dd><code>backupRootDir</code> - backup root directory</dd>
325 <dd><code>backupId</code> - backup id</dd>
326 <dd><code>tableName</code> - table name</dd>
327 <dt><span class="returnLabel">Returns:</span></dt>
328 <dd>backupPath String for the particular table</dd>
329 </dl>
330 </li>
331 </ul>
332 <a name="getBackupTmpDirPath-java.lang.String-">
333 <!-- -->
334 </a>
335 <ul class="blockList">
336 <li class="blockList">
337 <h4>getBackupTmpDirPath</h4>
338 <pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.71">getBackupTmpDirPath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir)</pre>
339 <div class="block">Get backup temporary directory</div>
340 <dl>
341 <dt><span class="paramLabel">Parameters:</span></dt>
342 <dd><code>backupRootDir</code> - backup root</dd>
343 <dt><span class="returnLabel">Returns:</span></dt>
344 <dd>backup tmp directory path</dd>
345 </dl>
346 </li>
347 </ul>
348 <a name="getBackupTmpDirPathForBackupId-java.lang.String-java.lang.String-">
349 <!-- -->
350 </a>
351 <ul class="blockList">
352 <li class="blockList">
353 <h4>getBackupTmpDirPathForBackupId</h4>
354 <pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.81">getBackupTmpDirPathForBackupId</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRoot,
355 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</pre>
356 <div class="block">Get backup tmp directory for backupId</div>
357 <dl>
358 <dt><span class="paramLabel">Parameters:</span></dt>
359 <dd><code>backupRoot</code> - backup root</dd>
360 <dd><code>backupId</code> - backup id</dd>
361 <dt><span class="returnLabel">Returns:</span></dt>
362 <dd>backup tmp directory path</dd>
363 </dl>
364 </li>
365 </ul>
366 <a name="getTableBackupDataDir-java.lang.String-java.lang.String-org.apache.hadoop.hbase.TableName-">
367 <!-- -->
368 </a>
369 <ul class="blockList">
370 <li class="blockList">
371 <h4>getTableBackupDataDir</h4>
372 <pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.85">getTableBackupDataDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
373 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId,
374 <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</pre>
375 </li>
376 </ul>
377 <a name="getBackupPath-java.lang.String-java.lang.String-">
378 <!-- -->
379 </a>
380 <ul class="blockList">
381 <li class="blockList">
382 <h4>getBackupPath</h4>
383 <pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.90">getBackupPath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
384 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</pre>
385 </li>
386 </ul>
387 <a name="getTableBackupPath-org.apache.hadoop.hbase.TableName-org.apache.hadoop.fs.Path-java.lang.String-">
388 <!-- -->
389 </a>
390 <ul class="blockList">
391 <li class="blockList">
392 <h4>getTableBackupPath</h4>
393 <pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.104">getTableBackupPath</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName,
394 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
395 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</pre>
396 <div class="block">Given the backup root dir, backup id and the table name, return the backup image location,
397 which is also where the backup manifest file is. return value look like:
398 "hdfs://backup.hbase.org:9000/user/biadmin/backup/backup_1396650096738/default/t1_dn/", where
399 "hdfs://backup.hbase.org:9000/user/biadmin/backup" is a backup root directory</div>
400 <dl>
401 <dt><span class="paramLabel">Parameters:</span></dt>
402 <dd><code>backupRootPath</code> - backup root path</dd>
403 <dd><code>tableName</code> - table name</dd>
404 <dd><code>backupId</code> - backup Id</dd>
405 <dt><span class="returnLabel">Returns:</span></dt>
406 <dd>backupPath for the particular table</dd>
407 </dl>
408 </li>
409 </ul>
410 <a name="getLogBackupDir-java.lang.String-java.lang.String-">
411 <!-- -->
412 </a>
413 <ul class="blockList">
414 <li class="blockList">
415 <h4>getLogBackupDir</h4>
416 <pre>public static&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.115">getLogBackupDir</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
417 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</pre>
418 <div class="block">Given the backup root dir and the backup id, return the log file location for an incremental
419 backup.</div>
420 <dl>
421 <dt><span class="paramLabel">Parameters:</span></dt>
422 <dd><code>backupRootDir</code> - backup root directory</dd>
423 <dd><code>backupId</code> - backup id</dd>
424 <dt><span class="returnLabel">Returns:</span></dt>
425 <dd>logBackupDir: ".../user/biadmin/backup/WALs/backup_1396650096738"</dd>
426 </dl>
427 </li>
428 </ul>
429 <a name="getLogBackupPath-java.lang.String-java.lang.String-">
430 <!-- -->
431 </a>
432 <ul class="blockList">
433 <li class="blockList">
434 <h4>getLogBackupPath</h4>
435 <pre>public static&nbsp;org.apache.hadoop.fs.Path&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.120">getLogBackupPath</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupRootDir,
436 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)</pre>
437 </li>
438 </ul>
439 <a name="getManifestPath-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-">
440 <!-- -->
441 </a>
442 <ul class="blockList">
443 <li class="blockList">
444 <h4>getManifestPath</h4>
445 <pre>private static&nbsp;org.apache.hadoop.fs.Path&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.126">getManifestPath</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
446 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
447 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)
448 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
449 <dl>
450 <dt><span class="throwsLabel">Throws:</span></dt>
451 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
452 </dl>
453 </li>
454 </ul>
455 <a name="getManifest-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-">
456 <!-- -->
457 </a>
458 <ul class="blockList">
459 <li class="blockList">
460 <h4>getManifest</h4>
461 <pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/hbase/backup/impl/BackupManifest.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManifest</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.143">getManifest</a>(org.apache.hadoop.conf.Configuration&nbsp;conf,
462 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
463 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)
464 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
465 <dl>
466 <dt><span class="throwsLabel">Throws:</span></dt>
467 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
468 </dl>
469 </li>
470 </ul>
471 <a name="checkImageManifestExist-java.util.HashMap-org.apache.hadoop.hbase.TableName:A-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.Path-java.lang.String-">
472 <!-- -->
473 </a>
474 <ul class="blockListLast">
475 <li class="blockList">
476 <h4>checkImageManifestExist</h4>
477 <pre>public static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HBackupFileSystem.html#line.155">checkImageManifestExist</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util">HashMap</a>&lt;<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>,<a href="../../../../../org/apache/hadoop/hbase/backup/impl/BackupManifest.html" title="class in org.apache.hadoop.hbase.backup.impl">BackupManifest</a>&gt;&nbsp;backupManifestMap,
478 <a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>[]&nbsp;tableArray,
479 org.apache.hadoop.conf.Configuration&nbsp;conf,
480 org.apache.hadoop.fs.Path&nbsp;backupRootPath,
481 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;backupId)
482 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
483 <div class="block">Check whether the backup image path and there is manifest file in the path.</div>
484 <dl>
485 <dt><span class="paramLabel">Parameters:</span></dt>
486 <dd><code>backupManifestMap</code> - If all the manifests are found, then they are put into this map</dd>
487 <dd><code>tableArray</code> - the tables involved</dd>
488 <dt><span class="throwsLabel">Throws:</span></dt>
489 <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - exception</dd>
490 </dl>
491 </li>
492 </ul>
493 </li>
494 </ul>
495 </li>
496 </ul>
497 </div>
498 </div>
499 <!-- ========= END OF CLASS DATA ========= -->
500 <!-- ======= START OF BOTTOM NAVBAR ====== -->
501 <div class="bottomNav"><a name="navbar.bottom">
502 <!-- -->
503 </a>
504 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
505 <a name="navbar.bottom.firstrow">
506 <!-- -->
507 </a>
508 <ul class="navList" title="Navigation">
509 <li><a href="../../../../../overview-summary.html">Overview</a></li>
510 <li><a href="package-summary.html">Package</a></li>
511 <li class="navBarCell1Rev">Class</li>
512 <li><a href="class-use/HBackupFileSystem.html">Use</a></li>
513 <li><a href="package-tree.html">Tree</a></li>
514 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
515 <li><a href="../../../../../index-all.html">Index</a></li>
516 <li><a href="../../../../../help-doc.html">Help</a></li>
517 </ul>
518 </div>
519 <div class="subNav">
520 <ul class="navList">
521 <li><a href="../../../../../org/apache/hadoop/hbase/backup/FailedArchiveException.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
522 <li><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
523 </ul>
524 <ul class="navList">
525 <li><a href="../../../../../index.html?org/apache/hadoop/hbase/backup/HBackupFileSystem.html" target="_top">Frames</a></li>
526 <li><a href="HBackupFileSystem.html" target="_top">No&nbsp;Frames</a></li>
527 </ul>
528 <ul class="navList" id="allclasses_navbar_bottom">
529 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
530 </ul>
531 <div>
532 <script type="text/javascript"><!--
533 allClassesLink = document.getElementById("allclasses_navbar_bottom");
534 if(window==top) {
535 allClassesLink.style.display = "block";
536 }
537 else {
538 allClassesLink.style.display = "none";
539 }
540 //-->
541 </script>
542 </div>
543 <div>
544 <ul class="subNavList">
545 <li>Summary:&nbsp;</li>
546 <li>Nested&nbsp;|&nbsp;</li>
547 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
548 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
549 <li><a href="#method.summary">Method</a></li>
550 </ul>
551 <ul class="subNavList">
552 <li>Detail:&nbsp;</li>
553 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
554 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
555 <li><a href="#method.detail">Method</a></li>
556 </ul>
557 </div>
558 <a name="skip.navbar.bottom">
559 <!-- -->
560 </a></div>
561 <!-- ======== END OF BOTTOM NAVBAR ======= -->
562 <p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
563 </body>
564 </html>