blob: 3e49f6a3f4938b6b9fa35a81006d6e1e4edb0d71 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>org.apache.hadoop.hbase.backup (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.backup">
<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.backup" class="title">Package org.apache.hadoop.hbase.backup</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.hadoop.hbase.backup</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 class="col-first odd-row-color"><a href="example/package-summary.html">org.apache.hadoop.hbase.backup.example</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="impl/package-summary.html">org.apache.hadoop.hbase.backup.impl</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="mapreduce/package-summary.html">org.apache.hadoop.hbase.backup.mapreduce</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="master/package-summary.html">org.apache.hadoop.hbase.backup.master</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="regionserver/package-summary.html">org.apache.hadoop.hbase.backup.regionserver</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="util/package-summary.html">org.apache.hadoop.hbase.backup.util</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-tab1"><a href="BackupAdmin.html" title="interface in org.apache.hadoop.hbase.backup">BackupAdmin</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">The administrative API for HBase Backup.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BackupClientFactory.html" title="class in org.apache.hadoop.hbase.backup">BackupClientFactory</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-tab1"><a href="BackupCopyJob.html" title="interface in org.apache.hadoop.hbase.backup">BackupCopyJob</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Backup copy job is a part of a backup process.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BackupDriver.html" title="class in org.apache.hadoop.hbase.backup">BackupDriver</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Command-line entry point for backup operation</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BackupHFileCleaner.html" title="class in org.apache.hadoop.hbase.backup">BackupHFileCleaner</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Implementation of a file cleaner that checks if an hfile is still referenced by backup before
deleting it from hfile archive directory.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BackupInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupInfo</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An object to encapsulate the information for each backup session</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="BackupInfo.BackupPhase.html" title="enum class in org.apache.hadoop.hbase.backup">BackupInfo.BackupPhase</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">BackupPhase - phases of an ACTIVE backup session (running), when state of a backup session is
BackupState.RUNNING</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="BackupInfo.BackupState.html" title="enum class in org.apache.hadoop.hbase.backup">BackupInfo.BackupState</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">Backup session states</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="BackupInfo.Filter.html" title="interface in org.apache.hadoop.hbase.backup">BackupInfo.Filter</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-tab1"><a href="BackupMergeJob.html" title="interface in org.apache.hadoop.hbase.backup">BackupMergeJob</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">Backup merge operation job interface.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BackupObserver.html" title="class in org.apache.hadoop.hbase.backup">BackupObserver</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An Observer to facilitate backup operations</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BackupRequest.html" title="class in org.apache.hadoop.hbase.backup">BackupRequest</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">POJO class for backup request</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BackupRequest.Builder.html" title="class in org.apache.hadoop.hbase.backup">BackupRequest.Builder</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-tab1"><a href="BackupRestoreConstants.html" title="interface in org.apache.hadoop.hbase.backup">BackupRestoreConstants</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab1">
<div class="block">BackupRestoreConstants holds a bunch of HBase Backup and Restore constants</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="BackupRestoreConstants.BackupCommand.html" title="enum class in org.apache.hadoop.hbase.backup">BackupRestoreConstants.BackupCommand</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="BackupRestoreFactory.html" title="class in org.apache.hadoop.hbase.backup">BackupRestoreFactory</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Factory implementation for backup/restore related jobs</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="BackupTableInfo.html" title="class in org.apache.hadoop.hbase.backup">BackupTableInfo</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Backup related information encapsulated for a table.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab3"><a href="BackupType.html" title="enum class in org.apache.hadoop.hbase.backup">BackupType</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-tab5"><a href="FailedArchiveException.html" title="class in org.apache.hadoop.hbase.backup">FailedArchiveException</a></div>
<div class="col-last even-row-color class-summary class-summary-tab5">
<div class="block">Exception indicating that some files in the requested set could not be archived.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HBackupFileSystem.html" title="class in org.apache.hadoop.hbase.backup">HBackupFileSystem</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">View to an on-disk Backup Image FileSytem Provides the set of methods necessary to interact with
the on-disk Backup Image data.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HFileArchiver.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Utility class to handle the removal of HFiles (or the respective <a href="../regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>StoreFiles</code></a>)
for a HRegion from the <code>FileSystem</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.File</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Wrapper to handle file operations uniformly</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HFileArchiver.FileablePath.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileablePath</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A <a href="HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><code>HFileArchiver.File</code></a> that wraps a simple <code>Path</code> on a <code>FileSystem</code>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HFileArchiver.FileableStoreFile.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileableStoreFile</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block"><a href="HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><code>HFileArchiver.File</code></a> adapter for a <a href="../regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HStoreFile</code></a> living on a <code>FileSystem</code> .</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HFileArchiver.FileConverter.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileConverter</a>&lt;T&gt;</div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Adapt a type to match the <a href="HFileArchiver.File.html" title="class in org.apache.hadoop.hbase.backup"><code>HFileArchiver.File</code></a> interface, which is used internally for handling
archival/removal of files</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="HFileArchiver.FileStatusConverter.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.FileStatusConverter</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Convert a FileStatus to something we can manage in the archiving</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="HFileArchiver.StoreToFile.html" title="class in org.apache.hadoop.hbase.backup">HFileArchiver.StoreToFile</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Convert the <a href="../regionserver/HStoreFile.html" title="class in org.apache.hadoop.hbase.regionserver"><code>HStoreFile</code></a> into something we can manage in the archive methods</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RestoreDriver.html" title="class in org.apache.hadoop.hbase.backup">RestoreDriver</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Command-line entry point for restore operation</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="RestoreJob.html" title="interface in org.apache.hadoop.hbase.backup">RestoreJob</a></div>
<div class="col-last even-row-color class-summary class-summary-tab1">
<div class="block">Restore operation job interface Concrete implementation is provided by backup provider, see
<a href="BackupRestoreFactory.html" title="class in org.apache.hadoop.hbase.backup"><code>BackupRestoreFactory</code></a></div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RestoreRequest.html" title="class in org.apache.hadoop.hbase.backup">RestoreRequest</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">POJO class for restore request</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RestoreRequest.Builder.html" title="class in org.apache.hadoop.hbase.backup">RestoreRequest.Builder</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</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>