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