Google Git
Sign in
apache / hbase-site / 6be7f1c569b0f0f64151e4687d98bbf050cb369a / . / devapidocs / src-html / org / apache / hadoop / hbase / master / procedure / ModifyNamespaceProcedure.html
blob: 16e175757f88884316d353434e20be2da53ab405 [file] [log] [blame]
<!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>package org.apache.hadoop.hbase.master.procedure;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Objects;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.NamespaceNotFoundException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.procedure2.ProcedureStateSerializer;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.rsgroup.RSGroupInfo;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.slf4j.LoggerFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyNamespaceState;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * The procedure to add a namespace to an existing table.<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 class ModifyNamespaceProcedure<a name="line.38"></a>
<span class="sourceLineNo">039</span> extends AbstractStateMachineNamespaceProcedure&lt;ModifyNamespaceState&gt; {<a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final Logger LOG = LoggerFactory.getLogger(ModifyNamespaceProcedure.class);<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private NamespaceDescriptor oldNsDescriptor;<a name="line.42"></a>
<span class="sourceLineNo">043</span> private NamespaceDescriptor newNsDescriptor;<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> public ModifyNamespaceProcedure() {<a name="line.45"></a>
<span class="sourceLineNo">046</span> this.oldNsDescriptor = null;<a name="line.46"></a>
<span class="sourceLineNo">047</span> }<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> public ModifyNamespaceProcedure(final MasterProcedureEnv env,<a name="line.49"></a>
<span class="sourceLineNo">050</span> final NamespaceDescriptor newNsDescriptor) {<a name="line.50"></a>
<span class="sourceLineNo">051</span> this(env, newNsDescriptor, null);<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> public ModifyNamespaceProcedure(final MasterProcedureEnv env,<a name="line.54"></a>
<span class="sourceLineNo">055</span> final NamespaceDescriptor newNsDescriptor, final ProcedurePrepareLatch latch) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> super(env, latch);<a name="line.56"></a>
<span class="sourceLineNo">057</span> this.oldNsDescriptor = null;<a name="line.57"></a>
<span class="sourceLineNo">058</span> this.newNsDescriptor = newNsDescriptor;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> @Override<a name="line.61"></a>
<span class="sourceLineNo">062</span> protected Flow executeFromState(final MasterProcedureEnv env, final ModifyNamespaceState state)<a name="line.62"></a>
<span class="sourceLineNo">063</span> throws InterruptedException {<a name="line.63"></a>
<span class="sourceLineNo">064</span> LOG.trace("{} execute state={}", this, state);<a name="line.64"></a>
<span class="sourceLineNo">065</span> try {<a name="line.65"></a>
<span class="sourceLineNo">066</span> switch (state) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> case MODIFY_NAMESPACE_PREPARE:<a name="line.67"></a>
<span class="sourceLineNo">068</span> boolean success = prepareModify(env);<a name="line.68"></a>
<span class="sourceLineNo">069</span> releaseSyncLatch();<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (!success) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> assert isFailed() : "Modify namespace should have an exception here";<a name="line.71"></a>
<span class="sourceLineNo">072</span> return Flow.NO_MORE_STATE;<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span> setNextState(ModifyNamespaceState.MODIFY_NAMESPACE_UPDATE_NS_TABLE);<a name="line.74"></a>
<span class="sourceLineNo">075</span> break;<a name="line.75"></a>
<span class="sourceLineNo">076</span> case MODIFY_NAMESPACE_UPDATE_NS_TABLE:<a name="line.76"></a>
<span class="sourceLineNo">077</span> addOrUpdateNamespace(env, newNsDescriptor);<a name="line.77"></a>
<span class="sourceLineNo">078</span> return Flow.NO_MORE_STATE;<a name="line.78"></a>
<span class="sourceLineNo">079</span> case MODIFY_NAMESPACE_UPDATE_ZK:<a name="line.79"></a>
<span class="sourceLineNo">080</span> // not used any more<a name="line.80"></a>
<span class="sourceLineNo">081</span> return Flow.NO_MORE_STATE;<a name="line.81"></a>
<span class="sourceLineNo">082</span> default:<a name="line.82"></a>
<span class="sourceLineNo">083</span> throw new UnsupportedOperationException(this + " unhandled state=" + state);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> } catch (IOException e) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (isRollbackSupported(state)) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> setFailure("master-modify-namespace", e);<a name="line.87"></a>
<span class="sourceLineNo">088</span> } else {<a name="line.88"></a>
<span class="sourceLineNo">089</span> LOG.warn("Retriable error trying to modify namespace=" + newNsDescriptor.getName()<a name="line.89"></a>
<span class="sourceLineNo">090</span> + " (in state=" + state + ")", e);<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> return Flow.HAS_MORE_STATE;<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span> @Override<a name="line.96"></a>
<span class="sourceLineNo">097</span> protected void rollbackState(final MasterProcedureEnv env, final ModifyNamespaceState state)<a name="line.97"></a>
<span class="sourceLineNo">098</span> throws IOException {<a name="line.98"></a>
<span class="sourceLineNo">099</span> if (state == ModifyNamespaceState.MODIFY_NAMESPACE_PREPARE) {<a name="line.99"></a>
<span class="sourceLineNo">100</span> // nothing to rollback, pre-modify is just checks.<a name="line.100"></a>
<span class="sourceLineNo">101</span> // TODO: coprocessor rollback semantic is still undefined.<a name="line.101"></a>
<span class="sourceLineNo">102</span> releaseSyncLatch();<a name="line.102"></a>
<span class="sourceLineNo">103</span> return;<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> // The procedure doesn't have a rollback. The execution will succeed, at some point.<a name="line.106"></a>
<span class="sourceLineNo">107</span> throw new UnsupportedOperationException("unhandled state=" + state);<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> @Override<a name="line.110"></a>
<span class="sourceLineNo">111</span> protected boolean isRollbackSupported(ModifyNamespaceState state) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> switch (state) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> case MODIFY_NAMESPACE_PREPARE:<a name="line.113"></a>
<span class="sourceLineNo">114</span> return true;<a name="line.114"></a>
<span class="sourceLineNo">115</span> default:<a name="line.115"></a>
<span class="sourceLineNo">116</span> return false;<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span> protected ModifyNamespaceState getState(int stateId) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> return ModifyNamespaceState.forNumber(stateId);<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span> protected int getStateId(ModifyNamespaceState state) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return state.getNumber();<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> @Override<a name="line.130"></a>
<span class="sourceLineNo">131</span> protected ModifyNamespaceState getInitialState() {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return ModifyNamespaceState.MODIFY_NAMESPACE_PREPARE;<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> @Override<a name="line.135"></a>
<span class="sourceLineNo">136</span> protected void serializeStateData(ProcedureStateSerializer serializer) throws IOException {<a name="line.136"></a>
<span class="sourceLineNo">137</span> super.serializeStateData(serializer);<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> MasterProcedureProtos.ModifyNamespaceStateData.Builder modifyNamespaceMsg =<a name="line.139"></a>
<span class="sourceLineNo">140</span> MasterProcedureProtos.ModifyNamespaceStateData.newBuilder()<a name="line.140"></a>
<span class="sourceLineNo">141</span> .setNamespaceDescriptor(ProtobufUtil.toProtoNamespaceDescriptor(this.newNsDescriptor));<a name="line.141"></a>
<span class="sourceLineNo">142</span> if (this.oldNsDescriptor != null) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> modifyNamespaceMsg.setUnmodifiedNamespaceDescriptor(<a name="line.143"></a>
<span class="sourceLineNo">144</span> ProtobufUtil.toProtoNamespaceDescriptor(this.oldNsDescriptor));<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> serializer.serialize(modifyNamespaceMsg.build());<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span> protected void deserializeStateData(ProcedureStateSerializer serializer) throws IOException {<a name="line.150"></a>
<span class="sourceLineNo">151</span> super.deserializeStateData(serializer);<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> MasterProcedureProtos.ModifyNamespaceStateData modifyNamespaceMsg =<a name="line.153"></a>
<span class="sourceLineNo">154</span> serializer.deserialize(MasterProcedureProtos.ModifyNamespaceStateData.class);<a name="line.154"></a>
<span class="sourceLineNo">155</span> newNsDescriptor =<a name="line.155"></a>
<span class="sourceLineNo">156</span> ProtobufUtil.toNamespaceDescriptor(modifyNamespaceMsg.getNamespaceDescriptor());<a name="line.156"></a>
<span class="sourceLineNo">157</span> if (modifyNamespaceMsg.hasUnmodifiedNamespaceDescriptor()) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> oldNsDescriptor =<a name="line.158"></a>
<span class="sourceLineNo">159</span> ProtobufUtil.toNamespaceDescriptor(modifyNamespaceMsg.getUnmodifiedNamespaceDescriptor());<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> @Override<a name="line.163"></a>
<span class="sourceLineNo">164</span> public TableOperationType getTableOperationType() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> return TableOperationType.EDIT;<a name="line.165"></a>
<span class="sourceLineNo">166</span> }<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> @Override<a name="line.168"></a>
<span class="sourceLineNo">169</span> protected String getNamespaceName() {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return newNsDescriptor.getName();<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Action before any real action of adding namespace.<a name="line.174"></a>
<span class="sourceLineNo">175</span> */<a name="line.175"></a>
<span class="sourceLineNo">176</span> private boolean prepareModify(final MasterProcedureEnv env) throws IOException {<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (!getTableNamespaceManager(env).doesNamespaceExist(newNsDescriptor.getName())) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> setFailure("master-modify-namespace",<a name="line.178"></a>
<span class="sourceLineNo">179</span> new NamespaceNotFoundException(newNsDescriptor.getName()));<a name="line.179"></a>
<span class="sourceLineNo">180</span> return false;<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> getTableNamespaceManager(env).validateTableAndRegionCount(newNsDescriptor);<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> // This is used for rollback<a name="line.184"></a>
<span class="sourceLineNo">185</span> oldNsDescriptor = getTableNamespaceManager(env).get(newNsDescriptor.getName());<a name="line.185"></a>
<span class="sourceLineNo">186</span> if (<a name="line.186"></a>
<span class="sourceLineNo">187</span> !Objects.equals(oldNsDescriptor.getConfigurationValue(RSGroupInfo.NAMESPACE_DESC_PROP_GROUP),<a name="line.187"></a>
<span class="sourceLineNo">188</span> newNsDescriptor.getConfigurationValue(RSGroupInfo.NAMESPACE_DESC_PROP_GROUP))<a name="line.188"></a>
<span class="sourceLineNo">189</span> ) {<a name="line.189"></a>
<span class="sourceLineNo">190</span> checkNamespaceRSGroup(env, newNsDescriptor);<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> return true;<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span>}<a name="line.194"></a>
</pre>
</div>
</body>
</html>