| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.backup, interface: BackupAdmin"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.backup;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Closeable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.List;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.backup.util.BackupSet;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * The administrative API for HBase Backup. Construct an instance and call {@link #close()}</span> |
| <span class="source-line-no">029</span><span id="line-29"> * afterwards.</span> |
| <span class="source-line-no">030</span><span id="line-30"> * <p></span> |
| <span class="source-line-no">031</span><span id="line-31"> * BackupAdmin can be used to create backups, restore data from backups and for other backup-related</span> |
| <span class="source-line-no">032</span><span id="line-32"> * operations.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * @since 2.0</span> |
| <span class="source-line-no">034</span><span id="line-34"> */</span> |
| <span class="source-line-no">035</span><span id="line-35">@InterfaceAudience.Private</span> |
| <span class="source-line-no">036</span><span id="line-36">public interface BackupAdmin extends Closeable {</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /**</span> |
| <span class="source-line-no">039</span><span id="line-39"> * Backup given list of tables fully. This is a synchronous operation. It returns backup id on</span> |
| <span class="source-line-no">040</span><span id="line-40"> * success or throw exception on failure.</span> |
| <span class="source-line-no">041</span><span id="line-41"> * @param userRequest BackupRequest instance</span> |
| <span class="source-line-no">042</span><span id="line-42"> * @return the backup Id</span> |
| <span class="source-line-no">043</span><span id="line-43"> */</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> String backupTables(final BackupRequest userRequest) throws IOException;</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Restore backup</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @param request restore request</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @throws IOException exception</span> |
| <span class="source-line-no">051</span><span id="line-51"> */</span> |
| <span class="source-line-no">052</span><span id="line-52"> void restore(RestoreRequest request) throws IOException;</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Describe backup image command</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param backupId backup id</span> |
| <span class="source-line-no">057</span><span id="line-57"> * @return backup info</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @throws IOException exception</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> BackupInfo getBackupInfo(String backupId) throws IOException;</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Delete backup image command</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param backupIds array of backup ids</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @return total number of deleted sessions</span> |
| <span class="source-line-no">066</span><span id="line-66"> * @throws IOException exception</span> |
| <span class="source-line-no">067</span><span id="line-67"> */</span> |
| <span class="source-line-no">068</span><span id="line-68"> int deleteBackups(String[] backupIds) throws IOException;</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Merge backup images command</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param backupIds array of backup ids of images to be merged The resulting backup image will</span> |
| <span class="source-line-no">073</span><span id="line-73"> * have the same backup id as the most recent image from a list of images to be</span> |
| <span class="source-line-no">074</span><span id="line-74"> * merged</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @throws IOException exception</span> |
| <span class="source-line-no">076</span><span id="line-76"> */</span> |
| <span class="source-line-no">077</span><span id="line-77"> void mergeBackups(String[] backupIds) throws IOException;</span> |
| <span class="source-line-no">078</span><span id="line-78"></span> |
| <span class="source-line-no">079</span><span id="line-79"> /**</span> |
| <span class="source-line-no">080</span><span id="line-80"> * Show backup history command</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @param n last n backup sessions</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @return list of backup info objects</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @throws IOException exception</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> List<BackupInfo> getHistory(int n) throws IOException;</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Show backup history command with filters</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param n last n backup sessions</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @param f list of filters</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @return list of backup info objects</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @throws IOException exception</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> List<BackupInfo> getHistory(int n, BackupInfo.Filter... f) throws IOException;</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Backup sets list command - list all backup sets. Backup set is a named group of tables.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @return all registered backup sets</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @throws IOException exception</span> |
| <span class="source-line-no">100</span><span id="line-100"> */</span> |
| <span class="source-line-no">101</span><span id="line-101"> List<BackupSet> listBackupSets() throws IOException;</span> |
| <span class="source-line-no">102</span><span id="line-102"></span> |
| <span class="source-line-no">103</span><span id="line-103"> /**</span> |
| <span class="source-line-no">104</span><span id="line-104"> * Backup set describe command. Shows list of tables in this particular backup set.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param name set name</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @return backup set description or null</span> |
| <span class="source-line-no">107</span><span id="line-107"> * @throws IOException exception</span> |
| <span class="source-line-no">108</span><span id="line-108"> */</span> |
| <span class="source-line-no">109</span><span id="line-109"> BackupSet getBackupSet(String name) throws IOException;</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> /**</span> |
| <span class="source-line-no">112</span><span id="line-112"> * Delete backup set command</span> |
| <span class="source-line-no">113</span><span id="line-113"> * @param name backup set name</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @return true, if success, false - otherwise</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @throws IOException exception</span> |
| <span class="source-line-no">116</span><span id="line-116"> */</span> |
| <span class="source-line-no">117</span><span id="line-117"> boolean deleteBackupSet(String name) throws IOException;</span> |
| <span class="source-line-no">118</span><span id="line-118"></span> |
| <span class="source-line-no">119</span><span id="line-119"> /**</span> |
| <span class="source-line-no">120</span><span id="line-120"> * Add tables to backup set command</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @param name name of backup set.</span> |
| <span class="source-line-no">122</span><span id="line-122"> * @param tables array of tables to be added to this set.</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @throws IOException exception</span> |
| <span class="source-line-no">124</span><span id="line-124"> */</span> |
| <span class="source-line-no">125</span><span id="line-125"> void addToBackupSet(String name, TableName[] tables) throws IOException;</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> /**</span> |
| <span class="source-line-no">128</span><span id="line-128"> * Remove tables from backup set</span> |
| <span class="source-line-no">129</span><span id="line-129"> * @param name name of backup set.</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @param tables array of tables to be removed from this set.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * @throws IOException exception</span> |
| <span class="source-line-no">132</span><span id="line-132"> */</span> |
| <span class="source-line-no">133</span><span id="line-133"> void removeFromBackupSet(String name, TableName[] tables) throws IOException;</span> |
| <span class="source-line-no">134</span><span id="line-134">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
