Google Git
Sign in
apache / hbase-site / 2b6b4d6f00a7a835910d90ac476efb4526b3005d / . / devapidocs / src-html / org / apache / hadoop / hbase / master / TableNamespaceManager.html
blob: 6151de054ae4de6dbf2dbf300071aabd4dc2aa2c [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><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.master;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentMap;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.stream.Collectors;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.commons.lang3.StringUtils;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.Cell;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.DoNotRetryIOException;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HConstants;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.MetaTableAccessor;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.NamespaceDescriptor;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.TableName;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.BufferedMutator;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.Connection;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.Delete;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.Put;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.Result;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.ResultScanner;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Table;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.client.TableDescriptorBuilder;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.client.TableState;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.constraint.ConstraintException;<a name="line.44"></a>
<span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.master.procedure.DisableTableProcedure;<a name="line.45"></a>
<span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.46"></a>
<span class="sourceLineNo">047</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span>import org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream;<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.51"></a>
<span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span>/**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * This is a helper class used internally to manage the namespace metadata that is stored in the ns<a name="line.55"></a>
<span class="sourceLineNo">056</span> * family in meta table.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span>@InterfaceAudience.Private<a name="line.58"></a>
<span class="sourceLineNo">059</span>public class TableNamespaceManager {<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> public static final String KEY_MAX_REGIONS = "hbase.namespace.quota.maxregions";<a name="line.61"></a>
<span class="sourceLineNo">062</span> public static final String KEY_MAX_TABLES = "hbase.namespace.quota.maxtables";<a name="line.62"></a>
<span class="sourceLineNo">063</span> static final String NS_INIT_TIMEOUT = "hbase.master.namespace.init.timeout";<a name="line.63"></a>
<span class="sourceLineNo">064</span> static final int DEFAULT_NS_INIT_TIMEOUT = 300000;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> private final ConcurrentMap&lt;String, NamespaceDescriptor&gt; cache = new ConcurrentHashMap&lt;&gt;();<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> private final MasterServices masterServices;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> TableNamespaceManager(MasterServices masterServices) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> this.masterServices = masterServices;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> private void migrateNamespaceTable() throws IOException {<a name="line.74"></a>
<span class="sourceLineNo">075</span> try (Table nsTable = masterServices.getConnection().getTable(TableName.NAMESPACE_TABLE_NAME);<a name="line.75"></a>
<span class="sourceLineNo">076</span> ResultScanner scanner = nsTable.getScanner(<a name="line.76"></a>
<span class="sourceLineNo">077</span> new Scan().addFamily(TableDescriptorBuilder.NAMESPACE_FAMILY_INFO_BYTES).readAllVersions());<a name="line.77"></a>
<span class="sourceLineNo">078</span> BufferedMutator mutator =<a name="line.78"></a>
<span class="sourceLineNo">079</span> masterServices.getConnection().getBufferedMutator(TableName.META_TABLE_NAME)) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> for (Result result;;) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> result = scanner.next();<a name="line.81"></a>
<span class="sourceLineNo">082</span> if (result == null) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> break;<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> Put put = new Put(result.getRow());<a name="line.85"></a>
<span class="sourceLineNo">086</span> result<a name="line.86"></a>
<span class="sourceLineNo">087</span> .getColumnCells(TableDescriptorBuilder.NAMESPACE_FAMILY_INFO_BYTES,<a name="line.87"></a>
<span class="sourceLineNo">088</span> TableDescriptorBuilder.NAMESPACE_COL_DESC_BYTES)<a name="line.88"></a>
<span class="sourceLineNo">089</span> .forEach(c -&gt; put.addColumn(HConstants.NAMESPACE_FAMILY,<a name="line.89"></a>
<span class="sourceLineNo">090</span> HConstants.NAMESPACE_COL_DESC_QUALIFIER, c.getTimestamp(), CellUtil.cloneValue(c)));<a name="line.90"></a>
<span class="sourceLineNo">091</span> mutator.mutate(put);<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> // schedule a disable procedure instead of block waiting here, as when disabling a table we will<a name="line.94"></a>
<span class="sourceLineNo">095</span> // wait until master is initialized, but we are part of the initialization...<a name="line.95"></a>
<span class="sourceLineNo">096</span> masterServices.getMasterProcedureExecutor().submitProcedure(<a name="line.96"></a>
<span class="sourceLineNo">097</span> new DisableTableProcedure(masterServices.getMasterProcedureExecutor().getEnvironment(),<a name="line.97"></a>
<span class="sourceLineNo">098</span> TableName.NAMESPACE_TABLE_NAME, false));<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> private void loadNamespaceIntoCache() throws IOException {<a name="line.101"></a>
<span class="sourceLineNo">102</span> try (Table table = masterServices.getConnection().getTable(TableName.META_TABLE_NAME);<a name="line.102"></a>
<span class="sourceLineNo">103</span> ResultScanner scanner = table.getScanner(HConstants.NAMESPACE_FAMILY)) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> for (Result result;;) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> result = scanner.next();<a name="line.105"></a>
<span class="sourceLineNo">106</span> if (result == null) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> break;<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span> Cell cell = result.getColumnLatestCell(HConstants.NAMESPACE_FAMILY,<a name="line.109"></a>
<span class="sourceLineNo">110</span> HConstants.NAMESPACE_COL_DESC_QUALIFIER);<a name="line.110"></a>
<span class="sourceLineNo">111</span> NamespaceDescriptor ns = ProtobufUtil<a name="line.111"></a>
<span class="sourceLineNo">112</span> .toNamespaceDescriptor(HBaseProtos.NamespaceDescriptor.parseFrom(CodedInputStream<a name="line.112"></a>
<span class="sourceLineNo">113</span> .newInstance(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength())));<a name="line.113"></a>
<span class="sourceLineNo">114</span> cache.put(ns.getName(), ns);<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> }<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> public void start() throws IOException {<a name="line.119"></a>
<span class="sourceLineNo">120</span> TableState nsTableState = MetaTableAccessor.getTableState(masterServices.getConnection(),<a name="line.120"></a>
<span class="sourceLineNo">121</span> TableName.NAMESPACE_TABLE_NAME);<a name="line.121"></a>
<span class="sourceLineNo">122</span> if (nsTableState != null &amp;&amp; nsTableState.isEnabled()) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> migrateNamespaceTable();<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> loadNamespaceIntoCache();<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
<span class="sourceLineNo">129</span> * check whether a namespace has already existed.<a name="line.129"></a>
<span class="sourceLineNo">130</span> */<a name="line.130"></a>
<span class="sourceLineNo">131</span> public boolean doesNamespaceExist(String namespaceName) throws IOException {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return cache.containsKey(namespaceName);<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> public NamespaceDescriptor get(String name) throws IOException {<a name="line.135"></a>
<span class="sourceLineNo">136</span> return cache.get(name);<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> public void addOrUpdateNamespace(NamespaceDescriptor ns) throws IOException {<a name="line.139"></a>
<span class="sourceLineNo">140</span> insertNamespaceToMeta(masterServices.getConnection(), ns);<a name="line.140"></a>
<span class="sourceLineNo">141</span> cache.put(ns.getName(), ns);<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> public static void insertNamespaceToMeta(Connection conn, NamespaceDescriptor ns)<a name="line.144"></a>
<span class="sourceLineNo">145</span> throws IOException {<a name="line.145"></a>
<span class="sourceLineNo">146</span> byte[] row = Bytes.toBytes(ns.getName());<a name="line.146"></a>
<span class="sourceLineNo">147</span> Put put = new Put(row, true).addColumn(HConstants.NAMESPACE_FAMILY,<a name="line.147"></a>
<span class="sourceLineNo">148</span> HConstants.NAMESPACE_COL_DESC_QUALIFIER,<a name="line.148"></a>
<span class="sourceLineNo">149</span> ProtobufUtil.toProtoNamespaceDescriptor(ns).toByteArray());<a name="line.149"></a>
<span class="sourceLineNo">150</span> try (Table table = conn.getTable(TableName.META_TABLE_NAME)) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> table.put(put);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> public void deleteNamespace(String namespaceName) throws IOException {<a name="line.155"></a>
<span class="sourceLineNo">156</span> Delete d = new Delete(Bytes.toBytes(namespaceName));<a name="line.156"></a>
<span class="sourceLineNo">157</span> try (Table table = masterServices.getConnection().getTable(TableName.META_TABLE_NAME)) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> table.delete(d);<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> cache.remove(namespaceName);<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> public List&lt;NamespaceDescriptor&gt; list() throws IOException {<a name="line.163"></a>
<span class="sourceLineNo">164</span> return cache.values().stream().collect(Collectors.toList());<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> public void validateTableAndRegionCount(NamespaceDescriptor desc) throws IOException {<a name="line.167"></a>
<span class="sourceLineNo">168</span> if (getMaxRegions(desc) &lt;= 0) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> throw new ConstraintException(<a name="line.169"></a>
<span class="sourceLineNo">170</span> "The max region quota for " + desc.getName() + " is less than or equal to zero.");<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> if (getMaxTables(desc) &lt;= 0) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> throw new ConstraintException(<a name="line.173"></a>
<span class="sourceLineNo">174</span> "The max tables quota for " + desc.getName() + " is less than or equal to zero.");<a name="line.174"></a>
<span class="sourceLineNo">175</span> }<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> public static long getMaxTables(NamespaceDescriptor ns) throws IOException {<a name="line.178"></a>
<span class="sourceLineNo">179</span> String value = ns.getConfigurationValue(KEY_MAX_TABLES);<a name="line.179"></a>
<span class="sourceLineNo">180</span> long maxTables = 0;<a name="line.180"></a>
<span class="sourceLineNo">181</span> if (StringUtils.isNotEmpty(value)) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> try {<a name="line.182"></a>
<span class="sourceLineNo">183</span> maxTables = Long.parseLong(value);<a name="line.183"></a>
<span class="sourceLineNo">184</span> } catch (NumberFormatException exp) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> throw new DoNotRetryIOException("NumberFormatException while getting max tables.", exp);<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span> } else {<a name="line.187"></a>
<span class="sourceLineNo">188</span> // The property is not set, so assume its the max long value.<a name="line.188"></a>
<span class="sourceLineNo">189</span> maxTables = Long.MAX_VALUE;<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span> return maxTables;<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> public static long getMaxRegions(NamespaceDescriptor ns) throws IOException {<a name="line.194"></a>
<span class="sourceLineNo">195</span> String value = ns.getConfigurationValue(KEY_MAX_REGIONS);<a name="line.195"></a>
<span class="sourceLineNo">196</span> long maxRegions = 0;<a name="line.196"></a>
<span class="sourceLineNo">197</span> if (StringUtils.isNotEmpty(value)) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> try {<a name="line.198"></a>
<span class="sourceLineNo">199</span> maxRegions = Long.parseLong(value);<a name="line.199"></a>
<span class="sourceLineNo">200</span> } catch (NumberFormatException exp) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> throw new DoNotRetryIOException("NumberFormatException while getting max regions.", exp);<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> } else {<a name="line.203"></a>
<span class="sourceLineNo">204</span> // The property is not set, so assume its the max long value.<a name="line.204"></a>
<span class="sourceLineNo">205</span> maxRegions = Long.MAX_VALUE;<a name="line.205"></a>
<span class="sourceLineNo">206</span> }<a name="line.206"></a>
<span class="sourceLineNo">207</span> return maxRegions;<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span>}<a name="line.209"></a>
</pre>
</div>
</body>
</html>