Google Git
Sign in
apache / hbase-site / 95b4b340614d5c16fa18e79adcd2f34e8c21257b / . / devapidocs / src-html / org / apache / hadoop / hbase / client / Query.html
blob: 2c8c19209bbab7079ab804440e6035fc438f240b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Map;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.filter.Filter;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.io.TimeRange;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.security.access.AccessControlConstants;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.security.access.AccessControlUtil;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.security.access.Permission;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.security.visibility.Authorizations;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.security.visibility.VisibilityConstants;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.common.collect.ArrayListMultimap;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.com.google.common.collect.ListMultimap;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.hbase.thirdparty.com.google.common.collect.Maps;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>/**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Base class for HBase read operations; e.g. Scan and Get.<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>@InterfaceAudience.Public<a name="line.41"></a>
<span class="sourceLineNo">042</span>public abstract class Query extends OperationWithAttributes {<a name="line.42"></a>
<span class="sourceLineNo">043</span> private static final String ISOLATION_LEVEL = "_isolationlevel_";<a name="line.43"></a>
<span class="sourceLineNo">044</span> protected Filter filter = null;<a name="line.44"></a>
<span class="sourceLineNo">045</span> protected int targetReplicaId = -1;<a name="line.45"></a>
<span class="sourceLineNo">046</span> protected Consistency consistency = Consistency.STRONG;<a name="line.46"></a>
<span class="sourceLineNo">047</span> protected Map&lt;byte[], TimeRange&gt; colFamTimeRangeMap = Maps.newTreeMap(Bytes.BYTES_COMPARATOR);<a name="line.47"></a>
<span class="sourceLineNo">048</span> protected Boolean loadColumnFamiliesOnDemand = null;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span> public Filter getFilter() {<a name="line.50"></a>
<span class="sourceLineNo">051</span> return filter;<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * Apply the specified server-side filter when performing the Query. Only<a name="line.55"></a>
<span class="sourceLineNo">056</span> * {@link Filter#filterCell(org.apache.hadoop.hbase.Cell)} is called AFTER all tests for ttl,<a name="line.56"></a>
<span class="sourceLineNo">057</span> * column match, deletes and column family's max versions have been run.<a name="line.57"></a>
<span class="sourceLineNo">058</span> * @param filter filter to run on the server<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @return this for invocation chaining<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> public Query setFilter(Filter filter) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> this.filter = filter;<a name="line.62"></a>
<span class="sourceLineNo">063</span> return this;<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Sets the authorizations to be used by this Query<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public Query setAuthorizations(Authorizations authorizations) {<a name="line.69"></a>
<span class="sourceLineNo">070</span> this.setAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY,<a name="line.70"></a>
<span class="sourceLineNo">071</span> ProtobufUtil.toAuthorizations(authorizations).toByteArray());<a name="line.71"></a>
<span class="sourceLineNo">072</span> return this;<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> /** Returns The authorizations this Query is associated with. n */<a name="line.75"></a>
<span class="sourceLineNo">076</span> public Authorizations getAuthorizations() throws DeserializationException {<a name="line.76"></a>
<span class="sourceLineNo">077</span> byte[] authorizationsBytes = this.getAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY);<a name="line.77"></a>
<span class="sourceLineNo">078</span> if (authorizationsBytes == null) return null;<a name="line.78"></a>
<span class="sourceLineNo">079</span> return ProtobufUtil.toAuthorizations(authorizationsBytes);<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> /** Returns The serialized ACL for this operation, or null if none */<a name="line.82"></a>
<span class="sourceLineNo">083</span> public byte[] getACL() {<a name="line.83"></a>
<span class="sourceLineNo">084</span> return getAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL);<a name="line.84"></a>
<span class="sourceLineNo">085</span> }<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Set the ACL for the operation.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @param user User short name<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @param perms Permissions for the user<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> public Query setACL(String user, Permission perms) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,<a name="line.93"></a>
<span class="sourceLineNo">094</span> AccessControlUtil.toUsersAndPermissions(user, perms).toByteArray());<a name="line.94"></a>
<span class="sourceLineNo">095</span> return this;<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Set the ACL for the operation.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param perms A map of permissions for a user or users<a name="line.100"></a>
<span class="sourceLineNo">101</span> */<a name="line.101"></a>
<span class="sourceLineNo">102</span> public Query setACL(Map&lt;String, Permission&gt; perms) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> ListMultimap&lt;String, Permission&gt; permMap = ArrayListMultimap.create();<a name="line.103"></a>
<span class="sourceLineNo">104</span> for (Map.Entry&lt;String, Permission&gt; entry : perms.entrySet()) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> permMap.put(entry.getKey(), entry.getValue());<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,<a name="line.107"></a>
<span class="sourceLineNo">108</span> AccessControlUtil.toUsersAndPermissions(permMap).toByteArray());<a name="line.108"></a>
<span class="sourceLineNo">109</span> return this;<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> /**<a name="line.112"></a>
<span class="sourceLineNo">113</span> * Returns the consistency level for this operation<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @return the consistency level<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public Consistency getConsistency() {<a name="line.116"></a>
<span class="sourceLineNo">117</span> return consistency;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
<span class="sourceLineNo">121</span> * Sets the consistency level for this operation<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @param consistency the consistency level<a name="line.122"></a>
<span class="sourceLineNo">123</span> */<a name="line.123"></a>
<span class="sourceLineNo">124</span> public Query setConsistency(Consistency consistency) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> this.consistency = consistency;<a name="line.125"></a>
<span class="sourceLineNo">126</span> return this;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Specify region replica id where Query will fetch data from. Use this together with<a name="line.130"></a>
<span class="sourceLineNo">131</span> * {@link #setConsistency(Consistency)} passing {@link Consistency#TIMELINE} to read data from a<a name="line.131"></a>
<span class="sourceLineNo">132</span> * specific replicaId. &lt;br&gt;<a name="line.132"></a>
<span class="sourceLineNo">133</span> * &lt;b&gt; Expert: &lt;/b&gt;This is an advanced API exposed. Only use it if you know what you are doing<a name="line.133"></a>
<span class="sourceLineNo">134</span> */<a name="line.134"></a>
<span class="sourceLineNo">135</span> public Query setReplicaId(int Id) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> this.targetReplicaId = Id;<a name="line.136"></a>
<span class="sourceLineNo">137</span> return this;<a name="line.137"></a>
<span class="sourceLineNo">138</span> }<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> /**<a name="line.140"></a>
<span class="sourceLineNo">141</span> * Returns region replica id where Query will fetch data from.<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @return region replica id or -1 if not set.<a name="line.142"></a>
<span class="sourceLineNo">143</span> */<a name="line.143"></a>
<span class="sourceLineNo">144</span> public int getReplicaId() {<a name="line.144"></a>
<span class="sourceLineNo">145</span> return this.targetReplicaId;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * Set the isolation level for this query. If the isolation level is set to READ_UNCOMMITTED, then<a name="line.149"></a>
<span class="sourceLineNo">150</span> * this query will return data from committed and uncommitted transactions. If the isolation level<a name="line.150"></a>
<span class="sourceLineNo">151</span> * is set to READ_COMMITTED, then this query will return data from committed transactions only. If<a name="line.151"></a>
<span class="sourceLineNo">152</span> * a isolation level is not explicitly set on a Query, then it is assumed to be READ_COMMITTED.<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @param level IsolationLevel for this query<a name="line.153"></a>
<span class="sourceLineNo">154</span> */<a name="line.154"></a>
<span class="sourceLineNo">155</span> public Query setIsolationLevel(IsolationLevel level) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> setAttribute(ISOLATION_LEVEL, level.toBytes());<a name="line.156"></a>
<span class="sourceLineNo">157</span> return this;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<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> * Returns The isolation level of this query. If no isolation level was set for this query object,<a name="line.161"></a>
<span class="sourceLineNo">162</span> * then it returns READ_COMMITTED.<a name="line.162"></a>
<span class="sourceLineNo">163</span> */<a name="line.163"></a>
<span class="sourceLineNo">164</span> public IsolationLevel getIsolationLevel() {<a name="line.164"></a>
<span class="sourceLineNo">165</span> byte[] attr = getAttribute(ISOLATION_LEVEL);<a name="line.165"></a>
<span class="sourceLineNo">166</span> return attr == null ? IsolationLevel.READ_COMMITTED : IsolationLevel.fromBytes(attr);<a name="line.166"></a>
<span class="sourceLineNo">167</span> }<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
<span class="sourceLineNo">170</span> * Set the value indicating whether loading CFs on demand should be allowed (cluster default is<a name="line.170"></a>
<span class="sourceLineNo">171</span> * false). On-demand CF loading doesn't load column families until necessary, e.g. if you filter<a name="line.171"></a>
<span class="sourceLineNo">172</span> * on one column, the other column family data will be loaded only for the rows that are included<a name="line.172"></a>
<span class="sourceLineNo">173</span> * in result, not all rows like in normal case. With column-specific filters, like<a name="line.173"></a>
<span class="sourceLineNo">174</span> * SingleColumnValueFilter w/filterIfMissing == true, this can deliver huge perf gains when<a name="line.174"></a>
<span class="sourceLineNo">175</span> * there's a cf with lots of data; however, it can also lead to some inconsistent results, as<a name="line.175"></a>
<span class="sourceLineNo">176</span> * follows: - if someone does a concurrent update to both column families in question you may get<a name="line.176"></a>
<span class="sourceLineNo">177</span> * a row that never existed, e.g. for { rowKey = 5, { cat_videos =&amp;gt; 1 }, { video =&amp;gt; "my cat"<a name="line.177"></a>
<span class="sourceLineNo">178</span> * } } someone puts rowKey 5 with { cat_videos =&amp;gt; 0 }, { video =&amp;gt; "my dog" }, concurrent<a name="line.178"></a>
<span class="sourceLineNo">179</span> * scan filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos =&amp;gt; 1 }, { video =&amp;gt;<a name="line.179"></a>
<span class="sourceLineNo">180</span> * "my dog" } }. - if there's a concurrent split and you have more than 2 column families, some<a name="line.180"></a>
<span class="sourceLineNo">181</span> * rows may be missing some column families.<a name="line.181"></a>
<span class="sourceLineNo">182</span> */<a name="line.182"></a>
<span class="sourceLineNo">183</span> public Query setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> this.loadColumnFamiliesOnDemand = value;<a name="line.184"></a>
<span class="sourceLineNo">185</span> return this;<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> /**<a name="line.188"></a>
<span class="sourceLineNo">189</span> * Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.<a name="line.189"></a>
<span class="sourceLineNo">190</span> */<a name="line.190"></a>
<span class="sourceLineNo">191</span> public Boolean getLoadColumnFamiliesOnDemandValue() {<a name="line.191"></a>
<span class="sourceLineNo">192</span> return this.loadColumnFamiliesOnDemand;<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> /**<a name="line.195"></a>
<span class="sourceLineNo">196</span> * Get the logical value indicating whether on-demand CF loading should be allowed.<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> public boolean doLoadColumnFamiliesOnDemand() {<a name="line.198"></a>
<span class="sourceLineNo">199</span> return (this.loadColumnFamiliesOnDemand != null) &amp;&amp; this.loadColumnFamiliesOnDemand;<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * Get versions of columns only within the specified timestamp range, [minStamp, maxStamp) on a<a name="line.203"></a>
<span class="sourceLineNo">204</span> * per CF bases. Note, default maximum versions to return is 1. If your time range spans more than<a name="line.204"></a>
<span class="sourceLineNo">205</span> * one version and you want all versions returned, up the number of versions beyond the default.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * Column Family time ranges take precedence over the global time range.<a name="line.206"></a>
<span class="sourceLineNo">207</span> * @param cf the column family for which you want to restrict<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @param minStamp minimum timestamp value, inclusive<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.209"></a>
<span class="sourceLineNo">210</span> */<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> public Query setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> colFamTimeRangeMap.put(cf, TimeRange.between(minStamp, maxStamp));<a name="line.213"></a>
<span class="sourceLineNo">214</span> return this;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span><a name="line.216"></a>
<span class="sourceLineNo">217</span> /** Returns A map of column families to time ranges */<a name="line.217"></a>
<span class="sourceLineNo">218</span> public Map&lt;byte[], TimeRange&gt; getColumnFamilyTimeRange() {<a name="line.218"></a>
<span class="sourceLineNo">219</span> return this.colFamTimeRangeMap;<a name="line.219"></a>
<span class="sourceLineNo">220</span> }<a name="line.220"></a>
<span class="sourceLineNo">221</span>}<a name="line.221"></a>
</pre>
</div>
</body>
</html>