| <!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, class: Query"> |
| <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.Map;</span> |
| <span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.exceptions.DeserializationException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.filter.Filter;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.io.TimeRange;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.security.access.AccessControlConstants;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.security.access.AccessControlUtil;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.security.access.Permission;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.security.visibility.Authorizations;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.security.visibility.VisibilityConstants;</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">import org.apache.hbase.thirdparty.com.google.common.collect.ArrayListMultimap;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hbase.thirdparty.com.google.common.collect.Maps;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38">/**</span> |
| <span class="source-line-no">039</span><span id="line-39"> * Base class for HBase read operations; e.g. Scan and Get.</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.Public</span> |
| <span class="source-line-no">042</span><span id="line-42">public abstract class Query extends OperationWithAttributes {</span> |
| <span class="source-line-no">043</span><span id="line-43"> private static final String ISOLATION_LEVEL = "_isolationlevel_";</span> |
| <span class="source-line-no">044</span><span id="line-44"> protected Filter filter = null;</span> |
| <span class="source-line-no">045</span><span id="line-45"> protected int targetReplicaId = -1;</span> |
| <span class="source-line-no">046</span><span id="line-46"> protected Consistency consistency = Consistency.STRONG;</span> |
| <span class="source-line-no">047</span><span id="line-47"> protected Map<byte[], TimeRange> colFamTimeRangeMap = Maps.newTreeMap(Bytes.BYTES_COMPARATOR);</span> |
| <span class="source-line-no">048</span><span id="line-48"> protected Boolean loadColumnFamiliesOnDemand = null;</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> public Filter getFilter() {</span> |
| <span class="source-line-no">051</span><span id="line-51"> return filter;</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Apply the specified server-side filter when performing the Query. Only</span> |
| <span class="source-line-no">056</span><span id="line-56"> * {@link Filter#filterCell(org.apache.hadoop.hbase.Cell)} is called AFTER all tests for ttl,</span> |
| <span class="source-line-no">057</span><span id="line-57"> * column match, deletes and column family's max versions have been run.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param filter filter to run on the server</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @return this for invocation chaining</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> public Query setFilter(Filter filter) {</span> |
| <span class="source-line-no">062</span><span id="line-62"> this.filter = filter;</span> |
| <span class="source-line-no">063</span><span id="line-63"> return this;</span> |
| <span class="source-line-no">064</span><span id="line-64"> }</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Sets the authorizations to be used by this Query</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> public Query setAuthorizations(Authorizations authorizations) {</span> |
| <span class="source-line-no">070</span><span id="line-70"> this.setAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY,</span> |
| <span class="source-line-no">071</span><span id="line-71"> ProtobufUtil.toAuthorizations(authorizations).toByteArray());</span> |
| <span class="source-line-no">072</span><span id="line-72"> return this;</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"> /** Returns The authorizations this Query is associated with. n */</span> |
| <span class="source-line-no">076</span><span id="line-76"> public Authorizations getAuthorizations() throws DeserializationException {</span> |
| <span class="source-line-no">077</span><span id="line-77"> byte[] authorizationsBytes = this.getAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY);</span> |
| <span class="source-line-no">078</span><span id="line-78"> if (authorizationsBytes == null) return null;</span> |
| <span class="source-line-no">079</span><span id="line-79"> return ProtobufUtil.toAuthorizations(authorizationsBytes);</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"> /** Returns The serialized ACL for this operation, or null if none */</span> |
| <span class="source-line-no">083</span><span id="line-83"> public byte[] getACL() {</span> |
| <span class="source-line-no">084</span><span id="line-84"> return getAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL);</span> |
| <span class="source-line-no">085</span><span id="line-85"> }</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"> * Set the ACL for the operation.</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param user User short name</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @param perms Permissions for the user</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> public Query setACL(String user, Permission perms) {</span> |
| <span class="source-line-no">093</span><span id="line-93"> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,</span> |
| <span class="source-line-no">094</span><span id="line-94"> AccessControlUtil.toUsersAndPermissions(user, perms).toByteArray());</span> |
| <span class="source-line-no">095</span><span id="line-95"> return this;</span> |
| <span class="source-line-no">096</span><span id="line-96"> }</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> /**</span> |
| <span class="source-line-no">099</span><span id="line-99"> * Set the ACL for the operation.</span> |
| <span class="source-line-no">100</span><span id="line-100"> * @param perms A map of permissions for a user or users</span> |
| <span class="source-line-no">101</span><span id="line-101"> */</span> |
| <span class="source-line-no">102</span><span id="line-102"> public Query setACL(Map<String, Permission> perms) {</span> |
| <span class="source-line-no">103</span><span id="line-103"> ListMultimap<String, Permission> permMap = ArrayListMultimap.create();</span> |
| <span class="source-line-no">104</span><span id="line-104"> for (Map.Entry<String, Permission> entry : perms.entrySet()) {</span> |
| <span class="source-line-no">105</span><span id="line-105"> permMap.put(entry.getKey(), entry.getValue());</span> |
| <span class="source-line-no">106</span><span id="line-106"> }</span> |
| <span class="source-line-no">107</span><span id="line-107"> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,</span> |
| <span class="source-line-no">108</span><span id="line-108"> AccessControlUtil.toUsersAndPermissions(permMap).toByteArray());</span> |
| <span class="source-line-no">109</span><span id="line-109"> return this;</span> |
| <span class="source-line-no">110</span><span id="line-110"> }</span> |
| <span class="source-line-no">111</span><span id="line-111"></span> |
| <span class="source-line-no">112</span><span id="line-112"> /**</span> |
| <span class="source-line-no">113</span><span id="line-113"> * Returns the consistency level for this operation</span> |
| <span class="source-line-no">114</span><span id="line-114"> * @return the consistency level</span> |
| <span class="source-line-no">115</span><span id="line-115"> */</span> |
| <span class="source-line-no">116</span><span id="line-116"> public Consistency getConsistency() {</span> |
| <span class="source-line-no">117</span><span id="line-117"> return consistency;</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</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"> * Sets the consistency level for this operation</span> |
| <span class="source-line-no">122</span><span id="line-122"> * @param consistency the consistency level</span> |
| <span class="source-line-no">123</span><span id="line-123"> */</span> |
| <span class="source-line-no">124</span><span id="line-124"> public Query setConsistency(Consistency consistency) {</span> |
| <span class="source-line-no">125</span><span id="line-125"> this.consistency = consistency;</span> |
| <span class="source-line-no">126</span><span id="line-126"> return this;</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Specify region replica id where Query will fetch data from. Use this together with</span> |
| <span class="source-line-no">131</span><span id="line-131"> * {@link #setConsistency(Consistency)} passing {@link Consistency#TIMELINE} to read data from a</span> |
| <span class="source-line-no">132</span><span id="line-132"> * specific replicaId. <br></span> |
| <span class="source-line-no">133</span><span id="line-133"> * <b> Expert: </b>This is an advanced API exposed. Only use it if you know what you are doing</span> |
| <span class="source-line-no">134</span><span id="line-134"> */</span> |
| <span class="source-line-no">135</span><span id="line-135"> public Query setReplicaId(int Id) {</span> |
| <span class="source-line-no">136</span><span id="line-136"> this.targetReplicaId = Id;</span> |
| <span class="source-line-no">137</span><span id="line-137"> return this;</span> |
| <span class="source-line-no">138</span><span id="line-138"> }</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"> * Returns region replica id where Query will fetch data from.</span> |
| <span class="source-line-no">142</span><span id="line-142"> * @return region replica id or -1 if not set.</span> |
| <span class="source-line-no">143</span><span id="line-143"> */</span> |
| <span class="source-line-no">144</span><span id="line-144"> public int getReplicaId() {</span> |
| <span class="source-line-no">145</span><span id="line-145"> return this.targetReplicaId;</span> |
| <span class="source-line-no">146</span><span id="line-146"> }</span> |
| <span class="source-line-no">147</span><span id="line-147"></span> |
| <span class="source-line-no">148</span><span id="line-148"> /**</span> |
| <span class="source-line-no">149</span><span id="line-149"> * Set the isolation level for this query. If the isolation level is set to READ_UNCOMMITTED, then</span> |
| <span class="source-line-no">150</span><span id="line-150"> * this query will return data from committed and uncommitted transactions. If the isolation level</span> |
| <span class="source-line-no">151</span><span id="line-151"> * is set to READ_COMMITTED, then this query will return data from committed transactions only. If</span> |
| <span class="source-line-no">152</span><span id="line-152"> * a isolation level is not explicitly set on a Query, then it is assumed to be READ_COMMITTED.</span> |
| <span class="source-line-no">153</span><span id="line-153"> * @param level IsolationLevel for this query</span> |
| <span class="source-line-no">154</span><span id="line-154"> */</span> |
| <span class="source-line-no">155</span><span id="line-155"> public Query setIsolationLevel(IsolationLevel level) {</span> |
| <span class="source-line-no">156</span><span id="line-156"> setAttribute(ISOLATION_LEVEL, level.toBytes());</span> |
| <span class="source-line-no">157</span><span id="line-157"> return this;</span> |
| <span class="source-line-no">158</span><span id="line-158"> }</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"> * Returns The isolation level of this query. If no isolation level was set for this query object,</span> |
| <span class="source-line-no">162</span><span id="line-162"> * then it returns READ_COMMITTED.</span> |
| <span class="source-line-no">163</span><span id="line-163"> */</span> |
| <span class="source-line-no">164</span><span id="line-164"> public IsolationLevel getIsolationLevel() {</span> |
| <span class="source-line-no">165</span><span id="line-165"> byte[] attr = getAttribute(ISOLATION_LEVEL);</span> |
| <span class="source-line-no">166</span><span id="line-166"> return attr == null ? IsolationLevel.READ_COMMITTED : IsolationLevel.fromBytes(attr);</span> |
| <span class="source-line-no">167</span><span id="line-167"> }</span> |
| <span class="source-line-no">168</span><span id="line-168"></span> |
| <span class="source-line-no">169</span><span id="line-169"> /**</span> |
| <span class="source-line-no">170</span><span id="line-170"> * Set the value indicating whether loading CFs on demand should be allowed (cluster default is</span> |
| <span class="source-line-no">171</span><span id="line-171"> * false). On-demand CF loading doesn't load column families until necessary, e.g. if you filter</span> |
| <span class="source-line-no">172</span><span id="line-172"> * on one column, the other column family data will be loaded only for the rows that are included</span> |
| <span class="source-line-no">173</span><span id="line-173"> * in result, not all rows like in normal case. With column-specific filters, like</span> |
| <span class="source-line-no">174</span><span id="line-174"> * SingleColumnValueFilter w/filterIfMissing == true, this can deliver huge perf gains when</span> |
| <span class="source-line-no">175</span><span id="line-175"> * there's a cf with lots of data; however, it can also lead to some inconsistent results, as</span> |
| <span class="source-line-no">176</span><span id="line-176"> * follows: - if someone does a concurrent update to both column families in question you may get</span> |
| <span class="source-line-no">177</span><span id="line-177"> * a row that never existed, e.g. for { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt; "my cat"</span> |
| <span class="source-line-no">178</span><span id="line-178"> * } } someone puts rowKey 5 with { cat_videos =&gt; 0 }, { video =&gt; "my dog" }, concurrent</span> |
| <span class="source-line-no">179</span><span id="line-179"> * scan filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt;</span> |
| <span class="source-line-no">180</span><span id="line-180"> * "my dog" } }. - if there's a concurrent split and you have more than 2 column families, some</span> |
| <span class="source-line-no">181</span><span id="line-181"> * rows may be missing some column families.</span> |
| <span class="source-line-no">182</span><span id="line-182"> */</span> |
| <span class="source-line-no">183</span><span id="line-183"> public Query setLoadColumnFamiliesOnDemand(boolean value) {</span> |
| <span class="source-line-no">184</span><span id="line-184"> this.loadColumnFamiliesOnDemand = value;</span> |
| <span class="source-line-no">185</span><span id="line-185"> return this;</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"> /**</span> |
| <span class="source-line-no">189</span><span id="line-189"> * Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.</span> |
| <span class="source-line-no">190</span><span id="line-190"> */</span> |
| <span class="source-line-no">191</span><span id="line-191"> public Boolean getLoadColumnFamiliesOnDemandValue() {</span> |
| <span class="source-line-no">192</span><span id="line-192"> return this.loadColumnFamiliesOnDemand;</span> |
| <span class="source-line-no">193</span><span id="line-193"> }</span> |
| <span class="source-line-no">194</span><span id="line-194"></span> |
| <span class="source-line-no">195</span><span id="line-195"> /**</span> |
| <span class="source-line-no">196</span><span id="line-196"> * Get the logical value indicating whether on-demand CF loading should be allowed.</span> |
| <span class="source-line-no">197</span><span id="line-197"> */</span> |
| <span class="source-line-no">198</span><span id="line-198"> public boolean doLoadColumnFamiliesOnDemand() {</span> |
| <span class="source-line-no">199</span><span id="line-199"> return (this.loadColumnFamiliesOnDemand != null) && this.loadColumnFamiliesOnDemand;</span> |
| <span class="source-line-no">200</span><span id="line-200"> }</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> /**</span> |
| <span class="source-line-no">203</span><span id="line-203"> * Get versions of columns only within the specified timestamp range, [minStamp, maxStamp) on a</span> |
| <span class="source-line-no">204</span><span id="line-204"> * per CF bases. Note, default maximum versions to return is 1. If your time range spans more than</span> |
| <span class="source-line-no">205</span><span id="line-205"> * one version and you want all versions returned, up the number of versions beyond the default.</span> |
| <span class="source-line-no">206</span><span id="line-206"> * Column Family time ranges take precedence over the global time range.</span> |
| <span class="source-line-no">207</span><span id="line-207"> * @param cf the column family for which you want to restrict</span> |
| <span class="source-line-no">208</span><span id="line-208"> * @param minStamp minimum timestamp value, inclusive</span> |
| <span class="source-line-no">209</span><span id="line-209"> * @param maxStamp maximum timestamp value, exclusive</span> |
| <span class="source-line-no">210</span><span id="line-210"> */</span> |
| <span class="source-line-no">211</span><span id="line-211"></span> |
| <span class="source-line-no">212</span><span id="line-212"> public Query setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {</span> |
| <span class="source-line-no">213</span><span id="line-213"> colFamTimeRangeMap.put(cf, TimeRange.between(minStamp, maxStamp));</span> |
| <span class="source-line-no">214</span><span id="line-214"> return this;</span> |
| <span class="source-line-no">215</span><span id="line-215"> }</span> |
| <span class="source-line-no">216</span><span id="line-216"></span> |
| <span class="source-line-no">217</span><span id="line-217"> /** Returns A map of column families to time ranges */</span> |
| <span class="source-line-no">218</span><span id="line-218"> public Map<byte[], TimeRange> getColumnFamilyTimeRange() {</span> |
| <span class="source-line-no">219</span><span id="line-219"> return this.colFamTimeRangeMap;</span> |
| <span class="source-line-no">220</span><span id="line-220"> }</span> |
| <span class="source-line-no">221</span><span id="line-221">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
