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