| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>HFileArchiver (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.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="HFileArchiver (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/HFileArchiver.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/backup/HFileArchiver.html" target="_top">Frames</a></li> |
| <li><a href="HFileArchiver.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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">org.apache.hadoop.hbase.backup</div> |
| <h2 title="Class HFileArchiver" class="title">Class HFileArchiver</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <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> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.hadoop.hbase.backup.HFileArchiver</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.Private |
| public class <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.63">HFileArchiver</a> |
| 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> |
| <div class="block">Utility class to handle the removal of HFiles (or the respective <a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>StoreFiles</code></a>) |
| for a HRegion from the <code>FileSystem</code>. The hfiles will be archived or deleted, depending on |
| the state of the system.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a></span></code> |
| <div class="block">Wrapper to handle file operations uniformly</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.FileablePath.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileablePath</a></span></code> |
| <div class="block">A <a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><code>HFileArchiver.File</code></a> that wraps a simple <code>Path</code> on a <code>FileSystem</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.FileableStoreFile.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileableStoreFile</a></span></code> |
| <div class="block"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><code>HFileArchiver.File</code></a> adapter for a <a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HStoreFile</code></a> living on a <code>FileSystem</code> |
| .</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.FileConverter.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileConverter</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.FileConverter.html" title="type parameter in HFileArchiver.FileConverter">T</a>></span></code> |
| <div class="block">Adapt a type to match the <a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><code>HFileArchiver.File</code></a> interface, which is used internally for handling |
| archival/removal of files</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.FileStatusConverter.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileStatusConverter</a></span></code> |
| <div class="block">Convert a FileStatus to something we can manage in the archiving</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.StoreToFile.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.StoreToFile</a></span></code> |
| <div class="block">Convert the <a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HStoreFile</code></a> into something we can manage in the archive |
| methods</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadPoolExecutor.html?is-external=true" title="class or interface in java.util.concurrent">ThreadPoolExecutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveExecutor">archiveExecutor</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#DEFAULT_RETRIES_NUMBER">DEFAULT_RETRIES_NUMBER</a></span></code> |
| <div class="block">Number of retries in case of fs operation failure</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a>,org.apache.hadoop.fs.Path></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#FUNC_FILE_TO_PATH">FUNC_FILE_TO_PATH</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>private static org.slf4j.Logger</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#LOG">LOG</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private 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> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#SEPARATOR">SEPARATOR</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>private </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#HFileArchiver--">HFileArchiver</a></span>()</code> </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="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>private static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archive-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-byte:A-java.util.Collection-org.apache.hadoop.fs.Path-">archive</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| byte[] family, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> compactedFiles, |
| org.apache.hadoop.fs.Path storeArchiveDir)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveFamily-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-">archiveFamily</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> parent, |
| org.apache.hadoop.fs.Path tableDir, |
| byte[] family)</code> |
| <div class="block">Remove from the specified region the store files of the specified column family, |
| either by archiving them or outright deletion</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveFamilyByFamilyDir-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-">archiveFamilyByFamilyDir</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> parent, |
| org.apache.hadoop.fs.Path familyDir, |
| byte[] family)</code> |
| <div class="block">Removes from the specified region the store files of the specified column family, |
| either by archiving them or outright deletion</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveRecoveredEdits-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-byte:A-java.util.Collection-">archiveRecoveredEdits</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| byte[] family, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> replayedEdits)</code> |
| <div class="block">Archive recovered edits using existing logic for archiving store files.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveRegion-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-">archiveRegion</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> info)</code> |
| <div class="block">Cleans up all the files for a HRegion by archiving the HFiles to the archive directory</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveRegion-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-">archiveRegion</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| org.apache.hadoop.fs.Path tableDir, |
| org.apache.hadoop.fs.Path regionDir)</code> |
| <div class="block">Remove an entire region from the table directory via archiving the region's hfiles.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveRegions-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.util.List-">archiveRegions</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.fs.Path tableDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.fs.Path> regionDirList)</code> |
| <div class="block">Archive the specified regions in parallel.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveStoreFile-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-org.apache.hadoop.fs.Path-">archiveStoreFile</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| org.apache.hadoop.fs.Path tableDir, |
| byte[] family, |
| org.apache.hadoop.fs.Path storeFile)</code> |
| <div class="block">Archive the store file</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#archiveStoreFiles-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-java.util.Collection-">archiveStoreFiles</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| org.apache.hadoop.fs.Path tableDir, |
| byte[] family, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> compactedFiles)</code> |
| <div class="block">Remove the store files, either by archiving them or outright deletion</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>private static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#deleteRegionWithoutArchiving-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-">deleteRegionWithoutArchiving</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path regionDir)</code> |
| <div class="block">Without regard for backup, delete a region.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>private static void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#deleteStoreFilesWithoutArchiving-java.util.Collection-">deleteStoreFilesWithoutArchiving</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> compactedFiles)</code> |
| <div class="block">Just do a simple delete of the given store files</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#exists-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-">exists</a></span>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> info)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadPoolExecutor.html?is-external=true" title="class or interface in java.util.concurrent">ThreadPoolExecutor</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#getArchiveExecutor-org.apache.hadoop.conf.Configuration-">getArchiveExecutor</a></span>(org.apache.hadoop.conf.Configuration conf)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadFactory.html?is-external=true" title="class or interface in java.util.concurrent">ThreadFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#getThreadFactory--">getThreadFactory</a></span>()</code> </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#resolveAndArchive-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-java.util.Collection-long-">resolveAndArchive</a></span>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path baseArchiveDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a>> toArchive, |
| long start)</code> |
| <div class="block">Resolve any conflict with an existing archive file via timestamp-append |
| renaming of the existing file and then archive the passed in files.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>private static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.html#resolveAndArchiveFile-org.apache.hadoop.fs.Path-org.apache.hadoop.hbase.backup.HFileArchiver.File-java.lang.String-">resolveAndArchiveFile</a></span>(org.apache.hadoop.fs.Path archiveDir, |
| <a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a> currentFile, |
| <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> archiveStartTime)</code> |
| <div class="block">Attempt to archive the passed in file to the archive directory.</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.<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> |
| <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> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="LOG"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LOG</h4> |
| <pre>private static final org.slf4j.Logger <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.64">LOG</a></pre> |
| </li> |
| </ul> |
| <a name="SEPARATOR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SEPARATOR</h4> |
| <pre>private static final <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> <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.65">SEPARATOR</a></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.backup.HFileArchiver.SEPARATOR">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DEFAULT_RETRIES_NUMBER"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DEFAULT_RETRIES_NUMBER</h4> |
| <pre>private static final int <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.68">DEFAULT_RETRIES_NUMBER</a></pre> |
| <div class="block">Number of retries in case of fs operation failure</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.backup.HFileArchiver.DEFAULT_RETRIES_NUMBER">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FUNC_FILE_TO_PATH"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FUNC_FILE_TO_PATH</h4> |
| <pre>private static final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html?is-external=true" title="class or interface in java.util.function">Function</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a>,org.apache.hadoop.fs.Path> <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.70">FUNC_FILE_TO_PATH</a></pre> |
| </li> |
| </ul> |
| <a name="archiveExecutor"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>archiveExecutor</h4> |
| <pre>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadPoolExecutor.html?is-external=true" title="class or interface in java.util.concurrent">ThreadPoolExecutor</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.78">archiveExecutor</a></pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="HFileArchiver--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HFileArchiver</h4> |
| <pre>private <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.80">HFileArchiver</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="exists-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>exists</h4> |
| <pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.87">exists</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> info) |
| 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> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if the Region exits in the filesystem.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveRegion-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveRegion</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.100">archiveRegion</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> info) |
| 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> |
| <div class="block">Cleans up all the files for a HRegion by archiving the HFiles to the archive directory</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to use</dd> |
| <dd><code>fs</code> - the file system object</dd> |
| <dd><code>info</code> - RegionInfo for region to be deleted</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveRegion-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveRegion</h4> |
| <pre>public static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.118">archiveRegion</a>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| org.apache.hadoop.fs.Path tableDir, |
| org.apache.hadoop.fs.Path regionDir) |
| 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> |
| <div class="block">Remove an entire region from the table directory via archiving the region's hfiles.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - <code>FileSystem</code> from which to remove the region</dd> |
| <dd><code>rootdir</code> - <code>Path</code> to the root directory where hbase files are stored (for building |
| the archive path)</dd> |
| <dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive path)</dd> |
| <dd><code>regionDir</code> - <code>Path</code> to where a region is being stored (for building the archive path)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if the region was successfully deleted. <tt>false</tt> if the filesystem |
| operations could not complete.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if the request cannot be completed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveRegions-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-org.apache.hadoop.fs.Path-java.util.List-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveRegions</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.186">archiveRegions</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootDir, |
| org.apache.hadoop.fs.Path tableDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.hadoop.fs.Path> regionDirList) |
| 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> |
| <div class="block">Archive the specified regions in parallel.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - the configuration to use</dd> |
| <dd><code>fs</code> - <code>FileSystem</code> from which to remove the region</dd> |
| <dd><code>rootDir</code> - <code>Path</code> to the root directory where hbase files are stored (for building |
| the archive path)</dd> |
| <dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive |
| path)</dd> |
| <dd><code>regionDirList</code> - <code>Path</code> to where regions are being stored (for building the archive |
| path)</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if the request cannot be completed</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getArchiveExecutor-org.apache.hadoop.conf.Configuration-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArchiveExecutor</h4> |
| <pre>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadPoolExecutor.html?is-external=true" title="class or interface in java.util.concurrent">ThreadPoolExecutor</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.207">getArchiveExecutor</a>(org.apache.hadoop.conf.Configuration conf)</pre> |
| </li> |
| </ul> |
| <a name="getThreadFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getThreadFactory</h4> |
| <pre>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ThreadFactory.html?is-external=true" title="class or interface in java.util.concurrent">ThreadFactory</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.223">getThreadFactory</a>()</pre> |
| </li> |
| </ul> |
| <a name="archiveFamily-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveFamily</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.247">archiveFamily</a>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> parent, |
| org.apache.hadoop.fs.Path tableDir, |
| byte[] family) |
| 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> |
| <div class="block">Remove from the specified region the store files of the specified column family, |
| either by archiving them or outright deletion</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - the filesystem where the store files live</dd> |
| <dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd> |
| <dd><code>parent</code> - Parent region hosting the store files</dd> |
| <dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive path)</dd> |
| <dd><code>family</code> - the family hosting the store files</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if the files could not be correctly disposed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveFamilyByFamilyDir-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.conf.Configuration-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveFamilyByFamilyDir</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.263">archiveFamilyByFamilyDir</a>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> parent, |
| org.apache.hadoop.fs.Path familyDir, |
| byte[] family) |
| 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> |
| <div class="block">Removes from the specified region the store files of the specified column family, |
| either by archiving them or outright deletion</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - the filesystem where the store files live</dd> |
| <dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd> |
| <dd><code>parent</code> - Parent region hosting the store files</dd> |
| <dd><code>familyDir</code> - <code>Path</code> to where the family is being stored</dd> |
| <dd><code>family</code> - the family hosting the store files</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if the files could not be correctly disposed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveStoreFiles-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveStoreFiles</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.297">archiveStoreFiles</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| org.apache.hadoop.fs.Path tableDir, |
| byte[] family, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> compactedFiles) |
| 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> |
| <div class="block">Remove the store files, either by archiving them or outright deletion</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd> |
| <dd><code>fs</code> - the filesystem where the store files live</dd> |
| <dd><code>regionInfo</code> - <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a> of the region hosting the store files</dd> |
| <dd><code>family</code> - the family hosting the store files</dd> |
| <dd><code>compactedFiles</code> - files to be disposed of. No further reading of these files should be |
| attempted; otherwise likely to cause an <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if the files could not be correctly disposed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveRecoveredEdits-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-byte:A-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveRecoveredEdits</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.318">archiveRecoveredEdits</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| byte[] family, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> replayedEdits) |
| 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> |
| <div class="block">Archive recovered edits using existing logic for archiving store files. This is currently only |
| relevant when <b>hbase.region.archive.recovered.edits</b> is true, as recovered edits shouldn't |
| be kept after replay. In theory, we could use very same method available for archiving |
| store files, but supporting WAL dir and store files on different FileSystems added the need for |
| extra validation of the passed FileSystem instance and the path where the archiving edits |
| should be placed.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>conf</code> - <code>Configuration</code> to determine the archive directory.</dd> |
| <dd><code>fs</code> - the filesystem used for storing WAL files.</dd> |
| <dd><code>regionInfo</code> - <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a> a pseudo region representation for the archiving logic.</dd> |
| <dd><code>family</code> - a pseudo familiy representation for the archiving logic.</dd> |
| <dd><code>replayedEdits</code> - the recovered edits to be archived.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if files can't be achived due to some internal error.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="archive-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-byte:A-java.util.Collection-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archive</h4> |
| <pre>private static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.336">archive</a>(org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| byte[] family, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> compactedFiles, |
| org.apache.hadoop.fs.Path storeArchiveDir) |
| 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> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a name="archiveStoreFile-org.apache.hadoop.conf.Configuration-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.hbase.client.RegionInfo-org.apache.hadoop.fs.Path-byte:A-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>archiveStoreFile</h4> |
| <pre>public static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.391">archiveStoreFile</a>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| org.apache.hadoop.fs.Path tableDir, |
| byte[] family, |
| org.apache.hadoop.fs.Path storeFile) |
| 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> |
| <div class="block">Archive the store file</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - the filesystem where the store files live</dd> |
| <dd><code>regionInfo</code> - region hosting the store files</dd> |
| <dd><code>conf</code> - <code>Configuration</code> to examine to determine the archive directory</dd> |
| <dd><code>tableDir</code> - <code>Path</code> to where the table is being stored (for building the archive path)</dd> |
| <dd><code>family</code> - the family hosting the store files</dd> |
| <dd><code>storeFile</code> - file to be archived</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if the files could not be correctly disposed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveAndArchive-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-java.util.Collection-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveAndArchive</h4> |
| <pre>private static <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.424">resolveAndArchive</a>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path baseArchiveDir, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a>> toArchive, |
| long start) |
| 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> |
| <div class="block">Resolve any conflict with an existing archive file via timestamp-append |
| renaming of the existing file and then archive the passed in files.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fs</code> - <code>FileSystem</code> on which to archive the files</dd> |
| <dd><code>baseArchiveDir</code> - base archive directory to store the files. If any of |
| the files to archive are directories, will append the name of the |
| directory to the base archive directory name, creating a parallel |
| structure.</dd> |
| <dd><code>toArchive</code> - files/directories that need to be archvied</dd> |
| <dd><code>start</code> - time the archiving started - used for resolving archive |
| conflicts.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of failed to archive files.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if an unexpected file operation exception occurred</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resolveAndArchiveFile-org.apache.hadoop.fs.Path-org.apache.hadoop.hbase.backup.HFileArchiver.File-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resolveAndArchiveFile</h4> |
| <pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.484">resolveAndArchiveFile</a>(org.apache.hadoop.fs.Path archiveDir, |
| <a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a> currentFile, |
| <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> archiveStartTime) |
| 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> |
| <div class="block">Attempt to archive the passed in file to the archive directory. |
| <p> |
| If the same file already exists in the archive, it is moved to a timestamped directory under |
| the archive directory and the new file is put in its place.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>archiveDir</code> - <code>Path</code> to the directory that stores the archives of the hfiles</dd> |
| <dd><code>currentFile</code> - <code>Path</code> to the original HFile that will be archived</dd> |
| <dd><code>archiveStartTime</code> - time the archiving started, to resolve naming conflicts</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> if the file is successfully archived. <tt>false</tt> if there was a |
| problem, but the operation still completed.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - on failure to complete <code>FileSystem</code> operations.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteRegionWithoutArchiving-org.apache.hadoop.fs.FileSystem-org.apache.hadoop.fs.Path-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteRegionWithoutArchiving</h4> |
| <pre>private static boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.562">deleteRegionWithoutArchiving</a>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path regionDir) |
| 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> |
| <div class="block">Without regard for backup, delete a region. Should be used with caution.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>regionDir</code> - <code>Path</code> to the region to be deleted.</dd> |
| <dd><code>fs</code> - FileSystem from which to delete the region</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><tt>true</tt> on successful deletion, <tt>false</tt> otherwise</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - on filesystem operation failure</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="deleteStoreFilesWithoutArchiving-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deleteStoreFilesWithoutArchiving</h4> |
| <pre>private static void <a href="../../../../../src-html/org/apache/hadoop/hbase/backup/HFileArchiver.html#line.581">deleteStoreFilesWithoutArchiving</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/hadoop/hbase/regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver">HStoreFile</a>> compactedFiles) |
| 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> |
| <div class="block">Just do a simple delete of the given store files |
| <p> |
| A best effort is made to delete each of the files, rather than bailing on the first failure. |
| <p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>compactedFiles</code> - store files to delete from the file system.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <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> - if a file cannot be deleted. All files will be attempted to deleted before |
| throwing the exception, rather than failing at the first file.</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/HFileArchiver.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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/backup/HBackupFileSystem.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/backup/HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/backup/HFileArchiver.html" target="_top">Frames</a></li> |
| <li><a href="HFileArchiver.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
