| <!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.client;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.Arrays;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Comparator;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Iterator;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Optional;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Set;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.stream.Stream;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.HConstants;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.TableName;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>/**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * TableDescriptor contains the details about an HBase table such as the descriptors of all the<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * column families, is the table a catalog table, <code> hbase:meta </code>, if the table is read<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * only, the maximum size of the memstore, when the region split should occur, coprocessors<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * associated with it etc...<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>@InterfaceAudience.Public<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public interface TableDescriptor {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> @InterfaceAudience.Private<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> Comparator<TableDescriptor> COMPARATOR = getComparator(ColumnFamilyDescriptor.COMPARATOR);<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> @InterfaceAudience.Private<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> Comparator<TableDescriptor> COMPARATOR_IGNORE_REPLICATION =<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> getComparator(ColumnFamilyDescriptor.COMPARATOR_IGNORE_REPLICATION);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> static Comparator<TableDescriptor><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> getComparator(Comparator<ColumnFamilyDescriptor> cfComparator) {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> return (TableDescriptor lhs, TableDescriptor rhs) -> {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> int result = lhs.getTableName().compareTo(rhs.getTableName());<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> if (result != 0) {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> return result;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> Collection<ColumnFamilyDescriptor> lhsFamilies = Arrays.asList(lhs.getColumnFamilies());<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> Collection<ColumnFamilyDescriptor> rhsFamilies = Arrays.asList(rhs.getColumnFamilies());<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> result = Integer.compare(lhsFamilies.size(), rhsFamilies.size());<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> if (result != 0) {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> return result;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> for (Iterator<ColumnFamilyDescriptor> it = lhsFamilies.iterator(),<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> it2 = rhsFamilies.iterator(); it.hasNext();) {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> result = cfComparator.compare(it.next(), it2.next());<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> if (result != 0) {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return result;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> }<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> // punt on comparison for ordering, just calculate difference<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> return Integer.compare(lhs.getValues().hashCode(), rhs.getValues().hashCode());<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><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Returns the count of the column families of the table.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * @return Count of column families of the table<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> int getColumnFamilyCount();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> /**<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * Return the list of attached co-processor represented<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @return The list of CoprocessorDescriptor<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> Collection<CoprocessorDescriptor> getCoprocessorDescriptors();<a name="line.85"></a> |
| <span class="sourceLineNo">086</span><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> /**<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * Returns the durability setting for the table.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @return durability setting for the table.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> Durability getDurability();<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> * Returns an unmodifiable collection of all the {@link ColumnFamilyDescriptor} of all the column<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * families of the table.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @return An array of {@link ColumnFamilyDescriptor} of all the column families.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> */<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> ColumnFamilyDescriptor[] getColumnFamilies();<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> * Returns all the column family names of the current table. The map of TableDescriptor contains<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * mapping of family name to ColumnDescriptor. This returns all the keys of the family map which<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * represents the column family names of the table.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @return Immutable sorted set of the keys of the families.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> Set<byte[]> getColumnFamilyNames();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Returns the ColumnDescriptor for a specific column family with name as specified by the<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * parameter column.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * @param name Column family name<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return Column descriptor for the passed family name or the family on passed in column.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> ColumnFamilyDescriptor getColumnFamily(final byte[] name);<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> * This gets the class associated with the flush policy which determines the stores need to be<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * flushed when flushing a region. The class used by default is defined in<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * org.apache.hadoop.hbase.regionserver.FlushPolicy.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @return the class name of the flush policy for this table. If this returns null, the default<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * flush policy is used.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> String getFlushPolicyClassName();<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /**<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * Returns the maximum size upto which a region can grow to after which a region split is<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * triggered. The region size is represented by the size of the biggest store file in that region.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @return max hregion size for table, -1 if not set.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> */<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> long getMaxFileSize();<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Returns the size of the memstore after which a flush to filesystem is triggered.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return memory cache flush size for each hregion, -1 if not set.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> long getMemStoreFlushSize();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> // TODO: Currently this is used RPC scheduling only. Make it more generic than this; allow it<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> // to also be priority when scheduling procedures that pertain to this table scheduling first<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> // those tables with the highest priority (From Yi Liang over on HBASE-18109).<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> int getPriority();<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /** Returns Returns the configured replicas per region */<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> int getRegionReplication();<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * This gets the class associated with the region split policy which determines when a region<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * split should occur. The class used by default is defined in<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * org.apache.hadoop.hbase.regionserver.RegionSplitPolicy<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @return the class name of the region split policy for this table. If this returns null, the<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * default split policy is used.<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> String getRegionSplitPolicyClassName();<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> /**<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * Get the name of the table<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> TableName getTableName();<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> /**<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * Get the region server group this table belongs to. The regions of this table will be placed<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * only on the region servers within this group. If not present, will be placed on<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * {@link org.apache.hadoop.hbase.rsgroup.RSGroupInfo#DEFAULT_GROUP}.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> */<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> Optional<String> getRegionServerGroup();<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> * Getter for accessing the metadata associated with the key.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @param key The key.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return A clone value. Null if no mapping for the key<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> Bytes getValue(Bytes key);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> /**<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * Getter for accessing the metadata associated with the key.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param key The key.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @return A clone value. Null if no mapping for the key<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> byte[] getValue(byte[] key);<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Getter for accessing the metadata associated with the key.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @param key The key.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @return Null if no mapping for the key<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> */<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> String getValue(String key);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> /** Returns Getter for fetching an unmodifiable map. */<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> Map<Bytes, Bytes> getValues();<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> /**<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * Check if the table has an attached co-processor represented by the name className<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @param classNameToMatch - Class name of the co-processor<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @return true of the table has a co-processor className<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> */<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> boolean hasCoprocessor(String classNameToMatch);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> /**<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * Checks to see if this table contains the given column family<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * @param name Family name or column name.<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @return true if the table contains the specified family name<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> */<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> boolean hasColumnFamily(final byte[] name);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> /** Returns true if the read-replicas memstore replication is enabled. */<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> boolean hasRegionMemStoreReplication();<a name="line.206"></a> |
| <span class="sourceLineNo">207</span><a name="line.207"></a> |
| <span class="sourceLineNo">208</span> /**<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * Check if the compaction enable flag of the table is true. If flag is false then no minor/major<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * compactions will be done in real.<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * @return true if table compaction enabled<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> */<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> boolean isCompactionEnabled();<a name="line.213"></a> |
| <span class="sourceLineNo">214</span><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> /**<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * Check if the split enable flag of the table is true. If flag is false then no region split will<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * be done.<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * @return true if table region split enabled<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> */<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> boolean isSplitEnabled();<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> /**<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * Check if the merge enable flag of the table is true. If flag is false then no region merge will<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * be done.<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @return true if table region merge enabled<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> */<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> boolean isMergeEnabled();<a name="line.227"></a> |
| <span class="sourceLineNo">228</span><a name="line.228"></a> |
| <span class="sourceLineNo">229</span> /**<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> * Checks if this table is <code> hbase:meta </code> region.<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * @return true if this table is <code> hbase:meta </code> region<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> */<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> boolean isMetaRegion();<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> /**<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * Checks if the table is a <code>hbase:meta</code> table<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @return true if table is <code> hbase:meta </code> region.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> */<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> boolean isMetaTable();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> /**<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * Check if normalization enable flag of the table is true. If flag is false then region<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> * normalizer won't attempt to normalize this table.<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * @return true if region normalization is enabled for this table<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> */<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> boolean isNormalizationEnabled();<a name="line.246"></a> |
| <span class="sourceLineNo">247</span><a name="line.247"></a> |
| <span class="sourceLineNo">248</span> /**<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * Check if there is the target region count. If so, the normalize plan will be calculated based<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * on the target region count.<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * @return target region count after normalize done<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> */<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> int getNormalizerTargetRegionCount();<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> /**<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * Check if there is the target region size. If so, the normalize plan will be calculated based on<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * the target region size.<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @return target region size after normalize done<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> */<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> long getNormalizerTargetRegionSize();<a name="line.260"></a> |
| <span class="sourceLineNo">261</span><a name="line.261"></a> |
| <span class="sourceLineNo">262</span> /**<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * Check if the readOnly flag of the table is set. If the readOnly flag is set then the contents<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * of the table can only be read from but not modified.<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * @return true if all columns in the table should be read only<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> */<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> boolean isReadOnly();<a name="line.267"></a> |
| <span class="sourceLineNo">268</span><a name="line.268"></a> |
| <span class="sourceLineNo">269</span> /**<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * The HDFS erasure coding policy for a table. This will be set on the data dir of the table, and<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * is an alternative to normal replication which takes less space at the cost of locality.<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @return the current policy, or null if undefined<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> */<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> default String getErasureCodingPolicy() {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> return null;<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> /**<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * Returns Name of this table and then a map of all of the column family descriptors (with only<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * the non-default column family attributes)<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> */<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> String toStringCustomizedValues();<a name="line.282"></a> |
| <span class="sourceLineNo">283</span><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> /**<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * Check if any of the table's cfs' replication scope are set to<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * {@link HConstants#REPLICATION_SCOPE_GLOBAL}.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @return {@code true} if we have, otherwise {@code false}.<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> */<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> default boolean hasGlobalReplicationScope() {<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> return Stream.of(getColumnFamilies())<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> .anyMatch(cf -> cf.getScope() == HConstants.REPLICATION_SCOPE_GLOBAL);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> }<a name="line.292"></a> |
| <span class="sourceLineNo">293</span><a name="line.293"></a> |
| <span class="sourceLineNo">294</span> /**<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * Check if the table's cfs' replication scope matched with the replication state<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * @param enabled replication state<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * @return true if matched, otherwise false<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> */<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> default boolean matchReplicationScope(boolean enabled) {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> boolean hasEnabled = false;<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> boolean hasDisabled = false;<a name="line.301"></a> |
| <span class="sourceLineNo">302</span><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> for (ColumnFamilyDescriptor cf : getColumnFamilies()) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> if (cf.getScope() != HConstants.REPLICATION_SCOPE_GLOBAL) {<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> hasDisabled = true;<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> } else {<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> hasEnabled = true;<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> }<a name="line.309"></a> |
| <span class="sourceLineNo">310</span><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> if (hasEnabled && hasDisabled) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> return false;<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> if (hasEnabled) {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return enabled;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> return !enabled;<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> }<a name="line.318"></a> |
| <span class="sourceLineNo">319</span>}<a name="line.319"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
