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