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