| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SnapshotInfo (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.snapshot, class: SnapshotInfo"> |
| <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/SnapshotInfo.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.snapshot</a></div> |
| <h1 title="Class SnapshotInfo" class="title">Class SnapshotInfo</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"><a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">org.apache.hadoop.hbase.util.AbstractHBaseTool</a> |
| <div class="inheritance">org.apache.hadoop.hbase.snapshot.SnapshotInfo</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>org.apache.hadoop.conf.Configurable</code>, <code>org.apache.hadoop.util.Tool</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public final class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-70">SnapshotInfo</a></span> |
| <span class="extends-implements">extends <a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></span></div> |
| <div class="block">Tool for dumping snapshot information. |
| <ol> |
| <li>Table Descriptor |
| <li>Snapshot creation time, type, format version, ... |
| <li>List of hfiles and wals |
| <li>Stats about hfiles and logs sizes, percentage of shared with the source table, ... |
| </ol></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>(package private) static final class </code></div> |
| <div class="col-second even-row-color"><code><a href="SnapshotInfo.Options.html" class="type-name-link" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.Options</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="SnapshotInfo.SnapshotStats.html" class="type-name-link" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Statistics about the snapshot |
| |
| How many store files and logs are in the archive |
| How many store files and logs are shared with the table |
| Total store files and logs size and shared amount |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.util.AbstractHBaseTool">Nested classes/interfaces inherited from class org.apache.hadoop.hbase.util.<a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></h2> |
| <code><a href="../util/AbstractHBaseTool.OptionsOrderComparator.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool.OptionsOrderComparator</a></code></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 org.apache.hadoop.fs.FileSystem</code></div> |
| <div class="col-second even-row-color"><code><a href="#fs" class="member-name-link">fs</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#listSnapshots" class="member-name-link">listSnapshots</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#printSizeInBytes" class="member-name-link">printSizeInBytes</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second even-row-color"><code><a href="#remoteDir" class="member-name-link">remoteDir</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private org.apache.hadoop.fs.Path</code></div> |
| <div class="col-second odd-row-color"><code><a href="#rootDir" class="member-name-link">rootDir</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#showFiles" class="member-name-link">showFiles</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#showSchema" class="member-name-link">showSchema</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#showStats" class="member-name-link">showStats</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#snapshotManifest" class="member-name-link">snapshotManifest</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <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="#snapshotName" class="member-name-link">snapshotName</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.util.AbstractHBaseTool">Fields inherited from class org.apache.hadoop.hbase.util.<a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></h3> |
| <code><a href="../util/AbstractHBaseTool.html#cmdLineArgs">cmdLineArgs</a>, <a href="../util/AbstractHBaseTool.html#conf">conf</a>, <a href="../util/AbstractHBaseTool.html#EXIT_FAILURE">EXIT_FAILURE</a>, <a href="../util/AbstractHBaseTool.html#EXIT_SUCCESS">EXIT_SUCCESS</a>, <a href="../util/AbstractHBaseTool.html#LONG_HELP_OPTION">LONG_HELP_OPTION</a>, <a href="../util/AbstractHBaseTool.html#options">options</a>, <a href="../util/AbstractHBaseTool.html#SHORT_HELP_OPTION">SHORT_HELP_OPTION</a></code></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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SnapshotInfo</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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addOptions()" class="member-name-link">addOptions</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Override this to add command-line options using <a href="../util/AbstractHBaseTool.html#addOptWithArg(java.lang.String,java.lang.String)"><code>AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String)</code></a> and similar methods.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#doWork()" class="member-name-link">doWork</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The "main function" of the tool</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <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-tab2 method-summary-table-tab4"><code><a href="#fileSizeToString(long)" class="member-name-link">fileSizeToString</a><wbr>(long size)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 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 void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotFilesMap(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.SnapshotDescription,java.util.concurrent.ExecutorService,java.util.concurrent.ConcurrentHashMap,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong)" class="member-name-link">getSnapshotFilesMap</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot, |
| <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> exec, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ConcurrentHashMap.html" title="class or interface in java.util.concurrent" class="external-link">ConcurrentHashMap</a><org.apache.hadoop.fs.Path,<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>> filesMap, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesArchiveSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesMobSize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the store files map for snapshot</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><<a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotList(org.apache.hadoop.conf.Configuration)" class="member-name-link">getSnapshotList</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">Returns the list of available snapshots in the specified location</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><org.apache.hadoop.fs.Path,<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="#getSnapshotsFilesMap(org.apache.hadoop.conf.Configuration,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong)" class="member-name-link">getSnapshotsFilesMap</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesArchiveSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesMobSize)</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 map of store files based on path for all snapshots</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SnapshotInfo.SnapshotStats.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotStats(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.SnapshotDescription)" class="member-name-link">getSnapshotStats</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot)</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 snapshot stats</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SnapshotInfo.SnapshotStats.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSnapshotStats(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,java.util.Map)" class="member-name-link">getSnapshotStats</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshotDesc, |
| <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><org.apache.hadoop.fs.Path,<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>> filesMap)</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 snapshot stats</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#loadSnapshotInfo(java.lang.String)" class="member-name-link">loadSnapshotInfo</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> snapshotName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Load snapshot info and table descriptor for the specified snapshot</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="#main(java.lang.String%5B%5D)" class="member-name-link">main</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>[] args)</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-tab2 method-summary-table-tab4"><code>protected org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLineParser</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#newParser()" class="member-name-link">newParser</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Create the parser to use for parsing and validating the command line.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#printFiles(boolean,boolean)" class="member-name-link">printFiles</a><wbr>(boolean showFiles, |
| boolean showStats)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Collect the hfiles and logs statistics of the snapshot and dump the file list if requested and |
| the collected information.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#printInfo()" class="member-name-link">printInfo</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Dump the <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client"><code>SnapshotDescription</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#printSchema()" class="member-name-link">printSchema</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Dump the <a href="../client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>TableDescriptor</code></a></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#printUsage()" class="member-name-link">printUsage</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine)" class="member-name-link">processOptions</a><wbr>(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method is called to process the options after they have been parsed.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.util.AbstractHBaseTool">Methods inherited from class org.apache.hadoop.hbase.util.<a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></h3> |
| <code><a href="../util/AbstractHBaseTool.html#addOption(org.apache.hbase.thirdparty.org.apache.commons.cli.Option)">addOption</a>, <a href="../util/AbstractHBaseTool.html#addOptNoArg(java.lang.String,java.lang.String)">addOptNoArg</a>, <a href="../util/AbstractHBaseTool.html#addOptNoArg(java.lang.String,java.lang.String,java.lang.String)">addOptNoArg</a>, <a href="../util/AbstractHBaseTool.html#addOptWithArg(java.lang.String,java.lang.String)">addOptWithArg</a>, <a href="../util/AbstractHBaseTool.html#addOptWithArg(java.lang.String,java.lang.String,java.lang.String)">addOptWithArg</a>, <a href="../util/AbstractHBaseTool.html#addRequiredOption(org.apache.hbase.thirdparty.org.apache.commons.cli.Option)">addRequiredOption</a>, <a href="../util/AbstractHBaseTool.html#addRequiredOptWithArg(java.lang.String,java.lang.String)">addRequiredOptWithArg</a>, <a href="../util/AbstractHBaseTool.html#addRequiredOptWithArg(java.lang.String,java.lang.String,java.lang.String)">addRequiredOptWithArg</a>, <a href="../util/AbstractHBaseTool.html#doStaticMain(java.lang.String%5B%5D)">doStaticMain</a>, <a href="../util/AbstractHBaseTool.html#getConf()">getConf</a>, <a href="../util/AbstractHBaseTool.html#getOptionAsDouble(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine,java.lang.String,double)">getOptionAsDouble</a>, <a href="../util/AbstractHBaseTool.html#getOptionAsInt(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine,java.lang.String,int)">getOptionAsInt</a>, <a href="../util/AbstractHBaseTool.html#getOptionAsInt(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine,java.lang.String,int,int)">getOptionAsInt</a>, <a href="../util/AbstractHBaseTool.html#getOptionAsLong(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine,java.lang.String,int)">getOptionAsLong</a>, <a href="../util/AbstractHBaseTool.html#getOptionAsLong(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine,java.lang.String,int,int)">getOptionAsLong</a>, <a href="../util/AbstractHBaseTool.html#parseArgs(java.lang.String%5B%5D)">parseArgs</a>, <a href="../util/AbstractHBaseTool.html#parseInt(java.lang.String,int,int)">parseInt</a>, <a href="../util/AbstractHBaseTool.html#parseLong(java.lang.String,long,long)">parseLong</a>, <a href="../util/AbstractHBaseTool.html#printUsage(java.lang.String,java.lang.String,java.lang.String)">printUsage</a>, <a href="../util/AbstractHBaseTool.html#processOldArgs(java.util.List)">processOldArgs</a>, <a href="../util/AbstractHBaseTool.html#run(java.lang.String%5B%5D)">run</a>, <a href="../util/AbstractHBaseTool.html#setConf(org.apache.hadoop.conf.Configuration)">setConf</a></code></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/snapshot/SnapshotInfo.html#line-72">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fs"> |
| <h3>fs</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">org.apache.hadoop.fs.FileSystem</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-366">fs</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rootDir"> |
| <h3>rootDir</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-367">rootDir</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="snapshotManifest"> |
| <h3>snapshotManifest</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-369">snapshotManifest</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="listSnapshots"> |
| <h3>listSnapshots</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-371">listSnapshots</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="snapshotName"> |
| <h3>snapshotName</h3> |
| <div class="member-signature"><span class="modifiers">private</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/snapshot/SnapshotInfo.html#line-372">snapshotName</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remoteDir"> |
| <h3>remoteDir</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">org.apache.hadoop.fs.Path</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-373">remoteDir</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="showSchema"> |
| <h3>showSchema</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-374">showSchema</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="showFiles"> |
| <h3>showFiles</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-375">showFiles</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="showStats"> |
| <h3>showStats</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-376">showStats</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="printSizeInBytes"> |
| <h3>printSizeInBytes</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-377">printSizeInBytes</a></span></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>SnapshotInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-71">SnapshotInfo</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="doWork()"> |
| <h3>doWork</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-379">doWork</a></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"><span class="descfrm-type-label">Description copied from class: <code><a href="../util/AbstractHBaseTool.html#doWork()">AbstractHBaseTool</a></code></span></div> |
| <div class="block">The "main function" of the tool</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/AbstractHBaseTool.html#doWork()">doWork</a></code> in class <code><a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></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></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="loadSnapshotInfo(java.lang.String)"> |
| <h3>loadSnapshotInfo</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-423">loadSnapshotInfo</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> snapshotName)</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">Load snapshot info and table descriptor for the specified snapshot</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>snapshotName</code> - name of the snapshot to load</dd> |
| <dt>Returns:</dt> |
| <dd>false if snapshot is not found</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="printInfo()"> |
| <h3>printInfo</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-439">printInfo</a></span>()</div> |
| <div class="block">Dump the <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client"><code>SnapshotDescription</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="printSchema()"> |
| <h3>printSchema</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-457">printSchema</a></span>()</div> |
| <div class="block">Dump the <a href="../client/TableDescriptor.html" title="interface in org.apache.hadoop.hbase.client"><code>TableDescriptor</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="printFiles(boolean,boolean)"> |
| <h3>printFiles</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-468">printFiles</a></span><wbr><span class="parameters">(boolean showFiles, |
| boolean showStats)</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">Collect the hfiles and logs statistics of the snapshot and dump the file list if requested and |
| the collected information.</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="fileSizeToString(long)"> |
| <h3>fileSizeToString</h3> |
| <div class="member-signature"><span class="modifiers">private</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/snapshot/SnapshotInfo.html#line-523">fileSizeToString</a></span><wbr><span class="parameters">(long size)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addOptions()"> |
| <h3>addOptions</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-527">addOptions</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../util/AbstractHBaseTool.html#addOptions()">AbstractHBaseTool</a></code></span></div> |
| <div class="block">Override this to add command-line options using <a href="../util/AbstractHBaseTool.html#addOptWithArg(java.lang.String,java.lang.String)"><code>AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String)</code></a> and similar methods.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/AbstractHBaseTool.html#addOptions()">addOptions</a></code> in class <code><a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="newParser()"> |
| <h3>newParser</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLineParser</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-538">newParser</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../util/AbstractHBaseTool.html#newParser()">AbstractHBaseTool</a></code></span></div> |
| <div class="block">Create the parser to use for parsing and validating the command line. Since commons-cli lacks |
| the capability to validate arbitrary combination of options, it may be helpful to bake custom |
| logic into a specialized parser implementation. See LoadTestTool for examples.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../util/AbstractHBaseTool.html#newParser()">newParser</a></code> in class <code><a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a new parser specific to the current tool</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine)"> |
| <h3>processOptions</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-555">processOptions</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../util/AbstractHBaseTool.html#processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine)">AbstractHBaseTool</a></code></span></div> |
| <div class="block">This method is called to process the options after they have been parsed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../util/AbstractHBaseTool.html#processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine)">processOptions</a></code> in class <code><a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="printUsage()"> |
| <h3>printUsage</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-569">printUsage</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../util/AbstractHBaseTool.html#printUsage()">printUsage</a></code> in class <code><a href="../util/AbstractHBaseTool.html" title="class in org.apache.hadoop.hbase.util">AbstractHBaseTool</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSnapshotStats(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.SnapshotDescription)"> |
| <h3>getSnapshotStats</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SnapshotInfo.SnapshotStats.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-582">getSnapshotStats</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot)</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 snapshot stats</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the <code>Configuration</code> to use</dd> |
| <dd><code>snapshot</code> - <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client"><code>SnapshotDescription</code></a> to get stats from</dd> |
| <dt>Returns:</dt> |
| <dd>the snapshot stats</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="getSnapshotStats(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription,java.util.Map)"> |
| <h3>getSnapshotStats</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SnapshotInfo.SnapshotStats.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-596">getSnapshotStats</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshotDesc, |
| <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><org.apache.hadoop.fs.Path,<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>> filesMap)</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 snapshot stats</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the <code>Configuration</code> to use</dd> |
| <dd><code>snapshotDesc</code> - HBaseProtos.SnapshotDescription to get stats from</dd> |
| <dd><code>filesMap</code> - <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"><code>Map</code></a> store files map for all snapshots, it may be null</dd> |
| <dt>Returns:</dt> |
| <dd>the snapshot stats</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="getSnapshotList(org.apache.hadoop.conf.Configuration)"> |
| <h3>getSnapshotList</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><<a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/snapshot/SnapshotInfo.html#line-622">getSnapshotList</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">Returns the list of available snapshots in the specified location</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the <code>Configuration</code> to use</dd> |
| <dt>Returns:</dt> |
| <dd>the list of snapshots</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="getSnapshotFilesMap(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.SnapshotDescription,java.util.concurrent.ExecutorService,java.util.concurrent.ConcurrentHashMap,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong)"> |
| <h3>getSnapshotFilesMap</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/snapshot/SnapshotInfo.html#line-648">getSnapshotFilesMap</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client">SnapshotDescription</a> snapshot, |
| <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> exec, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/ConcurrentHashMap.html" title="class or interface in java.util.concurrent" class="external-link">ConcurrentHashMap</a><org.apache.hadoop.fs.Path,<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>> filesMap, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesArchiveSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesMobSize)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Gets the store files map for snapshot</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the <code>Configuration</code> to use</dd> |
| <dd><code>snapshot</code> - <a href="../client/SnapshotDescription.html" title="class in org.apache.hadoop.hbase.client"><code>SnapshotDescription</code></a> to get stats from</dd> |
| <dd><code>exec</code> - the <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"><code>ExecutorService</code></a> to use</dd> |
| <dd><code>filesMap</code> - <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"><code>Map</code></a> the map to put the mapping entries</dd> |
| <dd><code>uniqueHFilesArchiveSize</code> - <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link"><code>AtomicLong</code></a> the accumulated store file size in archive</dd> |
| <dd><code>uniqueHFilesSize</code> - <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link"><code>AtomicLong</code></a> the accumulated store file size shared</dd> |
| <dd><code>uniqueHFilesMobSize</code> - <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link"><code>AtomicLong</code></a> the accumulated mob store file size shared</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="getSnapshotsFilesMap(org.apache.hadoop.conf.Configuration,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong,java.util.concurrent.atomic.AtomicLong)"> |
| <h3>getSnapshotsFilesMap</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><org.apache.hadoop.fs.Path,<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/snapshot/SnapshotInfo.html#line-709">getSnapshotsFilesMap</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/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesArchiveSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesSize, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/AtomicLong.html" title="class or interface in java.util.concurrent.atomic" class="external-link">AtomicLong</a> uniqueHFilesMobSize)</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 map of store files based on path for all snapshots</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - the <code>Configuration</code> to use</dd> |
| <dd><code>uniqueHFilesArchiveSize</code> - pass out the size for store files in archive</dd> |
| <dd><code>uniqueHFilesSize</code> - pass out the size for store files shared</dd> |
| <dd><code>uniqueHFilesMobSize</code> - pass out the size for mob store files shared</dd> |
| <dt>Returns:</dt> |
| <dd>the map of store files</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="main(java.lang.String[])"> |
| <h3>main</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/snapshot/SnapshotInfo.html#line-734">main</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>[] args)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
