| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FSUtils (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: FSUtils"> |
| <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/FSUtils.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><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="sub-nav-list"> |
| <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> |
| <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 FSUtils" class="title">Class FSUtils</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.FSUtils</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/FSUtils.html#line-105">FSUtils</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">Utility methods for interacting with the underlying file system.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="FSUtils.BlackListDirFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.BlackListDirFilter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Directory filter that doesn't include any of the directories in the specified blacklist</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="FSUtils.DirFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.DirFilter</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">A <code>PathFilter</code> that only allows directories.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="FSUtils.FamilyDirFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.FamilyDirFilter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Filter for all dirs that are legal column family names.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>(package private) static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="FSUtils.FileFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.FileFilter</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">A <code>PathFilter</code> that returns only regular files.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="FSUtils.HFileFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.HFileFilter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Filter for HFiles that excludes reference files.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="FSUtils.HFileLinkFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.HFileLinkFilter</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Filter for HFileLinks (StoreFiles and HFiles not included).</div> |
| </div> |
| <div class="col-first even-row-color"><code>(package private) static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="FSUtils.ProgressReporter.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.util">FSUtils.ProgressReporter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Called every so-often by storefile map builder getTableStoreFilePathMap to report progress.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="FSUtils.ReferenceAndLinkFileFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.ReferenceAndLinkFileFilter</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="FSUtils.ReferenceFileFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.ReferenceFileFilter</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static class </code></div> |
| <div class="col-second odd-row-color"><code><a href="FSUtils.RegionDirFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.RegionDirFilter</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Filter for all dirs that don't start with '.'</div> |
| </div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="FSUtils.UserTableDirFilter.html" class="type-name-link" title="class in org.apache.hadoop.hbase.util">FSUtils.UserTableDirFilter</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">A <code>PathFilter</code> that returns usertable directories.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_THREAD_POOLSIZE" class="member-name-link">DEFAULT_THREAD_POOLSIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final <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></code></div> |
| <div class="col-second even-row-color"><code><a href="#THREAD_POOLSIZE" class="member-name-link">THREAD_POOLSIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#WINDOWS" class="member-name-link">WINDOWS</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Set to true on Windows platforms</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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">FSUtils</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><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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 void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#addToHDFSBlocksDistribution(org.apache.hadoop.hbase.HDFSBlocksDistribution,org.apache.hadoop.fs.BlockLocation%5B%5D)" class="member-name-link">addToHDFSBlocksDistribution</a><wbr>(<a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a> blocksDistribution, |
| org.apache.hadoop.fs.BlockLocation[] blockLocations)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Update blocksDistribution with blockLocations</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkClusterIdExists(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,long)" class="member-name-link">checkClusterIdExists</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| long wait)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Checks that a cluster ID file exists in the HBase root directory</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkDfsSafeMode(org.apache.hadoop.conf.Configuration)" class="member-name-link">checkDfsSafeMode</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">Check whether dfs is in safemode.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkFileSystemAvailable(org.apache.hadoop.fs.FileSystem)" class="member-name-link">checkFileSystemAvailable</a><wbr>(org.apache.hadoop.fs.FileSystem fs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Checks to see if the specified file system is available</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkShortCircuitReadBufferSize(org.apache.hadoop.conf.Configuration)" class="member-name-link">checkShortCircuitReadBufferSize</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">Check if short circuit read buffer size is set and if not, set it to hbase value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,boolean)" class="member-name-link">checkVersion</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| boolean message)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Verifies current version of file system</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#checkVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,boolean,int,int)" class="member-name-link">checkVersion</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| boolean message, |
| int wait, |
| int retries)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Verifies current version of file system</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.FileStatus,long,long)" class="member-name-link">computeHDFSBlocksDistribution</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.FileStatus status, |
| long start, |
| long length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Compute HDFS blocks distribution of a given file, or a portion of the file</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeHDFSBlocksDistribution(org.apache.hadoop.hdfs.client.HdfsDataInputStream)" class="member-name-link">computeHDFSBlocksDistribution</a><wbr>(org.apache.hadoop.hdfs.client.HdfsDataInputStream inputStream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Compute HDFS block distribution of a given HdfsDataInputStream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#copyFiles(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,java.util.concurrent.ExecutorService,java.util.List)" class="member-name-link">copyFiles</a><wbr>(org.apache.hadoop.fs.FileSystem srcFS, |
| org.apache.hadoop.fs.Path src, |
| org.apache.hadoop.fs.FileSystem dstFS, |
| org.apache.hadoop.fs.Path dst, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> pool, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>>> futures)</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 <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#copyFilesParallel(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,int)" class="member-name-link">copyFilesParallel</a><wbr>(org.apache.hadoop.fs.FileSystem srcFS, |
| org.apache.hadoop.fs.Path src, |
| org.apache.hadoop.fs.FileSystem dstFS, |
| org.apache.hadoop.fs.Path dst, |
| org.apache.hadoop.conf.Configuration conf, |
| int threads)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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.FSDataOutputStream</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#create(org.apache.hadoop.conf.Configuration,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.permission.FsPermission,java.net.InetSocketAddress%5B%5D)" class="member-name-link">create</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.fs.permission.FsPermission perm, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a>[] favoredNodes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create the specified file on the filesystem.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#deleteRegionDir(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">deleteRegionDir</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> hri)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Delete the region directory if exists.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.FileStatus></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#filterFileStatuses(java.util.Iterator,org.apache.hadoop.hbase.util.FileStatusFilter)" class="member-name-link">filterFileStatuses</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><org.apache.hadoop.fs.FileStatus> input, |
| <a href="FileStatusFilter.html" title="interface in org.apache.hadoop.hbase.util">FileStatusFilter</a> filter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Filters FileStatuses in an iterator and returns a list</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.FileStatus></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#filterFileStatuses(org.apache.hadoop.fs.FileStatus%5B%5D,org.apache.hadoop.hbase.util.FileStatusFilter)" class="member-name-link">filterFileStatuses</a><wbr>(org.apache.hadoop.fs.FileStatus[] input, |
| <a href="FileStatusFilter.html" title="interface in org.apache.hadoop.hbase.util">FileStatusFilter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Filters FileStatuses in an array and returns a list</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getClusterId(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getClusterId</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| 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">Returns the value of the unique cluster ID stored for this HBase instance.</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.hdfs.DFSHedgedReadMetrics</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDFSHedgedReadMetrics(org.apache.hadoop.conf.Configuration)" class="member-name-link">getDFSHedgedReadMetrics</a><wbr>(org.apache.hadoop.conf.Configuration c)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns The DFSClient DFSHedgedReadMetrics instance or null if can't be found or not on hdfs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getFamilyDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getFamilyDirs</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| 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">Given a particular region dir, return all the familydirs inside it</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getFilePaths(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter)" class="member-name-link">getFilePaths</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path dir, |
| org.apache.hadoop.fs.PathFilter pathFilter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <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>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getHostsForLocations(org.apache.hadoop.hdfs.protocol.LocatedBlock)" class="member-name-link">getHostsForLocations</a><wbr>(org.apache.hadoop.hdfs.protocol.LocatedBlock block)</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 <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getLocalTableDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getLocalTableDirs</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getNNAddresses(org.apache.hadoop.hdfs.DistributedFileSystem,org.apache.hadoop.conf.Configuration)" class="member-name-link">getNNAddresses</a><wbr>(org.apache.hadoop.hdfs.DistributedFileSystem fs, |
| org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns A set containing all namenode addresses of fs</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getReferenceAndLinkFilePaths(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getReferenceAndLinkFilePaths</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path familyDir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getReferenceFilePaths(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getReferenceFilePaths</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path familyDir)</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 <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a>>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionDegreeLocalityMappingFromFS(org.apache.hadoop.conf.Configuration)" class="member-name-link">getRegionDegreeLocalityMappingFromFS</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">This function is to scan the root path of the file system to get the degree of locality for |
| each region on each of the servers having at least one block of that region.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a>>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionDegreeLocalityMappingFromFS(org.apache.hadoop.conf.Configuration,java.lang.String,int)" class="member-name-link">getRegionDegreeLocalityMappingFromFS</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <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> desiredTable, |
| int threadPoolSize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">This function is to scan the root path of the file system to get the degree of locality for |
| each region on each of the servers having at least one block of that region.</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="#getRegionDirFromRootDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">getRegionDirFromRootDir</a><wbr>(org.apache.hadoop.fs.Path rootDir, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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="#getRegionDirFromTableDir(org.apache.hadoop.fs.Path,java.lang.String)" class="member-name-link">getRegionDirFromTableDir</a><wbr>(org.apache.hadoop.fs.Path tableDir, |
| <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 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="#getRegionDirFromTableDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">getRegionDirFromTableDir</a><wbr>(org.apache.hadoop.fs.Path tableDir, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getRegionDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getRegionDirs</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path tableDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Given a particular table dir, return all the regiondirs inside it, excluding files such as |
| .tableinfo</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionLocalityMappingFromFS(org.apache.hadoop.conf.Configuration,java.lang.String,int,java.util.Map)" class="member-name-link">getRegionLocalityMappingFromFS</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <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> desiredTable, |
| int threadPoolSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a>>> regionDegreeLocalityMapping)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">This function is to scan the root path of the file system to get either the mapping between the |
| region name and its best locality region server or the degree of locality of each region on |
| each of the servers having at least one block of that region.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionReferenceAndLinkFileCount(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getRegionReferenceAndLinkFileCount</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path p)</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 int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRegionReferenceFileCount(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getRegionReferenceFileCount</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path p)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><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="#getTableDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getTableDirs</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| 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> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTableFragmentation(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getTableFragmentation</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Runs through the HBase rootdir and checks how many stores for each table have more than one |
| file in them.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTableFragmentation(org.apache.hadoop.hbase.master.HMaster)" class="member-name-link">getTableFragmentation</a><wbr>(<a href="../master/HMaster.html" title="class in org.apache.hadoop.hbase.master">HMaster</a> master)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Runs through the HBase rootdir and checks how many stores for each table have more than one |
| file in them.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>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="#getTableStoreFilePathMap(java.util.Map,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName)" class="member-name-link">getTableStoreFilePathMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path> map, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| <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">Runs through the HBase rootdir/tablename and creates a reverse lookup map for table StoreFile |
| names to the full Path.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>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="#getTableStoreFilePathMap(java.util.Map,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.FSUtils.ProgressReporter)" class="member-name-link">getTableStoreFilePathMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path> resultMap, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="FSUtils.ProgressReporter.html" title="interface in org.apache.hadoop.hbase.util">FSUtils.ProgressReporter</a> progressReporter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Runs through the HBase rootdir/tablename and creates a reverse lookup map for table StoreFile |
| names to the full Path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>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 method-summary-table-tab6"><code><a href="#getTableStoreFilePathMap(java.util.Map,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.HbckErrorReporter)" class="member-name-link">getTableStoreFilePathMap</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path> resultMap, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="HbckErrorReporter.html" title="interface in org.apache.hadoop.hbase.util">HbckErrorReporter</a> progressReporter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 2.3.0.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>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="#getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getTableStoreFilePathMap</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Runs through the HBase rootdir and creates a reverse lookup map for table StoreFile names to |
| the full Path.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>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="#getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.FSUtils.ProgressReporter)" class="member-name-link">getTableStoreFilePathMap</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="FSUtils.ProgressReporter.html" title="interface in org.apache.hadoop.hbase.util">FSUtils.ProgressReporter</a> progressReporter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Runs through the HBase rootdir and creates a reverse lookup map for table StoreFile names to |
| the full Path.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>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 method-summary-table-tab6"><code><a href="#getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.HbckErrorReporter)" class="member-name-link">getTableStoreFilePathMap</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="HbckErrorReporter.html" title="interface in org.apache.hadoop.hbase.util">HbckErrorReporter</a> progressReporter)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 2.3.0.</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTotalTableFragmentation(org.apache.hadoop.hbase.master.HMaster)" class="member-name-link">getTotalTableFragmentation</a><wbr>(<a href="../master/HMaster.html" title="class in org.apache.hadoop.hbase.master">HMaster</a> master)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the total overall fragmentation percentage.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <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></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">getVersion</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| 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">Verifies current version of file system</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isDistributedFileSystem(org.apache.hadoop.fs.FileSystem)" class="member-name-link">isDistributedFileSystem</a><wbr>(org.apache.hadoop.fs.FileSystem fs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns True is <code>fs</code> is instance of DistributedFileSystem n</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isInSafeMode(org.apache.hadoop.hdfs.DistributedFileSystem)" class="member-name-link">isInSafeMode</a><wbr>(org.apache.hadoop.hdfs.DistributedFileSystem dfs)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Inquire the Active NameNode's safe mode status.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isMatchingTail(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path)" class="member-name-link">isMatchingTail</a><wbr>(org.apache.hadoop.fs.Path pathToSearch, |
| org.apache.hadoop.fs.Path pathTail)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Compare path component of the Path URI; e.g.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isSameHdfs(org.apache.hadoop.conf.Configuration,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.FileSystem)" class="member-name-link">isSameHdfs</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem srcFs, |
| org.apache.hadoop.fs.FileSystem desFs)</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 <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.FileStatus></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#listStatusWithStatusFilter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.FileStatusFilter)" class="member-name-link">listStatusWithStatusFilter</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path dir, |
| <a href="FileStatusFilter.html" title="interface in org.apache.hadoop.hbase.util">FileStatusFilter</a> filter)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Calls fs.listStatus() and treats FileNotFoundException as non-fatal This accommodates |
| differences between hadoop versions, where hadoop 1 does not throw a FileNotFoundException, and |
| return an empty FileStatus[] while Hadoop 2 will throw FileNotFoundException.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#metaRegionExists(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">metaRegionExists</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| 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">Checks if meta region exists</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#parseVersionFrom(byte%5B%5D)" class="member-name-link">parseVersionFrom</a><wbr>(byte[] bytes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Parse the content of the ${HBASE_ROOTDIR}/hbase.version file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#renameFile(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path)" class="member-name-link">renameFile</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path src, |
| org.apache.hadoop.fs.Path dst)</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>private static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#rewriteAsPb(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.ClusterId)" class="member-name-link">rewriteAsPb</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| org.apache.hadoop.fs.Path p, |
| <a href="../ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a> cid)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setClusterId(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.ClusterId,long)" class="member-name-link">setClusterId</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| <a href="../ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a> clusterId, |
| long wait)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Writes a new unique identifier for this cluster to the "hbase.id" file in the HBase root |
| directory.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setupShortCircuitRead(org.apache.hadoop.conf.Configuration)" class="member-name-link">setupShortCircuitRead</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">Do our short circuit read setup.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)" class="member-name-link">setVersion</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| 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">Sets version of file system</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,int,int)" class="member-name-link">setVersion</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| int wait, |
| int retries)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Sets version of file system</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,java.lang.String,int,int)" class="member-name-link">setVersion</a><wbr>(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| <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> version, |
| int wait, |
| int retries)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Sets version of file system</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#toVersionByteArray(java.lang.String)" class="member-name-link">toVersionByteArray</a><wbr>(<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> version)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create the content to write into the ${HBASE_ROOTDIR}/hbase.version file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#waitOnSafeMode(org.apache.hadoop.conf.Configuration,long)" class="member-name-link">waitOnSafeMode</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| long wait)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">If DFS, check safe mode and if so, wait until we clear it.</div> |
| </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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-107">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="THREAD_POOLSIZE"> |
| <h3>THREAD_POOLSIZE</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-109">THREAD_POOLSIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.FSUtils.THREAD_POOLSIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_THREAD_POOLSIZE"> |
| <h3>DEFAULT_THREAD_POOLSIZE</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-110">DEFAULT_THREAD_POOLSIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.util.FSUtils.DEFAULT_THREAD_POOLSIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WINDOWS"> |
| <h3>WINDOWS</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-114">WINDOWS</a></span></div> |
| <div class="block">Set to true on Windows platforms</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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>FSUtils</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-116">FSUtils</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="isDistributedFileSystem(org.apache.hadoop.fs.FileSystem)"> |
| <h3>isDistributedFileSystem</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-120">isDistributedFileSystem</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs)</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">Returns True is <code>fs</code> is instance of DistributedFileSystem n</div> |
| <dl class="notes"> |
| <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="isMatchingTail(org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path)"> |
| <h3>isMatchingTail</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-137">isMatchingTail</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path pathToSearch, |
| org.apache.hadoop.fs.Path pathTail)</span></div> |
| <div class="block">Compare path component of the Path URI; e.g. if hdfs://a/b/c and /a/b/c, it will compare the |
| '/a/b/c' part. If you passed in 'hdfs://a/b/c and b/c, it would return true. Does not consider |
| schema; i.e. if schemas different but path or subpath matches, the two will equate.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pathToSearch</code> - Path we will be trying to match.</dd> |
| <dt>Returns:</dt> |
| <dd>True if <code>pathTail</code> is tail on the path of <code>pathToSearch</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deleteRegionDir(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>deleteRegionDir</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-169">deleteRegionDir</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> hri)</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">Delete the region directory if exists.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>True if deleted the region directory.</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="create(org.apache.hadoop.conf.Configuration,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.permission.FsPermission,java.net.InetSocketAddress[])"> |
| <h3>create</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.fs.FSDataOutputStream</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-196">create</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path path, |
| org.apache.hadoop.fs.permission.FsPermission perm, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a>[] favoredNodes)</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">Create the specified file on the filesystem. By default, this will: |
| <ol> |
| <li>overwrite the file if it exists</li> |
| <li>apply the umask in the configuration (if it is enabled)</li> |
| <li>use the fs configured buffer size (or 4096 if not set)</li> |
| <li>use the configured column family replication or default replication if |
| <a href="../client/ColumnFamilyDescriptorBuilder.html#DEFAULT_DFS_REPLICATION"><code>ColumnFamilyDescriptorBuilder.DEFAULT_DFS_REPLICATION</code></a></li> |
| <li>use the default block size</li> |
| <li>not track progress</li> |
| </ol></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - configurations</dd> |
| <dd><code>fs</code> - <code>FileSystem</code> on which to write the file</dd> |
| <dd><code>path</code> - <code>Path</code> to the file to write</dd> |
| <dd><code>perm</code> - permissions</dd> |
| <dd><code>favoredNodes</code> - favored data nodes</dd> |
| <dt>Returns:</dt> |
| <dd>output stream to the created file</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 the file cannot be created</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkFileSystemAvailable(org.apache.hadoop.fs.FileSystem)"> |
| <h3>checkFileSystemAvailable</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-224">checkFileSystemAvailable</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs)</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">Checks to see if the specified file system is available</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - filesystem</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> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInSafeMode(org.apache.hadoop.hdfs.DistributedFileSystem)"> |
| <h3>isInSafeMode</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-250">isInSafeMode</a></span><wbr><span class="parameters">(org.apache.hadoop.hdfs.DistributedFileSystem dfs)</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">Inquire the Active NameNode's safe mode status.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dfs</code> - A DistributedFileSystem object representing the underlying HDFS.</dd> |
| <dt>Returns:</dt> |
| <dd>whether we're in safe mode</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="checkDfsSafeMode(org.apache.hadoop.conf.Configuration)"> |
| <h3>checkDfsSafeMode</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-257">checkDfsSafeMode</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">Check whether dfs is in safemode.</div> |
| <dl class="notes"> |
| <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="getVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-277">getVersion</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir)</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>, |
| <a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block">Verifies current version of file system</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - filesystem object</dd> |
| <dd><code>rootdir</code> - root hbase directory</dd> |
| <dt>Returns:</dt> |
| <dd>null if no version file exists, version string otherwise</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 the version file fails to open</dd> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code> - if the version data cannot be translated into a version</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseVersionFrom(byte[])"> |
| <h3>parseVersionFrom</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><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></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-318">parseVersionFrom</a></span><wbr><span class="parameters">(byte[] bytes)</span> |
| throws <span class="exceptions"><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block">Parse the content of the ${HBASE_ROOTDIR}/hbase.version file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - The byte content of the hbase.version file</dd> |
| <dt>Returns:</dt> |
| <dd>The version found in the file as a String</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code> - if the version data cannot be translated into a version</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toVersionByteArray(java.lang.String)"> |
| <h3>toVersionByteArray</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-338">toVersionByteArray</a></span><wbr><span class="parameters">(<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> version)</span></div> |
| <div class="block">Create the content to write into the ${HBASE_ROOTDIR}/hbase.version file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>version</code> - Version to persist</dd> |
| <dt>Returns:</dt> |
| <dd>Serialized protobuf with <code>version</code> content and a bit of pb magic for a |
| prefix.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,boolean)"> |
| <h3>checkVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-352">checkVersion</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| boolean message)</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>, |
| <a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block">Verifies current version of file system</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - file system</dd> |
| <dd><code>rootdir</code> - root directory of HBase installation</dd> |
| <dd><code>message</code> - if true, issues a message on System.out</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 the version file cannot be opened</dd> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code> - if the contents of the version file cannot be parsed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,boolean,int,int)"> |
| <h3>checkVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-367">checkVersion</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| boolean message, |
| int wait, |
| int retries)</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>, |
| <a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block">Verifies current version of file system</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - file system</dd> |
| <dd><code>rootdir</code> - root directory of HBase installation</dd> |
| <dd><code>message</code> - if true, issues a message on System.out</dd> |
| <dd><code>wait</code> - wait interval</dd> |
| <dd><code>retries</code> - number of times to retry</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 the version file cannot be opened</dd> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code> - if the contents of the version file cannot be parsed</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>setVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-405">setVersion</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir)</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">Sets version of file system</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - filesystem object</dd> |
| <dd><code>rootdir</code> - hbase root</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> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,int,int)"> |
| <h3>setVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-418">setVersion</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| int wait, |
| int retries)</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">Sets version of file system</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - filesystem object</dd> |
| <dd><code>rootdir</code> - hbase root</dd> |
| <dd><code>wait</code> - time to wait for retry</dd> |
| <dd><code>retries</code> - number of times to retry before failing</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> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setVersion(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,java.lang.String,int,int)"> |
| <h3>setVersion</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-432">setVersion</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| <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> version, |
| int wait, |
| int retries)</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">Sets version of file system</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - filesystem object</dd> |
| <dd><code>rootdir</code> - hbase root directory</dd> |
| <dd><code>version</code> - version to set</dd> |
| <dd><code>wait</code> - time to wait for retry</dd> |
| <dd><code>retries</code> - number of times to retry before throwing an IOException</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> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkClusterIdExists(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,long)"> |
| <h3>checkClusterIdExists</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-490">checkClusterIdExists</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| long wait)</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">Checks that a cluster ID file exists in the HBase root directory</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - the root directory FileSystem</dd> |
| <dd><code>rootdir</code> - the HBase root directory in HDFS</dd> |
| <dd><code>wait</code> - how long to wait between retries</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if the file exists, otherwise <code>false</code></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 checking the FileSystem fails</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getClusterId(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getClusterId</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-519">getClusterId</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir)</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">Returns the value of the unique cluster ID stored for this HBase instance.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - the root directory FileSystem</dd> |
| <dd><code>rootdir</code> - the path to the HBase root directory</dd> |
| <dt>Returns:</dt> |
| <dd>the unique cluster identifier</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 reading the cluster ID file fails</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rewriteAsPb(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.ClusterId)"> |
| <h3>rewriteAsPb</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-562">rewriteAsPb</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| org.apache.hadoop.fs.Path p, |
| <a href="../ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a> cid)</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> |
| <dl class="notes"> |
| <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="setClusterId(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.ClusterId,long)"> |
| <h3>setClusterId</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-585">setClusterId</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir, |
| <a href="../ClusterId.html" title="class in org.apache.hadoop.hbase">ClusterId</a> clusterId, |
| long wait)</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">Writes a new unique identifier for this cluster to the "hbase.id" file in the HBase root |
| directory. If any operations on the ID file fails, and <code>wait</code> is a positive value, the |
| method will retry to produce the ID file until the thread is forcibly interrupted.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - the root directory FileSystem</dd> |
| <dd><code>rootdir</code> - the path to the HBase root directory</dd> |
| <dd><code>clusterId</code> - the unique identifier to store</dd> |
| <dd><code>wait</code> - how long (in milliseconds) to wait between retries</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 writing to the FileSystem fails and no wait value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="waitOnSafeMode(org.apache.hadoop.conf.Configuration,long)"> |
| <h3>waitOnSafeMode</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-645">waitOnSafeMode</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| long wait)</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">If DFS, check safe mode and if so, wait until we clear it.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - configuration</dd> |
| <dd><code>wait</code> - Sleep between retries</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> - e</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="metaRegionExists(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>metaRegionExists</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-667">metaRegionExists</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootDir)</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">Checks if meta region exists</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - file system</dd> |
| <dd><code>rootDir</code> - root directory of HBase installation</dd> |
| <dt>Returns:</dt> |
| <dd>true if exists</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="computeHDFSBlocksDistribution(org.apache.hadoop.hdfs.client.HdfsDataInputStream)"> |
| <h3>computeHDFSBlocksDistribution</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-681">computeHDFSBlocksDistribution</a></span><wbr><span class="parameters">(org.apache.hadoop.hdfs.client.HdfsDataInputStream inputStream)</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">Compute HDFS block distribution of a given HdfsDataInputStream. All HdfsDataInputStreams are |
| backed by a series of LocatedBlocks, which are fetched periodically from the namenode. This |
| method retrieves those blocks from the input stream and uses them to calculate |
| HDFSBlockDistribution. The underlying method in DFSInputStream does attempt to use locally |
| cached blocks, but may hit the namenode if the cache is determined to be incomplete. The method |
| also involves making copies of all LocatedBlocks rather than return the underlying blocks |
| themselves.</div> |
| <dl class="notes"> |
| <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="getHostsForLocations(org.apache.hadoop.hdfs.protocol.LocatedBlock)"> |
| <h3>getHostsForLocations</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><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>[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-694">getHostsForLocations</a></span><wbr><span class="parameters">(org.apache.hadoop.hdfs.protocol.LocatedBlock block)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="computeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.FileStatus,long,long)"> |
| <h3>computeHDFSBlocksDistribution</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-711">computeHDFSBlocksDistribution</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.FileStatus status, |
| long start, |
| long length)</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">Compute HDFS blocks distribution of a given file, or a portion of the file</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - file system</dd> |
| <dd><code>status</code> - file status of the file</dd> |
| <dd><code>start</code> - start position of the portion</dd> |
| <dd><code>length</code> - length of the portion</dd> |
| <dt>Returns:</dt> |
| <dd>The HDFS blocks distribution</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="addToHDFSBlocksDistribution(org.apache.hadoop.hbase.HDFSBlocksDistribution,org.apache.hadoop.fs.BlockLocation[])"> |
| <h3>addToHDFSBlocksDistribution</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-724">addToHDFSBlocksDistribution</a></span><wbr><span class="parameters">(<a href="../HDFSBlocksDistribution.html" title="class in org.apache.hadoop.hbase">HDFSBlocksDistribution</a> blocksDistribution, |
| org.apache.hadoop.fs.BlockLocation[] blockLocations)</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">Update blocksDistribution with blockLocations</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>blocksDistribution</code> - the hdfs blocks distribution</dd> |
| <dd><code>blockLocations</code> - an array containing block location</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="getTotalTableFragmentation(org.apache.hadoop.hbase.master.HMaster)"> |
| <h3>getTotalTableFragmentation</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-741">getTotalTableFragmentation</a></span><wbr><span class="parameters">(<a href="../master/HMaster.html" title="class in org.apache.hadoop.hbase.master">HMaster</a> master)</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">Returns the total overall fragmentation percentage. Includes hbase:meta and -ROOT- as well.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>master</code> - The master defining the HBase root and file system</dd> |
| <dt>Returns:</dt> |
| <dd>A map for each table and its percentage (never null)</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> - When scanning the directory fails</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableFragmentation(org.apache.hadoop.hbase.master.HMaster)"> |
| <h3>getTableFragmentation</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-754">getTableFragmentation</a></span><wbr><span class="parameters">(<a href="../master/HMaster.html" title="class in org.apache.hadoop.hbase.master">HMaster</a> master)</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">Runs through the HBase rootdir and checks how many stores for each table have more than one |
| file in them. Checks -ROOT- and hbase:meta too. The total percentage across all tables is |
| stored under the special key "-TOTAL-".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>master</code> - The master defining the HBase root and file system.</dd> |
| <dt>Returns:</dt> |
| <dd>A map for each table and its percentage (never null).</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> - When scanning the directory fails.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableFragmentation(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getTableFragmentation</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-771">getTableFragmentation</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir)</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">Runs through the HBase rootdir and checks how many stores for each table have more than one |
| file in them. Checks -ROOT- and hbase:meta too. The total percentage across all tables is |
| stored under the special key "-TOTAL-".</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - The file system to use</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan</dd> |
| <dt>Returns:</dt> |
| <dd>A map for each table and its percentage (never null)</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> - When scanning the directory fails</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="renameFile(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path)"> |
| <h3>renameFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-809">renameFile</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path src, |
| org.apache.hadoop.fs.Path dst)</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> |
| <dl class="notes"> |
| <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="getTableDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getTableDirs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-913">getTableDirs</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir)</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> |
| <dl class="notes"> |
| <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="getLocalTableDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getLocalTableDirs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-929">getLocalTableDirs</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path rootdir)</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> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>All the table directories under <code>rootdir</code>. Ignore non table hbase folders |
| such as .logs, .oldlogs, .corrupt folders.</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="getRegionDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getRegionDirs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-975">getRegionDirs</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path tableDir)</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">Given a particular table dir, return all the regiondirs inside it, excluding files such as |
| .tableinfo</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - A file system for the Path</dd> |
| <dd><code>tableDir</code> - Path to a specific table directory <hbase.rootdir>/<tabledir></dd> |
| <dt>Returns:</dt> |
| <dd>List of paths to valid region directories in table dir.</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="getRegionDirFromRootDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>getRegionDirFromRootDir</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/FSUtils.html#line-990">getRegionDirFromRootDir</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)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionDirFromTableDir(org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>getRegionDirFromTableDir</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/FSUtils.html#line-994">getRegionDirFromTableDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path tableDir, |
| <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> region)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionDirFromTableDir(org.apache.hadoop.fs.Path,java.lang.String)"> |
| <h3>getRegionDirFromTableDir</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/FSUtils.html#line-999">getRegionDirFromTableDir</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.Path tableDir, |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilyDirs(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getFamilyDirs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1040">getFamilyDirs</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path regionDir)</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">Given a particular region dir, return all the familydirs inside it</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - A file system for the Path</dd> |
| <dd><code>regionDir</code> - Path to a specific region directory</dd> |
| <dt>Returns:</dt> |
| <dd>List of paths to valid family directories in region dir.</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="getReferenceFilePaths(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getReferenceFilePaths</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1046">getReferenceFilePaths</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path familyDir)</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> |
| <dl class="notes"> |
| <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="getReferenceAndLinkFilePaths(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getReferenceAndLinkFilePaths</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1051">getReferenceAndLinkFilePaths</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path familyDir)</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> |
| <dl class="notes"> |
| <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="getFilePaths(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter)"> |
| <h3>getFilePaths</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1056">getFilePaths</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path dir, |
| org.apache.hadoop.fs.PathFilter pathFilter)</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> |
| <dl class="notes"> |
| <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="getRegionReferenceAndLinkFileCount(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getRegionReferenceAndLinkFileCount</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1067">getRegionReferenceAndLinkFileCount</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path p)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableStoreFilePathMap(java.util.Map,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName)"> |
| <h3>getTableStoreFilePathMap</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1188">getTableStoreFilePathMap</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path> map, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| <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>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Runs through the HBase rootdir/tablename and creates a reverse lookup map for table StoreFile |
| names to the full Path. <br> |
| Example...<br> |
| Key = 3944417774205889744 <br> |
| Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>map</code> - map to add values. If null, this method will create and populate one to |
| return</dd> |
| <dd><code>fs</code> - The file system to use.</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan.</dd> |
| <dd><code>tableName</code> - name of the table to scan.</dd> |
| <dt>Returns:</dt> |
| <dd>Map keyed by StoreFile name with a value of the full Path.</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> - When scanning the directory fails.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableStoreFilePathMap(java.util.Map,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.HbckErrorReporter)"> |
| <h3>getTableStoreFilePathMap</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1217">getTableStoreFilePathMap</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path> resultMap, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="HbckErrorReporter.html" title="interface in org.apache.hadoop.hbase.util">HbckErrorReporter</a> progressReporter)</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>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 2.3.0. For removal in hbase4. Use ProgressReporter override instead.</div> |
| </div> |
| <div class="block">Runs through the HBase rootdir/tablename and creates a reverse lookup map for table StoreFile |
| names to the full Path. Note that because this method can be called on a 'live' HBase system |
| that we will skip files that no longer exist by the time we traverse them and similarly the |
| user of the result needs to consider that some entries in this map may not exist by the time |
| this call completes. <br> |
| Example...<br> |
| Key = 3944417774205889744 <br> |
| Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>resultMap</code> - map to add values. If null, this method will create and populate one to |
| return</dd> |
| <dd><code>fs</code> - The file system to use.</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan.</dd> |
| <dd><code>tableName</code> - name of the table to scan.</dd> |
| <dd><code>sfFilter</code> - optional path filter to apply to store files</dd> |
| <dd><code>executor</code> - optional executor service to parallelize this operation</dd> |
| <dd><code>progressReporter</code> - Instance or null; gets called every time we move to new region of |
| family dir and for each store file.</dd> |
| <dt>Returns:</dt> |
| <dd>Map keyed by StoreFile name with a value of the full Path.</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> - When scanning the directory fails.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableStoreFilePathMap(java.util.Map,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.TableName,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.FSUtils.ProgressReporter)"> |
| <h3>getTableStoreFilePathMap</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1254">getTableStoreFilePathMap</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path> resultMap, |
| org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="FSUtils.ProgressReporter.html" title="interface in org.apache.hadoop.hbase.util">FSUtils.ProgressReporter</a> progressReporter)</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>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Runs through the HBase rootdir/tablename and creates a reverse lookup map for table StoreFile |
| names to the full Path. Note that because this method can be called on a 'live' HBase system |
| that we will skip files that no longer exist by the time we traverse them and similarly the |
| user of the result needs to consider that some entries in this map may not exist by the time |
| this call completes. <br> |
| Example...<br> |
| Key = 3944417774205889744 <br> |
| Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>resultMap</code> - map to add values. If null, this method will create and populate one to |
| return</dd> |
| <dd><code>fs</code> - The file system to use.</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan.</dd> |
| <dd><code>tableName</code> - name of the table to scan.</dd> |
| <dd><code>sfFilter</code> - optional path filter to apply to store files</dd> |
| <dd><code>executor</code> - optional executor service to parallelize this operation</dd> |
| <dd><code>progressReporter</code> - Instance or null; gets called every time we move to new region of |
| family dir and for each store file.</dd> |
| <dt>Returns:</dt> |
| <dd>Map keyed by StoreFile name with a value of the full Path.</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> - When scanning the directory fails.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code> - the thread is interrupted, either before or during the activity.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionReferenceFileCount(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getRegionReferenceFileCount</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1371">getRegionReferenceFileCount</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path p)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path)"> |
| <h3>getTableStoreFilePathMap</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1394">getTableStoreFilePathMap</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir)</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>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Runs through the HBase rootdir and creates a reverse lookup map for table StoreFile names to |
| the full Path. <br> |
| Example...<br> |
| Key = 3944417774205889744 <br> |
| Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - The file system to use.</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan.</dd> |
| <dt>Returns:</dt> |
| <dd>Map keyed by StoreFile name with a value of the full Path.</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> - When scanning the directory fails.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.HbckErrorReporter)"> |
| <h3>getTableStoreFilePathMap</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1416">getTableStoreFilePathMap</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="HbckErrorReporter.html" title="interface in org.apache.hadoop.hbase.util">HbckErrorReporter</a> progressReporter)</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>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">Since 2.3.0. Will be removed in hbase4. Used |
| <a href="#getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.FSUtils.ProgressReporter)"><code>getTableStoreFilePathMap(FileSystem, Path, PathFilter, ExecutorService, ProgressReporter)</code></a></div> |
| </div> |
| <div class="block">Runs through the HBase rootdir and creates a reverse lookup map for table StoreFile names to |
| the full Path. <br> |
| Example...<br> |
| Key = 3944417774205889744 <br> |
| Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - The file system to use.</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan.</dd> |
| <dd><code>sfFilter</code> - optional path filter to apply to store files</dd> |
| <dd><code>executor</code> - optional executor service to parallelize this operation</dd> |
| <dd><code>progressReporter</code> - Instance or null; gets called every time we move to new region of |
| family dir and for each store file.</dd> |
| <dt>Returns:</dt> |
| <dd>Map keyed by StoreFile name with a value of the full Path.</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> - When scanning the directory fails.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.PathFilter,java.util.concurrent.ExecutorService,org.apache.hadoop.hbase.util.FSUtils.ProgressReporter)"> |
| <h3>getTableStoreFilePathMap</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr>org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1444">getTableStoreFilePathMap</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path hbaseRootDir, |
| org.apache.hadoop.fs.PathFilter sfFilter, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> executor, |
| <a href="FSUtils.ProgressReporter.html" title="interface in org.apache.hadoop.hbase.util">FSUtils.ProgressReporter</a> progressReporter)</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>, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></span></div> |
| <div class="block">Runs through the HBase rootdir and creates a reverse lookup map for table StoreFile names to |
| the full Path. <br> |
| Example...<br> |
| Key = 3944417774205889744 <br> |
| Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - The file system to use.</dd> |
| <dd><code>hbaseRootDir</code> - The root directory to scan.</dd> |
| <dd><code>sfFilter</code> - optional path filter to apply to store files</dd> |
| <dd><code>executor</code> - optional executor service to parallelize this operation</dd> |
| <dd><code>progressReporter</code> - Instance or null; gets called every time we move to new region of |
| family dir and for each store file.</dd> |
| <dt>Returns:</dt> |
| <dd>Map keyed by StoreFile name with a value of the full Path.</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> - When scanning the directory fails.</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/InterruptedException.html" title="class or interface in java.lang" class="external-link">InterruptedException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filterFileStatuses(org.apache.hadoop.fs.FileStatus[],org.apache.hadoop.hbase.util.FileStatusFilter)"> |
| <h3>filterFileStatuses</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.FileStatus></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1466">filterFileStatuses</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileStatus[] input, |
| <a href="FileStatusFilter.html" title="interface in org.apache.hadoop.hbase.util">FileStatusFilter</a> filter)</span></div> |
| <div class="block">Filters FileStatuses in an array and returns a list</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>input</code> - An array of FileStatuses</dd> |
| <dd><code>filter</code> - A required filter to filter the array</dd> |
| <dt>Returns:</dt> |
| <dd>A list of FileStatuses</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="filterFileStatuses(java.util.Iterator,org.apache.hadoop.hbase.util.FileStatusFilter)"> |
| <h3>filterFileStatuses</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.FileStatus></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1477">filterFileStatuses</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><org.apache.hadoop.fs.FileStatus> input, |
| <a href="FileStatusFilter.html" title="interface in org.apache.hadoop.hbase.util">FileStatusFilter</a> filter)</span></div> |
| <div class="block">Filters FileStatuses in an iterator and returns a list</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>input</code> - An iterator of FileStatuses</dd> |
| <dd><code>filter</code> - A required filter to filter the array</dd> |
| <dt>Returns:</dt> |
| <dd>A list of FileStatuses</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listStatusWithStatusFilter(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.hbase.util.FileStatusFilter)"> |
| <h3>listStatusWithStatusFilter</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.FileStatus></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1499">listStatusWithStatusFilter</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem fs, |
| org.apache.hadoop.fs.Path dir, |
| <a href="FileStatusFilter.html" title="interface in org.apache.hadoop.hbase.util">FileStatusFilter</a> filter)</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">Calls fs.listStatus() and treats FileNotFoundException as non-fatal This accommodates |
| differences between hadoop versions, where hadoop 1 does not throw a FileNotFoundException, and |
| return an empty FileStatus[] while Hadoop 2 will throw FileNotFoundException.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fs</code> - file system</dd> |
| <dd><code>dir</code> - directory</dd> |
| <dd><code>filter</code> - file status filter</dd> |
| <dt>Returns:</dt> |
| <dd>null if dir is empty or doesn't exist, otherwise FileStatus list</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="getRegionDegreeLocalityMappingFromFS(org.apache.hadoop.conf.Configuration)"> |
| <h3>getRegionDegreeLocalityMappingFromFS</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a>>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1533">getRegionDegreeLocalityMappingFromFS</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">This function is to scan the root path of the file system to get the degree of locality for |
| each region on each of the servers having at least one block of that region. This is used by |
| the tool <a href="../master/RegionPlacementMaintainer.html" title="class in org.apache.hadoop.hbase.master"><code>RegionPlacementMaintainer</code></a> the configuration to |
| use</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the mapping from region encoded name to a map of server names to locality fraction in |
| case of file system errors or interrupts</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="getRegionDegreeLocalityMappingFromFS(org.apache.hadoop.conf.Configuration,java.lang.String,int)"> |
| <h3>getRegionDegreeLocalityMappingFromFS</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a>>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1547">getRegionDegreeLocalityMappingFromFS</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <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> desiredTable, |
| int threadPoolSize)</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">This function is to scan the root path of the file system to get the degree of locality for |
| each region on each of the servers having at least one block of that region. the configuration |
| to use the table you wish to scan locality for the thread pool size to use</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the mapping from region encoded name to a map of server names to locality fraction in |
| case of file system errors or interrupts</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="getRegionLocalityMappingFromFS(org.apache.hadoop.conf.Configuration,java.lang.String,int,java.util.Map)"> |
| <h3>getRegionLocalityMappingFromFS</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1562">getRegionLocalityMappingFromFS</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <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> desiredTable, |
| int threadPoolSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Float.html" title="class or interface in java.lang" class="external-link">Float</a>>> regionDegreeLocalityMapping)</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">This function is to scan the root path of the file system to get either the mapping between the |
| region name and its best locality region server or the degree of locality of each region on |
| each of the servers having at least one block of that region. The output map parameters are |
| both optional. the configuration to use the table you wish to scan locality for the thread pool |
| size to use the map into which to put the locality degree mapping or null, must be a |
| thread-safe implementation in case of file system errors or interrupts</div> |
| <dl class="notes"> |
| <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="setupShortCircuitRead(org.apache.hadoop.conf.Configuration)"> |
| <h3>setupShortCircuitRead</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1662">setupShortCircuitRead</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Do our short circuit read setup. Checks buffer size to use and whether to do checksumming in |
| hbase or hdfs.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkShortCircuitReadBufferSize(org.apache.hadoop.conf.Configuration)"> |
| <h3>checkShortCircuitReadBufferSize</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1682">checkShortCircuitReadBufferSize</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Check if short circuit read buffer size is set and if not, set it to hbase value.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDFSHedgedReadMetrics(org.apache.hadoop.conf.Configuration)"> |
| <h3>getDFSHedgedReadMetrics</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">org.apache.hadoop.hdfs.DFSHedgedReadMetrics</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1698">getDFSHedgedReadMetrics</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration c)</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">Returns The DFSClient DFSHedgedReadMetrics instance or null if can't be found or not on hdfs.</div> |
| <dl class="notes"> |
| <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="copyFilesParallel(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,int)"> |
| <h3>copyFilesParallel</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1730">copyFilesParallel</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem srcFS, |
| org.apache.hadoop.fs.Path src, |
| org.apache.hadoop.fs.FileSystem dstFS, |
| org.apache.hadoop.fs.Path dst, |
| org.apache.hadoop.conf.Configuration conf, |
| int threads)</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> |
| <dl class="notes"> |
| <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="copyFiles(org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.Path,org.apache.hadoop.conf.Configuration,java.util.concurrent.ExecutorService,java.util.List)"> |
| <h3>copyFiles</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.hadoop.fs.Path></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1748">copyFiles</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FileSystem srcFS, |
| org.apache.hadoop.fs.Path src, |
| org.apache.hadoop.fs.FileSystem dstFS, |
| org.apache.hadoop.fs.Path dst, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ExecutorService.html" title="class or interface in java.util.concurrent" class="external-link">ExecutorService</a> pool, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/Future.html" title="class or interface in java.util.concurrent" class="external-link">Future</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Void.html" title="class or interface in java.lang" class="external-link">Void</a>>> futures)</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> |
| <dl class="notes"> |
| <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="getNNAddresses(org.apache.hadoop.hdfs.DistributedFileSystem,org.apache.hadoop.conf.Configuration)"> |
| <h3>getNNAddresses</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1773">getNNAddresses</a></span><wbr><span class="parameters">(org.apache.hadoop.hdfs.DistributedFileSystem fs, |
| org.apache.hadoop.conf.Configuration conf)</span></div> |
| <div class="block">Returns A set containing all namenode addresses of fs</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSameHdfs(org.apache.hadoop.conf.Configuration,org.apache.hadoop.fs.FileSystem,org.apache.hadoop.fs.FileSystem)"> |
| <h3>isSameHdfs</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/FSUtils.html#line-1811">isSameHdfs</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.fs.FileSystem srcFs, |
| org.apache.hadoop.fs.FileSystem desFs)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the Configuration of HBase</dd> |
| <dt>Returns:</dt> |
| <dd>Whether srcFs and desFs are on same hdfs or not</dd> |
| </dl> |
| </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> |
