Google Git
Sign in
apache / hbase-site / 2c276d06aa089b93c8b513d57d8ef6b971ea46ba / . / devapidocs / src-html / org / apache / hadoop / hbase / namespace / NamespaceAuditor.html
blob: 2886d08816978477d81f481e7aa7b77c08d39c81 [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.namespace;<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 org.apache.hadoop.hbase.HBaseIOException;<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.TableExistsException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.TableName;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.master.MasterServices;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.quotas.QuotaExceededException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.Logger;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.slf4j.LoggerFactory;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * The Class NamespaceAuditor performs checks to ensure operations like table creation and region<a name="line.33"></a>
<span class="sourceLineNo">034</span> * splitting preserve namespace quota. The namespace quota can be specified while namespace<a name="line.34"></a>
<span class="sourceLineNo">035</span> * creation.<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 NamespaceAuditor {<a name="line.38"></a>
<span class="sourceLineNo">039</span> private static final Logger LOG = LoggerFactory.getLogger(NamespaceAuditor.class);<a name="line.39"></a>
<span class="sourceLineNo">040</span> private NamespaceStateManager stateManager;<a name="line.40"></a>
<span class="sourceLineNo">041</span> private MasterServices masterServices;<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> public NamespaceAuditor(MasterServices masterServices) {<a name="line.43"></a>
<span class="sourceLineNo">044</span> this.masterServices = masterServices;<a name="line.44"></a>
<span class="sourceLineNo">045</span> stateManager = new NamespaceStateManager(masterServices);<a name="line.45"></a>
<span class="sourceLineNo">046</span> }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> public void start() throws IOException {<a name="line.48"></a>
<span class="sourceLineNo">049</span> stateManager.start();<a name="line.49"></a>
<span class="sourceLineNo">050</span> LOG.info("NamespaceAuditor started.");<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<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> * Check quota to create table. We add the table information to namespace state cache, assuming<a name="line.54"></a>
<span class="sourceLineNo">055</span> * the operation will pass. If the operation fails, then the next time namespace state chore runs<a name="line.55"></a>
<span class="sourceLineNo">056</span> * namespace state cache will be corrected.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @param tName - The table name to check quota.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param regions - Number of regions that will be added.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @throws IOException Signals that an I/O exception has occurred.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public void checkQuotaToCreateTable(TableName tName, int regions) throws IOException {<a name="line.61"></a>
<span class="sourceLineNo">062</span> if (stateManager.isInitialized()) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> // We do this check to fail fast.<a name="line.63"></a>
<span class="sourceLineNo">064</span> if (masterServices.getTableDescriptors().exists(tName)) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> throw new TableExistsException(tName);<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> stateManager.checkAndUpdateNamespaceTableCount(tName, regions);<a name="line.67"></a>
<span class="sourceLineNo">068</span> } else {<a name="line.68"></a>
<span class="sourceLineNo">069</span> checkTableTypeAndThrowException(tName);<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<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> * Check and update region count quota for an existing table.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param tName - table name for which region count to be updated.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param regions - Number of regions that will be added.<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @throws IOException Signals that an I/O exception has occurred.<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> public void checkQuotaToUpdateRegion(TableName tName, int regions) throws IOException {<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (stateManager.isInitialized()) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> stateManager.checkAndUpdateNamespaceRegionCount(tName, regions);<a name="line.81"></a>
<span class="sourceLineNo">082</span> } else {<a name="line.82"></a>
<span class="sourceLineNo">083</span> checkTableTypeAndThrowException(tName);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> private void checkTableTypeAndThrowException(TableName name) throws IOException {<a name="line.87"></a>
<span class="sourceLineNo">088</span> if (name.isSystemTable()) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> LOG.debug("Namespace auditor checks not performed for table " + name.getNameAsString());<a name="line.89"></a>
<span class="sourceLineNo">090</span> } else {<a name="line.90"></a>
<span class="sourceLineNo">091</span> throw new HBaseIOException(<a name="line.91"></a>
<span class="sourceLineNo">092</span> name + " is being created even before namespace auditor has been initialized.");<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<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> /**<a name="line.96"></a>
<span class="sourceLineNo">097</span> * Get region count for table<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param tName - table name<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @return cached region count, or -1 if table status not found<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @throws IOException Signals that the namespace auditor has not been initialized<a name="line.100"></a>
<span class="sourceLineNo">101</span> */<a name="line.101"></a>
<span class="sourceLineNo">102</span> public int getRegionCountOfTable(TableName tName) throws IOException {<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (stateManager.isInitialized()) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> NamespaceTableAndRegionInfo state = stateManager.getState(tName.getNamespaceAsString());<a name="line.104"></a>
<span class="sourceLineNo">105</span> return state != null ? state.getRegionCountOfTable(tName) : -1;<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> checkTableTypeAndThrowException(tName);<a name="line.107"></a>
<span class="sourceLineNo">108</span> return -1;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> public void checkQuotaToSplitRegion(RegionInfo hri) throws IOException {<a name="line.111"></a>
<span class="sourceLineNo">112</span> if (!stateManager.isInitialized()) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> throw new IOException(<a name="line.113"></a>
<span class="sourceLineNo">114</span> "Split operation is being performed even before namespace auditor is initialized.");<a name="line.114"></a>
<span class="sourceLineNo">115</span> } else if (<a name="line.115"></a>
<span class="sourceLineNo">116</span> !stateManager.checkAndUpdateNamespaceRegionCount(hri.getTable(), hri.getRegionName(), 1)<a name="line.116"></a>
<span class="sourceLineNo">117</span> ) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> throw new QuotaExceededException("Region split not possible for :" + hri.getEncodedName()<a name="line.118"></a>
<span class="sourceLineNo">119</span> + " as quota limits are exceeded ");<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span> public void updateQuotaForRegionMerge(RegionInfo mergedRegion) throws IOException {<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (!stateManager.isInitialized()) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> throw new IOException(<a name="line.125"></a>
<span class="sourceLineNo">126</span> "Merge operation is being performed even before namespace auditor is initialized.");<a name="line.126"></a>
<span class="sourceLineNo">127</span> } else if (<a name="line.127"></a>
<span class="sourceLineNo">128</span> !stateManager.checkAndUpdateNamespaceRegionCount(mergedRegion.getTable(),<a name="line.128"></a>
<span class="sourceLineNo">129</span> mergedRegion.getRegionName(), -1)<a name="line.129"></a>
<span class="sourceLineNo">130</span> ) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> throw new QuotaExceededException("Region merge not possible for :"<a name="line.131"></a>
<span class="sourceLineNo">132</span> + mergedRegion.getEncodedName() + " as quota limits are exceeded ");<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><a name="line.135"></a>
<span class="sourceLineNo">136</span> public void addNamespace(NamespaceDescriptor ns) throws IOException {<a name="line.136"></a>
<span class="sourceLineNo">137</span> stateManager.addNamespace(ns.getName());<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> public void deleteNamespace(String namespace) throws IOException {<a name="line.140"></a>
<span class="sourceLineNo">141</span> stateManager.deleteNamespace(namespace);<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 void removeFromNamespaceUsage(TableName tableName) throws IOException {<a name="line.144"></a>
<span class="sourceLineNo">145</span> stateManager.removeTable(tableName);<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> public void removeRegionFromNamespaceUsage(RegionInfo hri) throws IOException {<a name="line.148"></a>
<span class="sourceLineNo">149</span> stateManager.removeRegionFromTable(hri);<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> /**<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @param namespace The name of the namespace<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @return An instance of NamespaceTableAndRegionInfo<a name="line.154"></a>
<span class="sourceLineNo">155</span> */<a name="line.155"></a>
<span class="sourceLineNo">156</span> public NamespaceTableAndRegionInfo getState(String namespace) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> if (stateManager.isInitialized()) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> return stateManager.getState(namespace);<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> return null;<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> /**<a name="line.163"></a>
<span class="sourceLineNo">164</span> * Checks if namespace auditor is initialized. Used only for testing.<a name="line.164"></a>
<span class="sourceLineNo">165</span> * @return true, if is initialized<a name="line.165"></a>
<span class="sourceLineNo">166</span> */<a name="line.166"></a>
<span class="sourceLineNo">167</span> public boolean isInitialized() {<a name="line.167"></a>
<span class="sourceLineNo">168</span> return stateManager.isInitialized();<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span>}<a name="line.170"></a>
</pre>
</div>
</body>
</html>