| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>HFileArchiveUtil (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.util, class: HFileArchiveUtil"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/HFileArchiveUtil.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.util</a></div> |
| <h1 title="Class HFileArchiveUtil" class="title">Class HFileArchiveUtil</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.util.HFileArchiveUtil</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public final class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-33">HFileArchiveUtil</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Helper class for all utilities related to archival/retrieval of HFiles</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">HFileArchiveUtil</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getArchivePath(org.apache.hadoop.conf.Configuration)" class="member-name-link">getArchivePath</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the full path to the archive directory on the configured |
| <a href="../master/MasterFileSystem.html" title="class in org.apache.hadoop.hbase.master"><code>MasterFileSystem</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getArchivePath(org.apache.hadoop.fs.Path)" class="member-name-link">getArchivePath</a><wbr>(org.apache.hadoop.fs.Path rootdir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the full path to the archive directory on the configured |
| <a href="../master/MasterFileSystem.html" title="class in org.apache.hadoop.hbase.master"><code>MasterFileSystem</code></a></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionArchiveDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,java.lang.String)" class="member-name-link">getRegionArchiveDir</a><wbr>(org.apache.hadoop.fs.Path rootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encodedRegionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the archive directory for a given region under the specified table</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionArchiveDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,org.apache.hadoop.fs.Path)" class="member-name-link">getRegionArchiveDir</a><wbr>(org.apache.hadoop.fs.Path rootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| org.apache.hadoop.fs.Path regiondir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the archive directory for a given region under the specified table</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStoreArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.RegionInfo,byte%5B%5D)" class="member-name-link">getStoreArchivePath</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| byte[] family)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the directory to archive a store directory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStoreArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.fs.Path,byte%5B%5D)" class="member-name-link">getStoreArchivePath</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| org.apache.hadoop.fs.Path tabledir, |
| byte[] family)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory to archive a store directory</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStoreArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName,java.lang.String,java.lang.String)" class="member-name-link">getStoreArchivePath</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> regionName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> familyName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the directory to archive a store directory</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStoreArchivePathForArchivePath(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo,byte%5B%5D)" class="member-name-link">getStoreArchivePathForArchivePath</a><wbr>(org.apache.hadoop.fs.Path archivePath, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| byte[] family)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStoreArchivePathForRootDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo,byte%5B%5D)" class="member-name-link">getStoreArchivePathForRootDir</a><wbr>(org.apache.hadoop.fs.Path rootDir, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| byte[] family)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the archive directory under specified root dir.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTableArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName)" class="member-name-link">getTableArchivePath</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the path to the table archive directory based on the configured archive directory.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTableArchivePath(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName)" class="member-name-link">getTableArchivePath</a><wbr>(org.apache.hadoop.fs.Path rootdir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Get the path to the table archive directory based on the configured archive directory.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTableName(org.apache.hadoop.fs.Path)" class="member-name-link">getTableName</a><wbr>(org.apache.hadoop.fs.Path archivePath)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>HFileArchiveUtil</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-35">HFileArchiveUtil</a></span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getStoreArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName,java.lang.String,java.lang.String)"> |
| <h3>getStoreArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-48">getStoreArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> regionName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> familyName)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Get the directory to archive a store directory</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - <code>Configuration</code> to read for the archive directory name</dd> |
| <dd><code>tableName</code> - table name under which the store currently lives</dd> |
| <dd><code>regionName</code> - region encoded name under which the store currently lives</dd> |
| <dd><code>familyName</code> - name of the family in the store</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the directory to archive the given store or <tt>null</tt> if it should |
| not be archived</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStoreArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.fs.Path,byte[])"> |
| <h3>getStoreArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-64">getStoreArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| org.apache.hadoop.fs.Path tabledir, |
| byte[] family)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Get the directory to archive a store directory</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - <code>Configuration</code> to read for the archive directory name.</dd> |
| <dd><code>region</code> - parent region information under which the store currently lives</dd> |
| <dd><code>tabledir</code> - directory for the table under which the store currently lives</dd> |
| <dd><code>family</code> - name of the family in the store</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the directory to archive the given store or <tt>null</tt> if it should |
| not be archived</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStoreArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.RegionInfo,byte[])"> |
| <h3>getStoreArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-77">getStoreArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| byte[] family)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets the directory to archive a store directory.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - <code>Configuration</code> to read for the archive directory name.</dd> |
| <dd><code>region</code> - parent region information under which the store currently lives</dd> |
| <dd><code>family</code> - name of the family in the store</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the directory to archive the given store or <tt>null</tt> if it should |
| not be archived</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStoreArchivePathForRootDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo,byte[])"> |
| <h3>getStoreArchivePathForRootDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-95">getStoreArchivePathForRootDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| byte[] family)</span></div> |
| <div class="block">Gets the archive directory under specified root dir. One scenario where this is useful is when |
| WAL and root dir are configured under different file systems, i.e. root dir on S3 and WALs on |
| HDFS. This is mostly useful for archiving recovered edits, when |
| <b>hbase.region.archive.recovered.edits</b> is enabled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootDir</code> - <code>Path</code> the root dir under which archive path should be created.</dd> |
| <dd><code>region</code> - parent region information under which the store currently lives</dd> |
| <dd><code>family</code> - name of the family in the store</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the WAL FS directory to archive the given store or <tt>null</tt> if it |
| should not be archived</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStoreArchivePathForArchivePath(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo,byte[])"> |
| <h3>getStoreArchivePathForArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-100">getStoreArchivePathForArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path archivePath, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region, |
| byte[] family)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionArchiveDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,org.apache.hadoop.fs.Path)"> |
| <h3>getRegionArchiveDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-113">getRegionArchiveDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| org.apache.hadoop.fs.Path regiondir)</span></div> |
| <div class="block">Get the archive directory for a given region under the specified table</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tableName</code> - the table name. Cannot be null.</dd> |
| <dd><code>regiondir</code> - the path to the region directory. Cannot be null.</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the directory to archive the given region, or <tt>null</tt> if it |
| should not be archived</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionArchiveDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,java.lang.String)"> |
| <h3>getRegionArchiveDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-130">getRegionArchiveDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> encodedRegionName)</span></div> |
| <div class="block">Get the archive directory for a given region under the specified table</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootDir</code> - <code>Path</code> to the root directory where hbase files are stored (for building |
| the archive path)</dd> |
| <dd><code>tableName</code> - name of the table to archive. Cannot be null.</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the directory to archive the given region, or <tt>null</tt> if it |
| should not be archived</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableArchivePath(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName)"> |
| <h3>getTableArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-148">getTableArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootdir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</span></div> |
| <div class="block">Get the path to the table archive directory based on the configured archive directory. |
| <p> |
| Get the path to the table's archive directory. |
| <p> |
| Generally of the form: /hbase/.archive/[tablename]</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootdir</code> - <code>Path</code> to the root directory where hbase files are stored (for building |
| the archive path)</dd> |
| <dd><code>tableName</code> - Name of the table to be archived. Cannot be null.</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the archive directory for the table</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableArchivePath(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.TableName)"> |
| <h3>getTableArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-160">getTableArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Get the path to the table archive directory based on the configured archive directory. |
| <p> |
| Assumed that the table should already be archived.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - <code>Configuration</code> to read the archive directory property. Can be null</dd> |
| <dd><code>tableName</code> - Name of the table to be archived. Cannot be null.</dd> |
| <dt>Returns:</dt> |
| <dd><code>Path</code> to the archive directory for the table</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArchivePath(org.apache.hadoop.conf.Configuration)"> |
| <h3>getArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-173">getArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Get the full path to the archive directory on the configured |
| <a href="../master/MasterFileSystem.html" title="class in org.apache.hadoop.hbase.master"><code>MasterFileSystem</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - to look for archive directory name and root directory. Cannot be null. Notes for |
| testing: requires a FileSystem root directory to be specified.</dd> |
| <dt>Returns:</dt> |
| <dd>the full <code>Path</code> to the archive directory, as defined by the configuration</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an unexpected error occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArchivePath(org.apache.hadoop.fs.Path)"> |
| <h3>getArchivePath</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-184">getArchivePath</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path rootdir)</span></div> |
| <div class="block">Get the full path to the archive directory on the configured |
| <a href="../master/MasterFileSystem.html" title="class in org.apache.hadoop.hbase.master"><code>MasterFileSystem</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>rootdir</code> - <code>Path</code> to the root directory where hbase files are stored (for building |
| the archive path)</dd> |
| <dt>Returns:</dt> |
| <dd>the full <code>Path</code> to the archive directory, as defined by the configuration</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableName(org.apache.hadoop.fs.Path)"> |
| <h3>getTableName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/HFileArchiveUtil.html#line-191">getTableName</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path archivePath)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
