| <!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: ColumnFamilyDescriptor"> |
| <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.Comparator;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.HashMap;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.KeepDeletedCells;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.MemoryCompactionPolicy;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.io.compress.Compression;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.io.encoding.IndexBlockEncoding;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.regionserver.BloomType;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">/**</span> |
| <span class="source-line-no">033</span><span id="line-33"> * An ColumnFamilyDescriptor contains information about a column family such as the number of</span> |
| <span class="source-line-no">034</span><span id="line-34"> * versions, compression settings, etc. It is used as input when creating a table or adding a</span> |
| <span class="source-line-no">035</span><span id="line-35"> * column. To construct a new instance, use the {@link ColumnFamilyDescriptorBuilder} methods</span> |
| <span class="source-line-no">036</span><span id="line-36"> * @since 2.0.0</span> |
| <span class="source-line-no">037</span><span id="line-37"> */</span> |
| <span class="source-line-no">038</span><span id="line-38">@InterfaceAudience.Public</span> |
| <span class="source-line-no">039</span><span id="line-39">public interface ColumnFamilyDescriptor {</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">042</span><span id="line-42"> static final Comparator<ColumnFamilyDescriptor> COMPARATOR =</span> |
| <span class="source-line-no">043</span><span id="line-43"> (ColumnFamilyDescriptor lhs, ColumnFamilyDescriptor rhs) -> {</span> |
| <span class="source-line-no">044</span><span id="line-44"> int result = Bytes.compareTo(lhs.getName(), rhs.getName());</span> |
| <span class="source-line-no">045</span><span id="line-45"> if (result != 0) {</span> |
| <span class="source-line-no">046</span><span id="line-46"> return result;</span> |
| <span class="source-line-no">047</span><span id="line-47"> }</span> |
| <span class="source-line-no">048</span><span id="line-48"> // punt on comparison for ordering, just calculate difference.</span> |
| <span class="source-line-no">049</span><span id="line-49"> result = lhs.getValues().hashCode() - rhs.getValues().hashCode();</span> |
| <span class="source-line-no">050</span><span id="line-50"> if (result != 0) {</span> |
| <span class="source-line-no">051</span><span id="line-51"> return result;</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"> return lhs.getConfiguration().hashCode() - rhs.getConfiguration().hashCode();</span> |
| <span class="source-line-no">054</span><span id="line-54"> };</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> static final Bytes REPLICATION_SCOPE_BYTES =</span> |
| <span class="source-line-no">057</span><span id="line-57"> new Bytes(Bytes.toBytes(ColumnFamilyDescriptorBuilder.REPLICATION_SCOPE));</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> @InterfaceAudience.Private</span> |
| <span class="source-line-no">060</span><span id="line-60"> static final Comparator<ColumnFamilyDescriptor> COMPARATOR_IGNORE_REPLICATION =</span> |
| <span class="source-line-no">061</span><span id="line-61"> (ColumnFamilyDescriptor lcf, ColumnFamilyDescriptor rcf) -> {</span> |
| <span class="source-line-no">062</span><span id="line-62"> int result = Bytes.compareTo(lcf.getName(), rcf.getName());</span> |
| <span class="source-line-no">063</span><span id="line-63"> if (result != 0) {</span> |
| <span class="source-line-no">064</span><span id="line-64"> return result;</span> |
| <span class="source-line-no">065</span><span id="line-65"> }</span> |
| <span class="source-line-no">066</span><span id="line-66"> // ColumnFamilyDescriptor.getValues is a immutable map, so copy it and remove</span> |
| <span class="source-line-no">067</span><span id="line-67"> // REPLICATION_SCOPE_BYTES</span> |
| <span class="source-line-no">068</span><span id="line-68"> Map<Bytes, Bytes> lValues = new HashMap<>();</span> |
| <span class="source-line-no">069</span><span id="line-69"> lValues.putAll(lcf.getValues());</span> |
| <span class="source-line-no">070</span><span id="line-70"> lValues.remove(REPLICATION_SCOPE_BYTES);</span> |
| <span class="source-line-no">071</span><span id="line-71"> Map<Bytes, Bytes> rValues = new HashMap<>();</span> |
| <span class="source-line-no">072</span><span id="line-72"> rValues.putAll(rcf.getValues());</span> |
| <span class="source-line-no">073</span><span id="line-73"> rValues.remove(REPLICATION_SCOPE_BYTES);</span> |
| <span class="source-line-no">074</span><span id="line-74"> result = lValues.hashCode() - rValues.hashCode();</span> |
| <span class="source-line-no">075</span><span id="line-75"> if (result != 0) {</span> |
| <span class="source-line-no">076</span><span id="line-76"> return result;</span> |
| <span class="source-line-no">077</span><span id="line-77"> }</span> |
| <span class="source-line-no">078</span><span id="line-78"> return lcf.getConfiguration().hashCode() - rcf.getConfiguration().hashCode();</span> |
| <span class="source-line-no">079</span><span id="line-79"> };</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /** Returns The storefile/hfile blocksize for this column family. */</span> |
| <span class="source-line-no">082</span><span id="line-82"> int getBlocksize();</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /** Returns bloom filter type used for new StoreFiles in ColumnFamily */</span> |
| <span class="source-line-no">085</span><span id="line-85"> BloomType getBloomFilterType();</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /** Returns Compression type setting. */</span> |
| <span class="source-line-no">088</span><span id="line-88"> Compression.Algorithm getCompactionCompressionType();</span> |
| <span class="source-line-no">089</span><span id="line-89"></span> |
| <span class="source-line-no">090</span><span id="line-90"> /** Returns Compression type setting for major compactions. */</span> |
| <span class="source-line-no">091</span><span id="line-91"> Compression.Algorithm getMajorCompactionCompressionType();</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /** Returns Compression type setting for minor compactions. */</span> |
| <span class="source-line-no">094</span><span id="line-94"> Compression.Algorithm getMinorCompactionCompressionType();</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /** Returns Compression type setting. */</span> |
| <span class="source-line-no">097</span><span id="line-97"> Compression.Algorithm getCompressionType();</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /** Returns an unmodifiable map. */</span> |
| <span class="source-line-no">100</span><span id="line-100"> Map<String, String> getConfiguration();</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /** Returns accessing the configuration value by key. */</span> |
| <span class="source-line-no">103</span><span id="line-103"> String getConfigurationValue(String key);</span> |
| <span class="source-line-no">104</span><span id="line-104"></span> |
| <span class="source-line-no">105</span><span id="line-105"> /** Returns replication factor set for this CF */</span> |
| <span class="source-line-no">106</span><span id="line-106"> short getDFSReplication();</span> |
| <span class="source-line-no">107</span><span id="line-107"></span> |
| <span class="source-line-no">108</span><span id="line-108"> /** Returns the data block encoding algorithm used in block cache and optionally on disk */</span> |
| <span class="source-line-no">109</span><span id="line-109"> DataBlockEncoding getDataBlockEncoding();</span> |
| <span class="source-line-no">110</span><span id="line-110"></span> |
| <span class="source-line-no">111</span><span id="line-111"> /** Return the index block encoding algorithm used in block cache and optionally on disk */</span> |
| <span class="source-line-no">112</span><span id="line-112"> IndexBlockEncoding getIndexBlockEncoding();</span> |
| <span class="source-line-no">113</span><span id="line-113"></span> |
| <span class="source-line-no">114</span><span id="line-114"> /** Returns Return the raw crypto key attribute for the family, or null if not set */</span> |
| <span class="source-line-no">115</span><span id="line-115"> byte[] getEncryptionKey();</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /** Returns Return the encryption algorithm in use by this family */</span> |
| <span class="source-line-no">118</span><span id="line-118"> String getEncryptionType();</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> /**</span> |
| <span class="source-line-no">121</span><span id="line-121"> * Returns in-memory compaction policy if set for the cf. Returns null if no policy is set for for</span> |
| <span class="source-line-no">122</span><span id="line-122"> * this column family</span> |
| <span class="source-line-no">123</span><span id="line-123"> */</span> |
| <span class="source-line-no">124</span><span id="line-124"> MemoryCompactionPolicy getInMemoryCompaction();</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 return the KeepDeletedCells */</span> |
| <span class="source-line-no">127</span><span id="line-127"> KeepDeletedCells getKeepDeletedCells();</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /** Returns maximum number of versions */</span> |
| <span class="source-line-no">130</span><span id="line-130"> int getMaxVersions();</span> |
| <span class="source-line-no">131</span><span id="line-131"></span> |
| <span class="source-line-no">132</span><span id="line-132"> /** Returns The minimum number of versions to keep. */</span> |
| <span class="source-line-no">133</span><span id="line-133"> int getMinVersions();</span> |
| <span class="source-line-no">134</span><span id="line-134"></span> |
| <span class="source-line-no">135</span><span id="line-135"> /**</span> |
| <span class="source-line-no">136</span><span id="line-136"> * Get the mob compact partition policy for this family</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> MobCompactPartitionPolicy getMobCompactPartitionPolicy();</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> /**</span> |
| <span class="source-line-no">141</span><span id="line-141"> * Gets the mob threshold of the family. If the size of a cell value is larger than this</span> |
| <span class="source-line-no">142</span><span id="line-142"> * threshold, it's regarded as a mob. The default threshold is 1024*100(100K)B.</span> |
| <span class="source-line-no">143</span><span id="line-143"> * @return The mob threshold.</span> |
| <span class="source-line-no">144</span><span id="line-144"> */</span> |
| <span class="source-line-no">145</span><span id="line-145"> long getMobThreshold();</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /** Returns a copy of Name of this column family */</span> |
| <span class="source-line-no">148</span><span id="line-148"> byte[] getName();</span> |
| <span class="source-line-no">149</span><span id="line-149"></span> |
| <span class="source-line-no">150</span><span id="line-150"> /** Returns Name of this column family */</span> |
| <span class="source-line-no">151</span><span id="line-151"> String getNameAsString();</span> |
| <span class="source-line-no">152</span><span id="line-152"></span> |
| <span class="source-line-no">153</span><span id="line-153"> /** Returns the scope tag */</span> |
| <span class="source-line-no">154</span><span id="line-154"> int getScope();</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> /**</span> |
| <span class="source-line-no">157</span><span id="line-157"> * Not using {@code enum} here because HDFS is not using {@code enum} for storage policy, see</span> |
| <span class="source-line-no">158</span><span id="line-158"> * org.apache.hadoop.hdfs.server.blockmanagement.BlockStoragePolicySuite for more details.</span> |
| <span class="source-line-no">159</span><span id="line-159"> * @return Return the storage policy in use by this family</span> |
| <span class="source-line-no">160</span><span id="line-160"> */</span> |
| <span class="source-line-no">161</span><span id="line-161"> String getStoragePolicy();</span> |
| <span class="source-line-no">162</span><span id="line-162"></span> |
| <span class="source-line-no">163</span><span id="line-163"> /** Returns Time-to-live of cell contents, in seconds. */</span> |
| <span class="source-line-no">164</span><span id="line-164"> int getTimeToLive();</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> /**</span> |
| <span class="source-line-no">167</span><span id="line-167"> * Get a configuration value.</span> |
| <span class="source-line-no">168</span><span id="line-168"> * @param key The key.</span> |
| <span class="source-line-no">169</span><span id="line-169"> * @return A clone value. Null if no mapping for the key</span> |
| <span class="source-line-no">170</span><span id="line-170"> */</span> |
| <span class="source-line-no">171</span><span id="line-171"> Bytes getValue(Bytes key);</span> |
| <span class="source-line-no">172</span><span id="line-172"></span> |
| <span class="source-line-no">173</span><span id="line-173"> /**</span> |
| <span class="source-line-no">174</span><span id="line-174"> * Get a configuration value.</span> |
| <span class="source-line-no">175</span><span id="line-175"> * @param key The key.</span> |
| <span class="source-line-no">176</span><span id="line-176"> * @return A clone value. Null if no mapping for the key</span> |
| <span class="source-line-no">177</span><span id="line-177"> */</span> |
| <span class="source-line-no">178</span><span id="line-178"> String getValue(String key);</span> |
| <span class="source-line-no">179</span><span id="line-179"></span> |
| <span class="source-line-no">180</span><span id="line-180"> /**</span> |
| <span class="source-line-no">181</span><span id="line-181"> * Get a configuration value.</span> |
| <span class="source-line-no">182</span><span id="line-182"> * @param key The key.</span> |
| <span class="source-line-no">183</span><span id="line-183"> * @return A clone value. Null if no mapping for the key</span> |
| <span class="source-line-no">184</span><span id="line-184"> */</span> |
| <span class="source-line-no">185</span><span id="line-185"> byte[] getValue(byte[] key);</span> |
| <span class="source-line-no">186</span><span id="line-186"></span> |
| <span class="source-line-no">187</span><span id="line-187"> /**</span> |
| <span class="source-line-no">188</span><span id="line-188"> * Get all configuration values. It clone all bytes of all elements.</span> |
| <span class="source-line-no">189</span><span id="line-189"> * @return All values</span> |
| <span class="source-line-no">190</span><span id="line-190"> */</span> |
| <span class="source-line-no">191</span><span id="line-191"> Map<Bytes, Bytes> getValues();</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> /**</span> |
| <span class="source-line-no">194</span><span id="line-194"> * Returns True if hfile DATA type blocks should be cached (You cannot disable caching of INDEX</span> |
| <span class="source-line-no">195</span><span id="line-195"> * and BLOOM type blocks).</span> |
| <span class="source-line-no">196</span><span id="line-196"> */</span> |
| <span class="source-line-no">197</span><span id="line-197"> boolean isBlockCacheEnabled();</span> |
| <span class="source-line-no">198</span><span id="line-198"></span> |
| <span class="source-line-no">199</span><span id="line-199"> /** Returns true if we should cache bloomfilter blocks on write */</span> |
| <span class="source-line-no">200</span><span id="line-200"> boolean isCacheBloomsOnWrite();</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> /** Returns true if we should cache data blocks on write */</span> |
| <span class="source-line-no">203</span><span id="line-203"> boolean isCacheDataOnWrite();</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 we should cache index blocks on write */</span> |
| <span class="source-line-no">206</span><span id="line-206"> boolean isCacheIndexesOnWrite();</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"> * Returns Whether KV tags should be compressed along with DataBlockEncoding. When no</span> |
| <span class="source-line-no">210</span><span id="line-210"> * DataBlockEncoding is been used, this is having no effect.</span> |
| <span class="source-line-no">211</span><span id="line-211"> */</span> |
| <span class="source-line-no">212</span><span id="line-212"> boolean isCompressTags();</span> |
| <span class="source-line-no">213</span><span id="line-213"></span> |
| <span class="source-line-no">214</span><span id="line-214"> /** Returns true if we should evict cached blocks from the blockcache on close */</span> |
| <span class="source-line-no">215</span><span id="line-215"> boolean isEvictBlocksOnClose();</span> |
| <span class="source-line-no">216</span><span id="line-216"></span> |
| <span class="source-line-no">217</span><span id="line-217"> /**</span> |
| <span class="source-line-no">218</span><span id="line-218"> * Returns True if we are to favor keeping all values for this column family in the HRegionServer</span> |
| <span class="source-line-no">219</span><span id="line-219"> * cache.</span> |
| <span class="source-line-no">220</span><span id="line-220"> */</span> |
| <span class="source-line-no">221</span><span id="line-221"> boolean isInMemory();</span> |
| <span class="source-line-no">222</span><span id="line-222"></span> |
| <span class="source-line-no">223</span><span id="line-223"> /**</span> |
| <span class="source-line-no">224</span><span id="line-224"> * Gets whether the mob is enabled for the family.</span> |
| <span class="source-line-no">225</span><span id="line-225"> * @return True if the mob is enabled for the family.</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 isMobEnabled();</span> |
| <span class="source-line-no">228</span><span id="line-228"></span> |
| <span class="source-line-no">229</span><span id="line-229"> /** Returns true if we should prefetch blocks into the blockcache on open */</span> |
| <span class="source-line-no">230</span><span id="line-230"> boolean isPrefetchBlocksOnOpen();</span> |
| <span class="source-line-no">231</span><span id="line-231"></span> |
| <span class="source-line-no">232</span><span id="line-232"> /** Returns Column family descriptor with only the customized attributes. */</span> |
| <span class="source-line-no">233</span><span id="line-233"> String toStringCustomizedValues();</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"> * By default, HBase only consider timestamp in versions. So a previous Delete with higher ts will</span> |
| <span class="source-line-no">237</span><span id="line-237"> * mask a later Put with lower ts. Set this to true to enable new semantics of versions. We will</span> |
| <span class="source-line-no">238</span><span id="line-238"> * also consider mvcc in versions. See HBASE-15968 for details.</span> |
| <span class="source-line-no">239</span><span id="line-239"> */</span> |
| <span class="source-line-no">240</span><span id="line-240"> boolean isNewVersionBehavior();</span> |
| <span class="source-line-no">241</span><span id="line-241">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
