| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ZKTableArchiveClient (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.example, class: ZKTableArchiveClient"> |
| <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/ZKTableArchiveClient.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><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.backup.example</a></div> |
| <h1 title="Class ZKTableArchiveClient" class="title">Class ZKTableArchiveClient</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.conf.Configured |
| <div class="inheritance">org.apache.hadoop.hbase.backup.example.ZKTableArchiveClient</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></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-33">ZKTableArchiveClient</a></span> |
| <span class="extends-implements">extends org.apache.hadoop.conf.Configured</span></div> |
| <div class="block">Example class for how to use the table archiving coordinated via zookeeper</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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 <a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#connection" class="member-name-link">connection</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#ZOOKEEPER_ZNODE_HFILE_ARCHIVE_KEY" class="member-name-link">ZOOKEEPER_ZNODE_HFILE_ARCHIVE_KEY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Configuration key for the archive node.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table 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(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.Connection)" class="member-name-link">ZKTableArchiveClient</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> connection)</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>private <a href="HFileArchiveManager.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveManager</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createHFileArchiveManager()" class="member-name-link">createHFileArchiveManager</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>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disableHFileBackup()" class="member-name-link">disableHFileBackup</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Disable hfile backups for all tables.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disableHFileBackup(byte%5B%5D)" class="member-name-link">disableHFileBackup</a><wbr>(byte[] table)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Disable hfile backups for the given table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disableHFileBackup(java.lang.String)" class="member-name-link">disableHFileBackup</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> table)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Disable hfile backups for the given table.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableHFileBackupAsync(byte%5B%5D)" class="member-name-link">enableHFileBackupAsync</a><wbr>(byte[] table)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Turn on backups for all HFiles for the given table.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getArchiveZNode(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.zookeeper.ZKWatcher)" class="member-name-link">getArchiveZNode</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zooKeeper)</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getArchivingEnabled(byte%5B%5D)" class="member-name-link">getArchivingEnabled</a><wbr>(byte[] table)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determine if archiving is enabled (but not necessarily fully propagated) for a table</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getArchivingEnabled(java.lang.String)" class="member-name-link">getArchivingEnabled</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> table)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Determine if archiving is enabled (but not necessarily fully propagated) for a table</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.conf.Configured">Methods inherited from class org.apache.hadoop.conf.Configured</h3> |
| <code>getConf, setConf</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="ZOOKEEPER_ZNODE_HFILE_ARCHIVE_KEY"> |
| <h3>ZOOKEEPER_ZNODE_HFILE_ARCHIVE_KEY</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-37">ZOOKEEPER_ZNODE_HFILE_ARCHIVE_KEY</a></span></div> |
| <div class="block">Configuration key for the archive node.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.backup.example.ZKTableArchiveClient.ZOOKEEPER_ZNODE_HFILE_ARCHIVE_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="connection"> |
| <h3>connection</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-38">connection</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>(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.client.Connection)"> |
| <h3>ZKTableArchiveClient</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-40">ZKTableArchiveClient</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../client/Connection.html" title="interface in org.apache.hadoop.hbase.client">Connection</a> connection)</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="enableHFileBackupAsync(byte[])"> |
| <h3>enableHFileBackupAsync</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-59">enableHFileBackupAsync</a></span><wbr><span class="parameters">(byte[] table)</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>, |
| org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Turn on backups for all HFiles for the given table. |
| <p> |
| All deleted hfiles are moved to the archive directory under the table directory, rather than |
| being deleted. |
| <p> |
| If backups are already enabled for this table, does nothing. |
| <p> |
| If the table does not exist, the archiving the table's hfiles is still enabled as a future |
| table with that name may be created shortly.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - name of the table to start backing up</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an unexpected exception occurs</dd> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if zookeeper can't be reached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disableHFileBackup(java.lang.String)"> |
| <h3>disableHFileBackup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-74">disableHFileBackup</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> table)</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>, |
| org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Disable hfile backups for the given table. |
| <p> |
| Previously backed up files are still retained (if present). |
| <p> |
| Asynchronous operation - some extra HFiles may be retained, in the archive directory after |
| disable is called, dependent on the latency in zookeeper to the servers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - name of the table stop backing up</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an unexpected exception occurs</dd> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if zookeeper can't be reached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disableHFileBackup(byte[])"> |
| <h3>disableHFileBackup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-89">disableHFileBackup</a></span><wbr><span class="parameters">(byte[] table)</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>, |
| org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Disable hfile backups for the given table. |
| <p> |
| Previously backed up files are still retained (if present). |
| <p> |
| Asynchronous operation - some extra HFiles may be retained, in the archive directory after |
| disable is called, dependent on the latency in zookeeper to the servers.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - name of the table stop backing up</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an unexpected exception occurs</dd> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if zookeeper can't be reached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="disableHFileBackup()"> |
| <h3>disableHFileBackup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-103">disableHFileBackup</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>, |
| org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Disable hfile backups for all tables. |
| <p> |
| Previously backed up files are still retained (if present). |
| <p> |
| Asynchronous operation - some extra HFiles may be retained, in the archive directory after |
| disable is called, dependent on the latency in zookeeper to the servers.</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> - if an unexpected exception occurs</dd> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if zookeeper can't be reached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArchivingEnabled(byte[])"> |
| <h3>getArchivingEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-114">getArchivingEnabled</a></span><wbr><span class="parameters">(byte[] table)</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>, |
| org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Determine if archiving is enabled (but not necessarily fully propagated) for a table</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - name of the table to check</dd> |
| <dt>Returns:</dt> |
| <dd><tt>true</tt> if it is, <tt>false</tt> otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if a connection to ZooKeeper cannot be established</dd> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if a ZooKeeper operation fails</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArchivingEnabled(java.lang.String)"> |
| <h3>getArchivingEnabled</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-130">getArchivingEnabled</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> table)</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>, |
| org.apache.zookeeper.KeeperException</span></div> |
| <div class="block">Determine if archiving is enabled (but not necessarily fully propagated) for a table</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>table</code> - name of the table to check</dd> |
| <dt>Returns:</dt> |
| <dd><tt>true</tt> if it is, <tt>false</tt> otherwise</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an unexpected network issue occurs</dd> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if zookeeper can't be reached</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createHFileArchiveManager()"> |
| <h3>createHFileArchiveManager</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="HFileArchiveManager.html" title="class in org.apache.hadoop.hbase.backup.example">HFileArchiveManager</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-140">createHFileArchiveManager</a></span>() |
| throws <span class="exceptions">org.apache.zookeeper.KeeperException, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A new <a href="HFileArchiveManager.html" title="class in org.apache.hadoop.hbase.backup.example"><code>HFileArchiveManager</code></a> to manage which tables' hfiles should be archived |
| rather than deleted.</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.zookeeper.KeeperException</code> - if we can't reach zookeeper</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if an unexpected network issue occurs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getArchiveZNode(org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.zookeeper.ZKWatcher)"> |
| <h3>getArchiveZNode</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/backup/example/ZKTableArchiveClient.html#line-150">getArchiveZNode</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| <a href="../../zookeeper/ZKWatcher.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKWatcher</a> zooKeeper)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - conf to read for the base archive node</dd> |
| <dd><code>zooKeeper</code> - zookeeper to used for building the full path</dd> |
| <dt>Returns:</dt> |
| <dd>get the znode for long-term archival of a table for</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
