blob: 21e87244ae5515be4636a1947915b0279de01627 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.hadoop.hbase.snapshot (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li>Description&nbsp;|&nbsp;</li>
<li><a href="#related-package-summary">Related Packages</a>&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.hadoop.hbase.snapshot" class="title">Package org.apache.hadoop.hbase.snapshot</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.hadoop.hbase.snapshot</span></div>
<section class="summary">
<ul class="summary-list">
<li>
<div id="related-package-summary">
<div class="caption"><span>Related Packages</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="../package-summary.html">org.apache.hadoop.hbase</a></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</div>
</li>
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab1', 2)" class="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab5', 2)" class="table-tab">Exceptions</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ClientSnapshotDescriptionUtils.html" title="class in org.apache.hadoop.hbase.snapshot">ClientSnapshotDescriptionUtils</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Class to help with dealing with a snapshot description on the client side.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="CorruptedSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">CorruptedSnapshotException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Exception thrown when the found snapshot info from the filesystem is not valid.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CreateSnapshot.html" title="class in org.apache.hadoop.hbase.snapshot">CreateSnapshot</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This is a command line class that will snapshot a given table.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Export the specified snapshot to a given FileSystem.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="ExportSnapshot.ChecksumComparison.html" title="enum class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.ChecksumComparison</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">Indicates the checksum comparison result.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="ExportSnapshot.Counter.html" title="enum class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.Counter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.ExportMapper.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.ExportMapper</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.ExportSnapshotInputFormat.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.ExportSnapshotInputFormat</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.ExportSnapshotInputFormat.ExportSnapshotInputSplit.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.ExportSnapshotInputFormat.ExportSnapshotInputSplit</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.ExportSnapshotInputFormat.ExportSnapshotRecordReader.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.ExportSnapshotInputFormat.ExportSnapshotRecordReader</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.Options.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.Options</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ExportSnapshot.Testing.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshot.Testing</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="ExportSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">ExportSnapshotException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a snapshot could not be exported due to an error during the operation.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="HBaseSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">HBaseSnapshotException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">General exception base class for when a snapshot fails.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="RestoreSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">RestoreSnapshotException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a snapshot could not be restored due to a server-side error when restoring it.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RestoreSnapshotHelper.html" title="class in org.apache.hadoop.hbase.snapshot">RestoreSnapshotHelper</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Helper to Restore/Clone a Snapshot</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RestoreSnapshotHelper.RestoreMetaChanges.html" title="class in org.apache.hadoop.hbase.snapshot">RestoreSnapshotHelper.RestoreMetaChanges</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Describe the set of operations needed to update hbase:meta after restore.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="SnapshotCreationException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotCreationException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a snapshot could not be created due to a server-side error when taking the snapshot.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotDescriptionUtils.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotDescriptionUtils</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility class to help manage <code>SnapshotDesriptions</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotDescriptionUtils.CompletedSnaphotDirectoriesFilter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Filter that only accepts completed snapshot directories</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="SnapshotDoesNotExistException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotDoesNotExistException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown when the server is looking for a snapshot, but can't find the snapshot on the filesystem.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="SnapshotExistsException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotExistsException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a snapshot exists, but should not.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotInfo.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Tool for dumping snapshot information.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SnapshotInfo.Options.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.Options</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotInfo.SnapshotStats.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<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 class="col-first odd-row-color class-summary class-summary-tab2"><a href="SnapshotInfo.SnapshotStats.FileInfo.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotInfo.SnapshotStats.FileInfo</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Information about the file referenced by the snapshot</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotManifest.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifest</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility class to help read/write the Snapshot Manifest.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SnapshotManifest.RegionVisitor.html" title="interface in org.apache.hadoop.hbase.snapshot">SnapshotManifest.RegionVisitor</a>&lt;TRegion,<wbr>TFamily&gt;</div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotManifestV1.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifestV1</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">DO NOT USE DIRECTLY.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SnapshotManifestV1.ManifestBuilder.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifestV1.ManifestBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotManifestV2.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifestV2</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">DO NOT USE DIRECTLY.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SnapshotManifestV2.ManifestBuilder.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotManifestV2.ManifestBuilder</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SnapshotReferenceUtil.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotReferenceUtil</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility methods for interacting with the snapshot referenced files.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab1"><a href="SnapshotReferenceUtil.SnapshotVisitor.html" title="interface in org.apache.hadoop.hbase.snapshot">SnapshotReferenceUtil.SnapshotVisitor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="SnapshotReferenceUtil.StoreFileVisitor.html" title="interface in org.apache.hadoop.hbase.snapshot">SnapshotReferenceUtil.StoreFileVisitor</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="SnapshotTTLExpiredException.html" title="class in org.apache.hadoop.hbase.snapshot">SnapshotTTLExpiredException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Thrown when a snapshot could not be restored/cloned because the ttl for snapshot has already
expired</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab5"><a href="TablePartiallyOpenException.html" title="class in org.apache.hadoop.hbase.snapshot">TablePartiallyOpenException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Thrown if a table should be online/offline, but is partially open.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab5"><a href="UnknownSnapshotException.html" title="class in org.apache.hadoop.hbase.snapshot">UnknownSnapshotException</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab5">
<div class="block">Exception thrown when we get a request for a snapshot we don't recognize.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>