| <!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 org.apache.hadoop.hbase.HConstants;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * BackupRestoreConstants holds a bunch of HBase Backup and Restore constants<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> */<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>@InterfaceAudience.Private<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>public interface BackupRestoreConstants {<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> /*<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Backup/Restore constants<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> */<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> String BACKUP_SYSTEM_TABLE_NAME_KEY = "hbase.backup.system.table.name";<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> String BACKUP_SYSTEM_TABLE_NAME_DEFAULT = "backup:system";<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> String BACKUP_SYSTEM_TTL_KEY = "hbase.backup.system.ttl";<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> int BACKUP_SYSTEM_TTL_DEFAULT = HConstants.FOREVER;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> String BACKUP_ENABLE_KEY = "hbase.backup.enable";<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> boolean BACKUP_ENABLE_DEFAULT = false;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> String BACKUP_MAX_ATTEMPTS_KEY = "hbase.backup.attempts.max";<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> int DEFAULT_BACKUP_MAX_ATTEMPTS = 10;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> String BACKUP_ATTEMPTS_PAUSE_MS_KEY = "hbase.backup.attempts.pause.ms";<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> int DEFAULT_BACKUP_ATTEMPTS_PAUSE_MS = 10000;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /*<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Drivers option list<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> String OPTION_OVERWRITE = "o";<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> String OPTION_OVERWRITE_DESC = "Overwrite data if any of the restore target tables exists";<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> String OPTION_CHECK = "c";<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> String OPTION_CHECK_DESC =<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> "Check restore sequence and dependencies only (does not execute the command)";<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> String OPTION_SET = "s";<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> String OPTION_SET_DESC = "Backup set name";<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> String OPTION_SET_RESTORE_DESC = "Backup set to restore, mutually exclusive with -t (table list)";<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> String OPTION_SET_BACKUP_DESC = "Backup set to backup, mutually exclusive with -t (table list)";<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> String OPTION_DEBUG = "d";<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> String OPTION_DEBUG_DESC = "Enable debug loggings";<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> String OPTION_TABLE = "t";<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> String OPTION_TABLE_DESC = "Table name. If specified, only backup images,"<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> + " which contain this table will be listed.";<a name="line.66"></a> |
| <span class="sourceLineNo">067</span><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> String OPTION_LIST = "l";<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> String OPTION_TABLE_LIST_DESC = "Table name list, comma-separated.";<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> String OPTION_BACKUP_LIST_DESC = "Backup ids list, comma-separated.";<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> String OPTION_BANDWIDTH = "b";<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> String OPTION_BANDWIDTH_DESC = "Bandwidth per task (MapReduce task) in MB/s";<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> String OPTION_WORKERS = "w";<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> String OPTION_WORKERS_DESC = "Number of parallel MapReduce tasks to execute";<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> String OPTION_RECORD_NUMBER = "n";<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> String OPTION_RECORD_NUMBER_DESC = "Number of records of backup history. Default: 10";<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> String OPTION_PATH = "p";<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> String OPTION_PATH_DESC = "Backup destination root directory path";<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> String OPTION_KEEP = "k";<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> String OPTION_KEEP_DESC = "Specifies maximum age of backup (in days) to keep during bulk delete";<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> String OPTION_TABLE_MAPPING = "m";<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> String OPTION_TABLE_MAPPING_DESC =<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> "A comma separated list of target tables. "<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> + "If specified, each table in <tables> must have a mapping";<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> String OPTION_YARN_QUEUE_NAME = "q";<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> String OPTION_YARN_QUEUE_NAME_DESC = "Yarn queue name to run backup create command on";<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> String OPTION_YARN_QUEUE_NAME_RESTORE_DESC = "Yarn queue name to run backup restore command on";<a name="line.94"></a> |
| <span class="sourceLineNo">095</span><a name="line.95"></a> |
| <span class="sourceLineNo">096</span> String JOB_NAME_CONF_KEY = "mapreduce.job.name";<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> String BACKUP_CONFIG_STRING = BackupRestoreConstants.BACKUP_ENABLE_KEY<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> + "=true\n"<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> + "hbase.master.logcleaner.plugins="<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> +"YOUR_PLUGINS,org.apache.hadoop.hbase.backup.master.BackupLogCleaner\n"<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> + "hbase.procedure.master.classes=YOUR_CLASSES,"<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> +"org.apache.hadoop.hbase.backup.master.LogRollMasterProcedureManager\n"<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> + "hbase.procedure.regionserver.classes=YOUR_CLASSES,"<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> + "org.apache.hadoop.hbase.backup.regionserver.LogRollRegionServerProcedureManager\n"<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> + "hbase.coprocessor.region.classes=YOUR_CLASSES,"<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> + "org.apache.hadoop.hbase.backup.BackupObserver\n"<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> + "and restart the cluster\n";<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> String ENABLE_BACKUP = "Backup is not enabled. To enable backup, "+<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> "in hbase-site.xml, set:\n "<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> + BACKUP_CONFIG_STRING;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> String VERIFY_BACKUP = "Please make sure that backup is enabled on the cluster. To enable "<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> + "backup, in hbase-site.xml, set:\n " + BACKUP_CONFIG_STRING;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> /*<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * Delimiter in table name list in restore command<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> String TABLENAME_DELIMITER_IN_COMMAND = ",";<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> String CONF_STAGING_ROOT = "snapshot.export.staging.root";<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> String BACKUPID_PREFIX = "backup_";<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> enum BackupCommand {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> CREATE, CANCEL, DELETE, DESCRIBE, HISTORY, STATUS, CONVERT, MERGE, STOP, SHOW, HELP, PROGRESS,<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> SET, SET_ADD, SET_REMOVE, SET_DELETE, SET_DESCRIBE, SET_LIST, REPAIR<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
