| <!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.client, interface: Hbck"> |
| <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.client;</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 java.util.Map;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.Abortable;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ServerName;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.master.RegionState;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">/**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * Hbck fixup tool APIs. Obtain an instance from {@link Connection#getHbck()} and call</span> |
| <span class="source-line-no">032</span><span id="line-32"> * {@link #close()} when done.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * <p></span> |
| <span class="source-line-no">034</span><span id="line-34"> * WARNING: the below methods can damage the cluster. It may leave the cluster in an indeterminate</span> |
| <span class="source-line-no">035</span><span id="line-35"> * state, e.g. region not assigned, or some hdfs files left behind. After running any of the below,</span> |
| <span class="source-line-no">036</span><span id="line-36"> * operators may have to do some clean up on hdfs or schedule some assign procedures to get regions</span> |
| <span class="source-line-no">037</span><span id="line-37"> * back online. DO AT YOUR OWN RISK. For experienced users only.</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @see ConnectionFactory</span> |
| <span class="source-line-no">039</span><span id="line-39"> * @since 2.0.2, 2.1.1</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.HBCK)</span> |
| <span class="source-line-no">042</span><span id="line-42">public interface Hbck extends Abortable, Closeable {</span> |
| <span class="source-line-no">043</span><span id="line-43"> /**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Update table state in Meta only. No procedures are submitted to open/assign or close/unassign</span> |
| <span class="source-line-no">045</span><span id="line-45"> * regions of the table.</span> |
| <span class="source-line-no">046</span><span id="line-46"> * @param state table state</span> |
| <span class="source-line-no">047</span><span id="line-47"> * @return previous state of the table in Meta</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49"> TableState setTableStateInMeta(TableState state) throws IOException;</span> |
| <span class="source-line-no">050</span><span id="line-50"></span> |
| <span class="source-line-no">051</span><span id="line-51"> /**</span> |
| <span class="source-line-no">052</span><span id="line-52"> * Update region state in Meta only. No procedures are submitted to manipulate the given region or</span> |
| <span class="source-line-no">053</span><span id="line-53"> * any other region from same table.</span> |
| <span class="source-line-no">054</span><span id="line-54"> * @param nameOrEncodedName2State list of all region states to be updated in meta</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @return previous state of the region in Meta</span> |
| <span class="source-line-no">056</span><span id="line-56"> */</span> |
| <span class="source-line-no">057</span><span id="line-57"> Map<String, RegionState.State></span> |
| <span class="source-line-no">058</span><span id="line-58"> setRegionStateInMeta(Map<String, RegionState.State> nameOrEncodedName2State) throws IOException;</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> /**</span> |
| <span class="source-line-no">061</span><span id="line-61"> * Like {@link Admin#assign(byte[])} but 'raw' in that it can do more than one Region at a time --</span> |
| <span class="source-line-no">062</span><span id="line-62"> * good if many Regions to online -- and it will schedule the assigns even in the case where</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Master is initializing (as long as the ProcedureExecutor is up). Does NOT call Coprocessor</span> |
| <span class="source-line-no">064</span><span id="line-64"> * hooks.</span> |
| <span class="source-line-no">065</span><span id="line-65"> * @param override You need to add override for unset of the procedure from</span> |
| <span class="source-line-no">066</span><span id="line-66"> * RegionStateNode without byPassing preTransitCheck</span> |
| <span class="source-line-no">067</span><span id="line-67"> * @param force You need to add force for case where a region has previously been</span> |
| <span class="source-line-no">068</span><span id="line-68"> * bypassed. When a Procedure has been bypassed, a Procedure will have</span> |
| <span class="source-line-no">069</span><span id="line-69"> * completed but no other Procedure will be able to make progress on the</span> |
| <span class="source-line-no">070</span><span id="line-70"> * target entity (intentionally). Skips preTransitCheck only when</span> |
| <span class="source-line-no">071</span><span id="line-71"> * selected along with override option</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param encodedRegionNames Region encoded names; e.g. 1588230740 is the hard-coded encoding for</span> |
| <span class="source-line-no">073</span><span id="line-73"> * hbase:meta region and de00010733901a05f5a2a3a382e27dd4 is an example</span> |
| <span class="source-line-no">074</span><span id="line-74"> * of what a random user-space encoded Region name looks like.</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> List<Long> assigns(List<String> encodedRegionNames, boolean override, boolean force)</span> |
| <span class="source-line-no">077</span><span id="line-77"> 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"> default List<Long> assigns(List<String> encodedRegionNames, boolean override) throws IOException {</span> |
| <span class="source-line-no">080</span><span id="line-80"> return assigns(encodedRegionNames, override, true);</span> |
| <span class="source-line-no">081</span><span id="line-81"> }</span> |
| <span class="source-line-no">082</span><span id="line-82"></span> |
| <span class="source-line-no">083</span><span id="line-83"> default List<Long> assigns(List<String> encodedRegionNames) throws IOException {</span> |
| <span class="source-line-no">084</span><span id="line-84"> return assigns(encodedRegionNames, false, false);</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</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"> * Like {@link Admin#unassign(byte[], boolean)} but 'raw' in that it can do more than one Region</span> |
| <span class="source-line-no">089</span><span id="line-89"> * at a time -- good if many Regions to offline -- and it will schedule the assigns even in the</span> |
| <span class="source-line-no">090</span><span id="line-90"> * case where Master is initializing (as long as the ProcedureExecutor is up). Does NOT call</span> |
| <span class="source-line-no">091</span><span id="line-91"> * Coprocessor hooks.</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @param override You need to add override for unset of the procedure from</span> |
| <span class="source-line-no">093</span><span id="line-93"> * RegionStateNode without byPassing preTransitCheck</span> |
| <span class="source-line-no">094</span><span id="line-94"> * @param force You need to add force for case where a region has previously been</span> |
| <span class="source-line-no">095</span><span id="line-95"> * bypassed. When a Procedure has been bypassed, a Procedure will have</span> |
| <span class="source-line-no">096</span><span id="line-96"> * completed but no other Procedure will be able to make progress on the</span> |
| <span class="source-line-no">097</span><span id="line-97"> * target entity (intentionally). Skips preTransitCheck only when</span> |
| <span class="source-line-no">098</span><span id="line-98"> * selected along with override option</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @param encodedRegionNames Region encoded names; e.g. 1588230740 is the hard-coded encoding for</span> |
| <span class="source-line-no">100</span><span id="line-100"> * hbase:meta region and de00010733901a05f5a2a3a382e27dd4 is an example</span> |
| <span class="source-line-no">101</span><span id="line-101"> * of what a random user-space encoded Region name looks like.</span> |
| <span class="source-line-no">102</span><span id="line-102"> */</span> |
| <span class="source-line-no">103</span><span id="line-103"> List<Long> unassigns(List<String> encodedRegionNames, boolean override, boolean force)</span> |
| <span class="source-line-no">104</span><span id="line-104"> throws IOException;</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> default List<Long> unassigns(List<String> encodedRegionNames, boolean override)</span> |
| <span class="source-line-no">107</span><span id="line-107"> throws IOException {</span> |
| <span class="source-line-no">108</span><span id="line-108"> return unassigns(encodedRegionNames, override, true);</span> |
| <span class="source-line-no">109</span><span id="line-109"> }</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> default List<Long> unassigns(List<String> encodedRegionNames) throws IOException {</span> |
| <span class="source-line-no">112</span><span id="line-112"> return unassigns(encodedRegionNames, false, true);</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Bypass specified procedure and move it to completion. Procedure is marked completed but no</span> |
| <span class="source-line-no">117</span><span id="line-117"> * actual work is done from the current state/step onwards. Parents of the procedure are also</span> |
| <span class="source-line-no">118</span><span id="line-118"> * marked for bypass.</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @param pids of procedures to complete.</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @param waitTime wait time in ms for acquiring lock for a procedure</span> |
| <span class="source-line-no">121</span><span id="line-121"> * @param override if override set to true, we will bypass the procedure even if it is executing.</span> |
| <span class="source-line-no">122</span><span id="line-122"> * This is for procedures which can't break out during execution (bugs?).</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @param recursive If set, if a parent procedure, we will find and bypass children and then the</span> |
| <span class="source-line-no">124</span><span id="line-124"> * parent procedure (Dangerous but useful in case where child procedure has been</span> |
| <span class="source-line-no">125</span><span id="line-125"> * 'lost'). Does not always work. Experimental.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * @return true if procedure is marked for bypass successfully, false otherwise</span> |
| <span class="source-line-no">127</span><span id="line-127"> */</span> |
| <span class="source-line-no">128</span><span id="line-128"> List<Boolean> bypassProcedure(List<Long> pids, long waitTime, boolean override, boolean recursive)</span> |
| <span class="source-line-no">129</span><span id="line-129"> throws IOException;</span> |
| <span class="source-line-no">130</span><span id="line-130"></span> |
| <span class="source-line-no">131</span><span id="line-131"> List<Long> scheduleServerCrashProcedures(List<ServerName> serverNames) throws IOException;</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> List<Long> scheduleSCPsForUnknownServers() throws IOException;</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Request HBCK chore to run at master side.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @return <code>true</code> if HBCK chore ran, <code>false</code> if HBCK chore already running</span> |
| <span class="source-line-no">138</span><span id="line-138"> * @throws IOException if a remote or network exception occurs</span> |
| <span class="source-line-no">139</span><span id="line-139"> */</span> |
| <span class="source-line-no">140</span><span id="line-140"> boolean runHbckChore() throws IOException;</span> |
| <span class="source-line-no">141</span><span id="line-141"></span> |
| <span class="source-line-no">142</span><span id="line-142"> /**</span> |
| <span class="source-line-no">143</span><span id="line-143"> * Fix Meta.</span> |
| <span class="source-line-no">144</span><span id="line-144"> */</span> |
| <span class="source-line-no">145</span><span id="line-145"> void fixMeta() throws IOException;</span> |
| <span class="source-line-no">146</span><span id="line-146">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
