http://git-wip-us.apache.org/repos/asf/hbase-site/blob/985cca06/apidocs/org/apache/hadoop/hbase/util/package-summary.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/util/package-summary.html b/apidocs/org/apache/hadoop/hbase/util/package-summary.html index 0e815a3..7f6263c 100644 --- a/apidocs/org/apache/hadoop/hbase/util/package-summary.html +++ b/apidocs/org/apache/hadoop/hbase/util/package-summary.html @@ -176,74 +176,70 @@ </td> </tr> <tr class="altColor"> -<td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/EncryptionTest.html" title="class in org.apache.hadoop.hbase.util">EncryptionTest</a></td> -<td class="colLast"> </td> -</tr> -<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/JsonMapper.html" title="class in org.apache.hadoop.hbase.util">JsonMapper</a></td> <td class="colLast"> <div class="block">Utility class for converting objects to JSON</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/MD5Hash.html" title="class in org.apache.hadoop.hbase.util">MD5Hash</a></td> <td class="colLast"> <div class="block">Utility class for MD5 MD5 hash produces a 128-bit digest.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/OrderedBytes.html" title="class in org.apache.hadoop.hbase.util">OrderedBytes</a></td> <td class="colLast"> <div class="block">Utility class that handles ordered byte arrays.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><T1,T2></td> <td class="colLast"> <div class="block">A generic class for pairs.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/PairOfSameType.html" title="class in org.apache.hadoop.hbase.util">PairOfSameType</a><T></td> <td class="colLast"> <div class="block">A generic, immutable class for pairs of objects both of type <code>T</code>.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/RegionMover.html" title="class in org.apache.hadoop.hbase.util">RegionMover</a></td> <td class="colLast"> <div class="block">Tool for loading/unloading regions to/from given regionserver This tool can be run from Command line directly as a utility.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/SimpleByteRange.html" title="class in org.apache.hadoop.hbase.util">SimpleByteRange</a></td> <td class="colLast"> <div class="block">A read only version of the <a href="../../../../../org/apache/hadoop/hbase/util/ByteRange.html" title="interface in org.apache.hadoop.hbase.util"><code>ByteRange</code></a>.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/SimpleMutableByteRange.html" title="class in org.apache.hadoop.hbase.util">SimpleMutableByteRange</a></td> <td class="colLast"> <div class="block">A basic mutable <a href="../../../../../org/apache/hadoop/hbase/util/ByteRange.html" title="interface in org.apache.hadoop.hbase.util"><code>ByteRange</code></a> implementation.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/SimplePositionedByteRange.html" title="class in org.apache.hadoop.hbase.util">SimplePositionedByteRange</a></td> <td class="colLast"> <div class="block">Extends the basic <a href="../../../../../org/apache/hadoop/hbase/util/SimpleMutableByteRange.html" title="class in org.apache.hadoop.hbase.util"><code>SimpleMutableByteRange</code></a> implementation with position support and it is a readonly version.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/SimplePositionedMutableByteRange.html" title="class in org.apache.hadoop.hbase.util">SimplePositionedMutableByteRange</a></td> <td class="colLast"> <div class="block">Extends the basic <code>AbstractPositionedByteRange</code> implementation with position support and it is a mutable version.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="../../../../../org/apache/hadoop/hbase/util/VersionInfo.html" title="class in org.apache.hadoop.hbase.util">VersionInfo</a></td> <td class="colLast"> <div class="block">This class finds the Version information for HBase.</div>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/985cca06/apidocs/org/apache/hadoop/hbase/util/package-tree.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/util/package-tree.html b/apidocs/org/apache/hadoop/hbase/util/package-tree.html index 426961f..ae73e28 100644 --- a/apidocs/org/apache/hadoop/hbase/util/package-tree.html +++ b/apidocs/org/apache/hadoop/hbase/util/package-tree.html @@ -109,7 +109,6 @@ </li> <li type="circle">org.apache.hadoop.hbase.util.<a href="../../../../../org/apache/hadoop/hbase/util/ConfigurationUtil.html" title="class in org.apache.hadoop.hbase.util"><span class="typeNameLink">ConfigurationUtil</span></a></li> <li type="circle">org.apache.hadoop.hbase.util.<a href="../../../../../org/apache/hadoop/hbase/util/Counter.html" title="class in org.apache.hadoop.hbase.util"><span class="typeNameLink">Counter</span></a></li> -<li type="circle">org.apache.hadoop.hbase.util.<a href="../../../../../org/apache/hadoop/hbase/util/EncryptionTest.html" title="class in org.apache.hadoop.hbase.util"><span class="typeNameLink">EncryptionTest</span></a></li> <li type="circle">java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><span class="typeNameLink">InputStream</span></a> (implements java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html?is-external=true"; title="class or interface in java.io">Closeable</a>) <ul> <li type="circle">java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/FilterInputStream.html?is-external=true"; title="class or interface in java.io"><span class="typeNameLink">FilterInputStream</span></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/985cca06/apidocs/overview-tree.html ---------------------------------------------------------------------- diff --git a/apidocs/overview-tree.html b/apidocs/overview-tree.html index c42554e..33b044c 100644 --- a/apidocs/overview-tree.html +++ b/apidocs/overview-tree.html @@ -231,7 +231,6 @@ <li type="circle">org.apache.hadoop.hbase.client.<a href="org/apache/hadoop/hbase/client/Cursor.html" title="class in org.apache.hadoop.hbase.client"><span class="typeNameLink">Cursor</span></a></li> <li type="circle">org.apache.hadoop.hbase.io.crypto.<a href="org/apache/hadoop/hbase/io/crypto/DefaultCipherProvider.html" title="class in org.apache.hadoop.hbase.io.crypto"><span class="typeNameLink">DefaultCipherProvider</span></a> (implements org.apache.hadoop.hbase.io.crypto.<a href="org/apache/hadoop/hbase/io/crypto/CipherProvider.html" title="interface in org.apache.hadoop.hbase.io.crypto">CipherProvider</a>)</li> <li type="circle">org.apache.hadoop.hbase.io.crypto.<a href="org/apache/hadoop/hbase/io/crypto/Encryption.html" title="class in org.apache.hadoop.hbase.io.crypto"><span class="typeNameLink">Encryption</span></a></li> -<li type="circle">org.apache.hadoop.hbase.util.<a href="org/apache/hadoop/hbase/util/EncryptionTest.html" title="class in org.apache.hadoop.hbase.util"><span class="typeNameLink">EncryptionTest</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.locking.<a href="org/apache/hadoop/hbase/client/locking/EntityLock.html" title="class in org.apache.hadoop.hbase.client.locking"><span class="typeNameLink">EntityLock</span></a></li> <li type="circle">org.apache.hadoop.hbase.client.backoff.<a href="org/apache/hadoop/hbase/client/backoff/ExponentialClientBackoffPolicy.html" title="class in org.apache.hadoop.hbase.client.backoff"><span class="typeNameLink">ExponentialClientBackoffPolicy</span></a> (implements org.apache.hadoop.hbase.client.backoff.<a href="org/apache/hadoop/hbase/client/backoff/ClientBackoffPolicy.html" title="interface in org.apache.hadoop.hbase.client.backoff">ClientBackoffPolicy</a>)</li> <li type="circle">org.apache.hadoop.mapred.FileOutputFormat<K,V> (implements org.apache.hadoop.mapred.OutputFormat<K,V>) @@ -899,6 +898,7 @@ <li type="circle">org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">KeepDeletedCells</span></a></li> <li type="circle">org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">ProcedureState</span></a></li> <li type="circle">org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CellBuilderType.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">CellBuilderType</span></a></li> +<li type="circle">org.apache.hadoop.hbase.<a href="org/apache/hadoop/hbase/CompareOperator.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">CompareOperator</span></a></li> <li type="circle">org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter"><span class="typeNameLink">FilterList.Operator</span></a></li> <li type="circle">org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/CompareFilter.CompareOp.html" title="enum in org.apache.hadoop.hbase.filter"><span class="typeNameLink">CompareFilter.CompareOp</span></a></li> <li type="circle">org.apache.hadoop.hbase.filter.<a href="org/apache/hadoop/hbase/filter/BitComparator.BitwiseOp.html" title="enum in org.apache.hadoop.hbase.filter"><span class="typeNameLink">BitComparator.BitwiseOp</span></a></li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/985cca06/apidocs/src-html/org/apache/hadoop/hbase/CompareOperator.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/CompareOperator.html b/apidocs/src-html/org/apache/hadoop/hbase/CompareOperator.html new file mode 100644 index 0000000..3833c73 --- /dev/null +++ b/apidocs/src-html/org/apache/hadoop/hbase/CompareOperator.html @@ -0,0 +1,116 @@ +<!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;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.20"></a> +<span class="sourceLineNo">021</span><a name="line.21"></a> +<span class="sourceLineNo">022</span>/**<a name="line.22"></a> +<span class="sourceLineNo">023</span> * Generic set of comparison operators.<a name="line.23"></a> +<span class="sourceLineNo">024</span> * @since 2.0.0<a name="line.24"></a> +<span class="sourceLineNo">025</span> */<a name="line.25"></a> +<span class="sourceLineNo">026</span>@InterfaceAudience.Public<a name="line.26"></a> +<span class="sourceLineNo">027</span>public enum CompareOperator {<a name="line.27"></a> +<span class="sourceLineNo">028</span> // Keeps same names as the enums over in filter's CompareOp intentionally.<a name="line.28"></a> +<span class="sourceLineNo">029</span> // The convertion of operator to protobuf representation is via a name comparison.<a name="line.29"></a> +<span class="sourceLineNo">030</span> /** less than */<a name="line.30"></a> +<span class="sourceLineNo">031</span> LESS,<a name="line.31"></a> +<span class="sourceLineNo">032</span> /** less than or equal to */<a name="line.32"></a> +<span class="sourceLineNo">033</span> LESS_OR_EQUAL,<a name="line.33"></a> +<span class="sourceLineNo">034</span> /** equals */<a name="line.34"></a> +<span class="sourceLineNo">035</span> EQUAL,<a name="line.35"></a> +<span class="sourceLineNo">036</span> /** not equal */<a name="line.36"></a> +<span class="sourceLineNo">037</span> NOT_EQUAL,<a name="line.37"></a> +<span class="sourceLineNo">038</span> /** greater than or equal to */<a name="line.38"></a> +<span class="sourceLineNo">039</span> GREATER_OR_EQUAL,<a name="line.39"></a> +<span class="sourceLineNo">040</span> /** greater than */<a name="line.40"></a> +<span class="sourceLineNo">041</span> GREATER,<a name="line.41"></a> +<span class="sourceLineNo">042</span> /** no operation */<a name="line.42"></a> +<span class="sourceLineNo">043</span> NO_OP,<a name="line.43"></a> +<span class="sourceLineNo">044</span>}<a name="line.44"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/985cca06/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html index ecdbfdb..54568ec 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html @@ -29,16 +29,16 @@ <span class="sourceLineNo">021</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.allOf;<a name="line.21"></a> <span class="sourceLineNo">022</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.toCheckExistenceOnly;<a name="line.22"></a> <span class="sourceLineNo">023</span><a name="line.23"></a> -<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import java.util.concurrent.CompletableFuture;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import java.util.concurrent.TimeUnit;<a name="line.28"></a> -<span class="sourceLineNo">029</span><a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.hadoop.conf.Configuration;<a name="line.30"></a> -<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.TableName;<a name="line.31"></a> -<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.32"></a> -<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.filter.CompareFilter.CompareOp;<a name="line.33"></a> +<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.24"></a> +<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.shaded.com.google.common.base.Preconditions;<a name="line.25"></a> +<span class="sourceLineNo">026</span><a name="line.26"></a> +<span class="sourceLineNo">027</span>import java.util.List;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import java.util.concurrent.CompletableFuture;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import java.util.concurrent.TimeUnit;<a name="line.29"></a> +<span class="sourceLineNo">030</span><a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configuration;<a name="line.31"></a> +<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.TableName;<a name="line.32"></a> +<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.classification.InterfaceAudience;<a name="line.33"></a> <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.34"></a> <span class="sourceLineNo">035</span><a name="line.35"></a> <span class="sourceLineNo">036</span>/**<a name="line.36"></a> @@ -212,7 +212,7 @@ <span class="sourceLineNo">204</span> */<a name="line.204"></a> <span class="sourceLineNo">205</span> default CompletableFuture<Boolean> checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.205"></a> <span class="sourceLineNo">206</span> byte[] value, Put put) {<a name="line.206"></a> -<span class="sourceLineNo">207</span> return checkAndPut(row, family, qualifier, CompareOp.EQUAL, value, put);<a name="line.207"></a> +<span class="sourceLineNo">207</span> return checkAndPut(row, family, qualifier, CompareOperator.EQUAL, value, put);<a name="line.207"></a> <span class="sourceLineNo">208</span> }<a name="line.208"></a> <span class="sourceLineNo">209</span><a name="line.209"></a> <span class="sourceLineNo">210</span> /**<a name="line.210"></a> @@ -229,7 +229,7 @@ <span class="sourceLineNo">221</span> * a {@link CompletableFuture}.<a name="line.221"></a> <span class="sourceLineNo">222</span> */<a name="line.222"></a> <span class="sourceLineNo">223</span> CompletableFuture<Boolean> checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.223"></a> -<span class="sourceLineNo">224</span> CompareOp compareOp, byte[] value, Put put);<a name="line.224"></a> +<span class="sourceLineNo">224</span> CompareOperator compareOp, byte[] value, Put put);<a name="line.224"></a> <span class="sourceLineNo">225</span><a name="line.225"></a> <span class="sourceLineNo">226</span> /**<a name="line.226"></a> <span class="sourceLineNo">227</span> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.227"></a> @@ -245,7 +245,7 @@ <span class="sourceLineNo">237</span> */<a name="line.237"></a> <span class="sourceLineNo">238</span> default CompletableFuture<Boolean> checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.238"></a> <span class="sourceLineNo">239</span> byte[] value, Delete delete) {<a name="line.239"></a> -<span class="sourceLineNo">240</span> return checkAndDelete(row, family, qualifier, CompareOp.EQUAL, value, delete);<a name="line.240"></a> +<span class="sourceLineNo">240</span> return checkAndDelete(row, family, qualifier, CompareOperator.EQUAL, value, delete);<a name="line.240"></a> <span class="sourceLineNo">241</span> }<a name="line.241"></a> <span class="sourceLineNo">242</span><a name="line.242"></a> <span class="sourceLineNo">243</span> /**<a name="line.243"></a> @@ -262,7 +262,7 @@ <span class="sourceLineNo">254</span> * by a {@link CompletableFuture}.<a name="line.254"></a> <span class="sourceLineNo">255</span> */<a name="line.255"></a> <span class="sourceLineNo">256</span> CompletableFuture<Boolean> checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.256"></a> -<span class="sourceLineNo">257</span> CompareOp compareOp, byte[] value, Delete delete);<a name="line.257"></a> +<span class="sourceLineNo">257</span> CompareOperator compareOp, byte[] value, Delete delete);<a name="line.257"></a> <span class="sourceLineNo">258</span><a name="line.258"></a> <span class="sourceLineNo">259</span> /**<a name="line.259"></a> <span class="sourceLineNo">260</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.260"></a> @@ -286,7 +286,7 @@ <span class="sourceLineNo">278</span> */<a name="line.278"></a> <span class="sourceLineNo">279</span> default CompletableFuture<Boolean> checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.279"></a> <span class="sourceLineNo">280</span> byte[] value, RowMutations mutation) {<a name="line.280"></a> -<span class="sourceLineNo">281</span> return checkAndMutate(row, family, qualifier, CompareOp.EQUAL, value, mutation);<a name="line.281"></a> +<span class="sourceLineNo">281</span> return checkAndMutate(row, family, qualifier, CompareOperator.EQUAL, value, mutation);<a name="line.281"></a> <span class="sourceLineNo">282</span> }<a name="line.282"></a> <span class="sourceLineNo">283</span><a name="line.283"></a> <span class="sourceLineNo">284</span> /**<a name="line.284"></a> @@ -303,7 +303,7 @@ <span class="sourceLineNo">295</span> * a {@link CompletableFuture}.<a name="line.295"></a> <span class="sourceLineNo">296</span> */<a name="line.296"></a> <span class="sourceLineNo">297</span> CompletableFuture<Boolean> checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.297"></a> -<span class="sourceLineNo">298</span> CompareOp compareOp, byte[] value, RowMutations mutation);<a name="line.298"></a> +<span class="sourceLineNo">298</span> CompareOperator compareOp, byte[] value, RowMutations mutation);<a name="line.298"></a> <span class="sourceLineNo">299</span><a name="line.299"></a> <span class="sourceLineNo">300</span> /**<a name="line.300"></a> <span class="sourceLineNo">301</span> * Return all the results that match the given scan object.<a name="line.301"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/985cca06/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html index 9fde7a7..b013b57 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Query.html @@ -43,209 +43,212 @@ <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.shaded.com.google.common.collect.ListMultimap;<a name="line.35"></a> <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.36"></a> <span class="sourceLineNo">037</span><a name="line.37"></a> -<span class="sourceLineNo">038</span>@InterfaceAudience.Public<a name="line.38"></a> -<span class="sourceLineNo">039</span>public abstract class Query extends OperationWithAttributes {<a name="line.39"></a> -<span class="sourceLineNo">040</span> private static final String ISOLATION_LEVEL = "_isolationlevel_";<a name="line.40"></a> -<span class="sourceLineNo">041</span> protected Filter filter = null;<a name="line.41"></a> -<span class="sourceLineNo">042</span> protected int targetReplicaId = -1;<a name="line.42"></a> -<span class="sourceLineNo">043</span> protected Consistency consistency = Consistency.STRONG;<a name="line.43"></a> -<span class="sourceLineNo">044</span> protected Map<byte[], TimeRange> colFamTimeRangeMap = Maps.newTreeMap(Bytes.BYTES_COMPARATOR);<a name="line.44"></a> -<span class="sourceLineNo">045</span> protected Boolean loadColumnFamiliesOnDemand = null;<a name="line.45"></a> -<span class="sourceLineNo">046</span> /**<a name="line.46"></a> -<span class="sourceLineNo">047</span> * @return Filter<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span> public Filter getFilter() {<a name="line.49"></a> -<span class="sourceLineNo">050</span> return filter;<a name="line.50"></a> -<span class="sourceLineNo">051</span> }<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> * Apply the specified server-side filter when performing the Query. Only<a name="line.54"></a> -<span class="sourceLineNo">055</span> * {@link Filter#filterKeyValue(org.apache.hadoop.hbase.Cell)} is called AFTER all tests for ttl,<a name="line.55"></a> -<span class="sourceLineNo">056</span> * column match, deletes and column family's max versions have been run.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @param filter filter to run on the server<a name="line.57"></a> -<span class="sourceLineNo">058</span> * @return this for invocation chaining<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> public Query setFilter(Filter filter) {<a name="line.60"></a> -<span class="sourceLineNo">061</span> this.filter = filter;<a name="line.61"></a> -<span class="sourceLineNo">062</span> return this;<a name="line.62"></a> -<span class="sourceLineNo">063</span> }<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> * Sets the authorizations to be used by this Query<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @param authorizations<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, ProtobufUtil<a name="line.70"></a> -<span class="sourceLineNo">071</span> .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> /**<a name="line.75"></a> -<span class="sourceLineNo">076</span> * @return The authorizations this Query is associated with.<a name="line.76"></a> -<span class="sourceLineNo">077</span> * @throws DeserializationException<a name="line.77"></a> -<span class="sourceLineNo">078</span> */<a name="line.78"></a> -<span class="sourceLineNo">079</span> public Authorizations getAuthorizations() throws DeserializationException {<a name="line.79"></a> -<span class="sourceLineNo">080</span> byte[] authorizationsBytes = this.getAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY);<a name="line.80"></a> -<span class="sourceLineNo">081</span> if (authorizationsBytes == null) return null;<a name="line.81"></a> -<span class="sourceLineNo">082</span> return ProtobufUtil.toAuthorizations(authorizationsBytes);<a name="line.82"></a> -<span class="sourceLineNo">083</span> }<a name="line.83"></a> -<span class="sourceLineNo">084</span><a name="line.84"></a> -<span class="sourceLineNo">085</span> /**<a name="line.85"></a> -<span class="sourceLineNo">086</span> * @return The serialized ACL for this operation, or null if none<a name="line.86"></a> -<span class="sourceLineNo">087</span> */<a name="line.87"></a> -<span class="sourceLineNo">088</span> public byte[] getACL() {<a name="line.88"></a> -<span class="sourceLineNo">089</span> return getAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL);<a name="line.89"></a> -<span class="sourceLineNo">090</span> }<a name="line.90"></a> -<span class="sourceLineNo">091</span><a name="line.91"></a> -<span class="sourceLineNo">092</span> /**<a name="line.92"></a> -<span class="sourceLineNo">093</span> * @param user User short name<a name="line.93"></a> -<span class="sourceLineNo">094</span> * @param perms Permissions for the user<a name="line.94"></a> -<span class="sourceLineNo">095</span> */<a name="line.95"></a> -<span class="sourceLineNo">096</span> public Query setACL(String user, Permission perms) {<a name="line.96"></a> -<span class="sourceLineNo">097</span> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,<a name="line.97"></a> -<span class="sourceLineNo">098</span> AccessControlUtil.toUsersAndPermissions(user, perms).toByteArray());<a name="line.98"></a> -<span class="sourceLineNo">099</span> return this;<a name="line.99"></a> -<span class="sourceLineNo">100</span> }<a name="line.100"></a> -<span class="sourceLineNo">101</span><a name="line.101"></a> -<span class="sourceLineNo">102</span> /**<a name="line.102"></a> -<span class="sourceLineNo">103</span> * @param perms A map of permissions for a user or users<a name="line.103"></a> -<span class="sourceLineNo">104</span> */<a name="line.104"></a> -<span class="sourceLineNo">105</span> public Query setACL(Map<String, Permission> perms) {<a name="line.105"></a> -<span class="sourceLineNo">106</span> ListMultimap<String, Permission> permMap = ArrayListMultimap.create();<a name="line.106"></a> -<span class="sourceLineNo">107</span> for (Map.Entry<String, Permission> entry : perms.entrySet()) {<a name="line.107"></a> -<span class="sourceLineNo">108</span> permMap.put(entry.getKey(), entry.getValue());<a name="line.108"></a> -<span class="sourceLineNo">109</span> }<a name="line.109"></a> -<span class="sourceLineNo">110</span> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,<a name="line.110"></a> -<span class="sourceLineNo">111</span> AccessControlUtil.toUsersAndPermissions(permMap).toByteArray());<a name="line.111"></a> -<span class="sourceLineNo">112</span> return this;<a name="line.112"></a> -<span class="sourceLineNo">113</span> }<a name="line.113"></a> -<span class="sourceLineNo">114</span><a name="line.114"></a> -<span class="sourceLineNo">115</span> /**<a name="line.115"></a> -<span class="sourceLineNo">116</span> * Returns the consistency level for this operation<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @return the consistency level<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> public Consistency getConsistency() {<a name="line.119"></a> -<span class="sourceLineNo">120</span> return consistency;<a name="line.120"></a> -<span class="sourceLineNo">121</span> }<a name="line.121"></a> -<span class="sourceLineNo">122</span><a name="line.122"></a> -<span class="sourceLineNo">123</span> /**<a name="line.123"></a> -<span class="sourceLineNo">124</span> * Sets the consistency level for this operation<a name="line.124"></a> -<span class="sourceLineNo">125</span> * @param consistency the consistency level<a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> public Query setConsistency(Consistency consistency) {<a name="line.127"></a> -<span class="sourceLineNo">128</span> this.consistency = consistency;<a name="line.128"></a> -<span class="sourceLineNo">129</span> return this;<a name="line.129"></a> -<span class="sourceLineNo">130</span> }<a name="line.130"></a> -<span class="sourceLineNo">131</span><a name="line.131"></a> -<span class="sourceLineNo">132</span> /**<a name="line.132"></a> -<span class="sourceLineNo">133</span> * Specify region replica id where Query will fetch data from. Use this together with<a name="line.133"></a> -<span class="sourceLineNo">134</span> * {@link #setConsistency(Consistency)} passing {@link Consistency#TIMELINE} to read data from<a name="line.134"></a> -<span class="sourceLineNo">135</span> * a specific replicaId.<a name="line.135"></a> -<span class="sourceLineNo">136</span> * <br><b> Expert: </b>This is an advanced API exposed. Only use it if you know what you are doing<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @param Id<a name="line.137"></a> -<span class="sourceLineNo">138</span> */<a name="line.138"></a> -<span class="sourceLineNo">139</span> public Query setReplicaId(int Id) {<a name="line.139"></a> -<span class="sourceLineNo">140</span> this.targetReplicaId = Id;<a name="line.140"></a> -<span class="sourceLineNo">141</span> return this;<a name="line.141"></a> -<span class="sourceLineNo">142</span> }<a name="line.142"></a> -<span class="sourceLineNo">143</span><a name="line.143"></a> -<span class="sourceLineNo">144</span> /**<a name="line.144"></a> -<span class="sourceLineNo">145</span> * Returns region replica id where Query will fetch data from.<a name="line.145"></a> -<span class="sourceLineNo">146</span> * @return region replica id or -1 if not set.<a name="line.146"></a> -<span class="sourceLineNo">147</span> */<a name="line.147"></a> -<span class="sourceLineNo">148</span> public int getReplicaId() {<a name="line.148"></a> -<span class="sourceLineNo">149</span> return this.targetReplicaId;<a name="line.149"></a> -<span class="sourceLineNo">150</span> }<a name="line.150"></a> -<span class="sourceLineNo">151</span><a name="line.151"></a> -<span class="sourceLineNo">152</span> /**<a name="line.152"></a> -<span class="sourceLineNo">153</span> * Set the isolation level for this query. If the<a name="line.153"></a> -<span class="sourceLineNo">154</span> * isolation level is set to READ_UNCOMMITTED, then<a name="line.154"></a> -<span class="sourceLineNo">155</span> * this query will return data from committed and<a name="line.155"></a> -<span class="sourceLineNo">156</span> * uncommitted transactions. If the isolation level<a name="line.156"></a> -<span class="sourceLineNo">157</span> * is set to READ_COMMITTED, then this query will return<a name="line.157"></a> -<span class="sourceLineNo">158</span> * data from committed transactions only. If a isolation<a name="line.158"></a> -<span class="sourceLineNo">159</span> * level is not explicitly set on a Query, then it<a name="line.159"></a> -<span class="sourceLineNo">160</span> * is assumed to be READ_COMMITTED.<a name="line.160"></a> -<span class="sourceLineNo">161</span> * @param level IsolationLevel for this query<a name="line.161"></a> -<span class="sourceLineNo">162</span> */<a name="line.162"></a> -<span class="sourceLineNo">163</span> public Query setIsolationLevel(IsolationLevel level) {<a name="line.163"></a> -<span class="sourceLineNo">164</span> setAttribute(ISOLATION_LEVEL, level.toBytes());<a name="line.164"></a> -<span class="sourceLineNo">165</span> return this;<a name="line.165"></a> -<span class="sourceLineNo">166</span> }<a name="line.166"></a> -<span class="sourceLineNo">167</span><a name="line.167"></a> -<span class="sourceLineNo">168</span> /**<a name="line.168"></a> -<span class="sourceLineNo">169</span> * @return The isolation level of this query.<a name="line.169"></a> -<span class="sourceLineNo">170</span> * If no isolation level was set for this query object,<a name="line.170"></a> -<span class="sourceLineNo">171</span> * then it returns READ_COMMITTED.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * @return The IsolationLevel for this query<a name="line.172"></a> -<span class="sourceLineNo">173</span> */<a name="line.173"></a> -<span class="sourceLineNo">174</span> public IsolationLevel getIsolationLevel() {<a name="line.174"></a> -<span class="sourceLineNo">175</span> byte[] attr = getAttribute(ISOLATION_LEVEL);<a name="line.175"></a> -<span class="sourceLineNo">176</span> return attr == null ? IsolationLevel.READ_COMMITTED :<a name="line.176"></a> -<span class="sourceLineNo">177</span> IsolationLevel.fromBytes(attr);<a name="line.177"></a> -<span class="sourceLineNo">178</span> }<a name="line.178"></a> -<span class="sourceLineNo">179</span><a name="line.179"></a> -<span class="sourceLineNo">180</span> /**<a name="line.180"></a> -<span class="sourceLineNo">181</span> * Set the value indicating whether loading CFs on demand should be allowed (cluster<a name="line.181"></a> -<span class="sourceLineNo">182</span> * default is false). On-demand CF loading doesn't load column families until necessary, e.g.<a name="line.182"></a> -<span class="sourceLineNo">183</span> * if you filter on one column, the other column family data will be loaded only for the rows<a name="line.183"></a> -<span class="sourceLineNo">184</span> * that are included in result, not all rows like in normal case.<a name="line.184"></a> -<span class="sourceLineNo">185</span> * With column-specific filters, like SingleColumnValueFilter w/filterIfMissing == true,<a name="line.185"></a> -<span class="sourceLineNo">186</span> * this can deliver huge perf gains when there's a cf with lots of data; however, it can<a name="line.186"></a> -<span class="sourceLineNo">187</span> * also lead to some inconsistent results, as follows:<a name="line.187"></a> -<span class="sourceLineNo">188</span> * - if someone does a concurrent update to both column families in question you may get a row<a name="line.188"></a> -<span class="sourceLineNo">189</span> * that never existed, e.g. for { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt; "my cat" } }<a name="line.189"></a> -<span class="sourceLineNo">190</span> * someone puts rowKey 5 with { cat_videos =&gt; 0 }, { video =&gt; "my dog" }, concurrent scan<a name="line.190"></a> -<span class="sourceLineNo">191</span> * filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos =&gt; 1 },<a name="line.191"></a> -<span class="sourceLineNo">192</span> * { video =&gt; "my dog" } }.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * - if there's a concurrent split and you have more than 2 column families, some rows may be<a name="line.193"></a> -<span class="sourceLineNo">194</span> * missing some column families.<a name="line.194"></a> -<span class="sourceLineNo">195</span> */<a name="line.195"></a> -<span class="sourceLineNo">196</span> public Query setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.196"></a> -<span class="sourceLineNo">197</span> this.loadColumnFamiliesOnDemand = value;<a name="line.197"></a> -<span class="sourceLineNo">198</span> return this;<a name="line.198"></a> -<span class="sourceLineNo">199</span> }<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> * Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.<a name="line.202"></a> -<span class="sourceLineNo">203</span> */<a name="line.203"></a> -<span class="sourceLineNo">204</span> public Boolean getLoadColumnFamiliesOnDemandValue() {<a name="line.204"></a> -<span class="sourceLineNo">205</span> return this.loadColumnFamiliesOnDemand;<a name="line.205"></a> -<span class="sourceLineNo">206</span> }<a name="line.206"></a> -<span class="sourceLineNo">207</span><a name="line.207"></a> -<span class="sourceLineNo">208</span> /**<a name="line.208"></a> -<span class="sourceLineNo">209</span> * Get the logical value indicating whether on-demand CF loading should be allowed.<a name="line.209"></a> -<span class="sourceLineNo">210</span> */<a name="line.210"></a> -<span class="sourceLineNo">211</span> public boolean doLoadColumnFamiliesOnDemand() {<a name="line.211"></a> -<span class="sourceLineNo">212</span> return (this.loadColumnFamiliesOnDemand != null)<a name="line.212"></a> -<span class="sourceLineNo">213</span> && this.loadColumnFamiliesOnDemand;<a name="line.213"></a> -<span class="sourceLineNo">214</span> }<a name="line.214"></a> -<span class="sourceLineNo">215</span><a name="line.215"></a> -<span class="sourceLineNo">216</span> /**<a name="line.216"></a> -<span class="sourceLineNo">217</span> * Get versions of columns only within the specified timestamp range,<a name="line.217"></a> -<span class="sourceLineNo">218</span> * [minStamp, maxStamp) on a per CF bases. Note, default maximum versions to return is 1. If<a name="line.218"></a> -<span class="sourceLineNo">219</span> * your time range spans more than one version and you want all versions<a name="line.219"></a> -<span class="sourceLineNo">220</span> * returned, up the number of versions beyond the default.<a name="line.220"></a> -<span class="sourceLineNo">221</span> * Column Family time ranges take precedence over the global time range.<a name="line.221"></a> -<span class="sourceLineNo">222</span> *<a name="line.222"></a> -<span class="sourceLineNo">223</span> * @param cf the column family for which you want to restrict<a name="line.223"></a> -<span class="sourceLineNo">224</span> * @param minStamp minimum timestamp value, inclusive<a name="line.224"></a> -<span class="sourceLineNo">225</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.225"></a> -<span class="sourceLineNo">226</span> * @return this<a name="line.226"></a> -<span class="sourceLineNo">227</span> */<a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> public Query setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.229"></a> -<span class="sourceLineNo">230</span> colFamTimeRangeMap.put(cf, new TimeRange(minStamp, maxStamp));<a name="line.230"></a> -<span class="sourceLineNo">231</span> return this;<a name="line.231"></a> -<span class="sourceLineNo">232</span> }<a name="line.232"></a> -<span class="sourceLineNo">233</span><a name="line.233"></a> -<span class="sourceLineNo">234</span> /**<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @return A map of column families to time ranges<a name="line.235"></a> -<span class="sourceLineNo">236</span> */<a name="line.236"></a> -<span class="sourceLineNo">237</span> public Map<byte[], TimeRange> getColumnFamilyTimeRange() {<a name="line.237"></a> -<span class="sourceLineNo">238</span> return this.colFamTimeRangeMap;<a name="line.238"></a> -<span class="sourceLineNo">239</span> }<a name="line.239"></a> -<span class="sourceLineNo">240</span>}<a name="line.240"></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<byte[], TimeRange> 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> * @return Filter<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span> public Filter getFilter() {<a name="line.52"></a> +<span class="sourceLineNo">053</span> return filter;<a name="line.53"></a> +<span class="sourceLineNo">054</span> }<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Apply the specified server-side filter when performing the Query. Only<a name="line.57"></a> +<span class="sourceLineNo">058</span> * {@link Filter#filterKeyValue(org.apache.hadoop.hbase.Cell)} is called AFTER all tests for ttl,<a name="line.58"></a> +<span class="sourceLineNo">059</span> * column match, deletes and column family's max versions have been run.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * @param filter filter to run on the server<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @return this for invocation chaining<a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> public Query setFilter(Filter filter) {<a name="line.63"></a> +<span class="sourceLineNo">064</span> this.filter = filter;<a name="line.64"></a> +<span class="sourceLineNo">065</span> return this;<a name="line.65"></a> +<span class="sourceLineNo">066</span> }<a name="line.66"></a> +<span class="sourceLineNo">067</span><a name="line.67"></a> +<span class="sourceLineNo">068</span> /**<a name="line.68"></a> +<span class="sourceLineNo">069</span> * Sets the authorizations to be used by this Query<a name="line.69"></a> +<span class="sourceLineNo">070</span> * @param authorizations<a name="line.70"></a> +<span class="sourceLineNo">071</span> */<a name="line.71"></a> +<span class="sourceLineNo">072</span> public Query setAuthorizations(Authorizations authorizations) {<a name="line.72"></a> +<span class="sourceLineNo">073</span> this.setAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY, ProtobufUtil<a name="line.73"></a> +<span class="sourceLineNo">074</span> .toAuthorizations(authorizations).toByteArray());<a name="line.74"></a> +<span class="sourceLineNo">075</span> return this;<a name="line.75"></a> +<span class="sourceLineNo">076</span> }<a name="line.76"></a> +<span class="sourceLineNo">077</span><a name="line.77"></a> +<span class="sourceLineNo">078</span> /**<a name="line.78"></a> +<span class="sourceLineNo">079</span> * @return The authorizations this Query is associated with.<a name="line.79"></a> +<span class="sourceLineNo">080</span> * @throws DeserializationException<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> public Authorizations getAuthorizations() throws DeserializationException {<a name="line.82"></a> +<span class="sourceLineNo">083</span> byte[] authorizationsBytes = this.getAttribute(VisibilityConstants.VISIBILITY_LABELS_ATTR_KEY);<a name="line.83"></a> +<span class="sourceLineNo">084</span> if (authorizationsBytes == null) return null;<a name="line.84"></a> +<span class="sourceLineNo">085</span> return ProtobufUtil.toAuthorizations(authorizationsBytes);<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> /**<a name="line.88"></a> +<span class="sourceLineNo">089</span> * @return The serialized ACL for this operation, or null if none<a name="line.89"></a> +<span class="sourceLineNo">090</span> */<a name="line.90"></a> +<span class="sourceLineNo">091</span> public byte[] getACL() {<a name="line.91"></a> +<span class="sourceLineNo">092</span> return getAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL);<a name="line.92"></a> +<span class="sourceLineNo">093</span> }<a name="line.93"></a> +<span class="sourceLineNo">094</span><a name="line.94"></a> +<span class="sourceLineNo">095</span> /**<a name="line.95"></a> +<span class="sourceLineNo">096</span> * @param user User short name<a name="line.96"></a> +<span class="sourceLineNo">097</span> * @param perms Permissions for the user<a name="line.97"></a> +<span class="sourceLineNo">098</span> */<a name="line.98"></a> +<span class="sourceLineNo">099</span> public Query setACL(String user, Permission perms) {<a name="line.99"></a> +<span class="sourceLineNo">100</span> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,<a name="line.100"></a> +<span class="sourceLineNo">101</span> AccessControlUtil.toUsersAndPermissions(user, perms).toByteArray());<a name="line.101"></a> +<span class="sourceLineNo">102</span> return this;<a name="line.102"></a> +<span class="sourceLineNo">103</span> }<a name="line.103"></a> +<span class="sourceLineNo">104</span><a name="line.104"></a> +<span class="sourceLineNo">105</span> /**<a name="line.105"></a> +<span class="sourceLineNo">106</span> * @param perms A map of permissions for a user or users<a name="line.106"></a> +<span class="sourceLineNo">107</span> */<a name="line.107"></a> +<span class="sourceLineNo">108</span> public Query setACL(Map<String, Permission> perms) {<a name="line.108"></a> +<span class="sourceLineNo">109</span> ListMultimap<String, Permission> permMap = ArrayListMultimap.create();<a name="line.109"></a> +<span class="sourceLineNo">110</span> for (Map.Entry<String, Permission> entry : perms.entrySet()) {<a name="line.110"></a> +<span class="sourceLineNo">111</span> permMap.put(entry.getKey(), entry.getValue());<a name="line.111"></a> +<span class="sourceLineNo">112</span> }<a name="line.112"></a> +<span class="sourceLineNo">113</span> setAttribute(AccessControlConstants.OP_ATTRIBUTE_ACL,<a name="line.113"></a> +<span class="sourceLineNo">114</span> AccessControlUtil.toUsersAndPermissions(permMap).toByteArray());<a name="line.114"></a> +<span class="sourceLineNo">115</span> return this;<a name="line.115"></a> +<span class="sourceLineNo">116</span> }<a name="line.116"></a> +<span class="sourceLineNo">117</span><a name="line.117"></a> +<span class="sourceLineNo">118</span> /**<a name="line.118"></a> +<span class="sourceLineNo">119</span> * Returns the consistency level for this operation<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @return the consistency level<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> public Consistency getConsistency() {<a name="line.122"></a> +<span class="sourceLineNo">123</span> return consistency;<a name="line.123"></a> +<span class="sourceLineNo">124</span> }<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> /**<a name="line.126"></a> +<span class="sourceLineNo">127</span> * Sets the consistency level for this operation<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @param consistency the consistency level<a name="line.128"></a> +<span class="sourceLineNo">129</span> */<a name="line.129"></a> +<span class="sourceLineNo">130</span> public Query setConsistency(Consistency consistency) {<a name="line.130"></a> +<span class="sourceLineNo">131</span> this.consistency = consistency;<a name="line.131"></a> +<span class="sourceLineNo">132</span> return this;<a name="line.132"></a> +<span class="sourceLineNo">133</span> }<a name="line.133"></a> +<span class="sourceLineNo">134</span><a name="line.134"></a> +<span class="sourceLineNo">135</span> /**<a name="line.135"></a> +<span class="sourceLineNo">136</span> * Specify region replica id where Query will fetch data from. Use this together with<a name="line.136"></a> +<span class="sourceLineNo">137</span> * {@link #setConsistency(Consistency)} passing {@link Consistency#TIMELINE} to read data from<a name="line.137"></a> +<span class="sourceLineNo">138</span> * a specific replicaId.<a name="line.138"></a> +<span class="sourceLineNo">139</span> * <br><b> Expert: </b>This is an advanced API exposed. Only use it if you know what you are doing<a name="line.139"></a> +<span class="sourceLineNo">140</span> * @param Id<a name="line.140"></a> +<span class="sourceLineNo">141</span> */<a name="line.141"></a> +<span class="sourceLineNo">142</span> public Query setReplicaId(int Id) {<a name="line.142"></a> +<span class="sourceLineNo">143</span> this.targetReplicaId = Id;<a name="line.143"></a> +<span class="sourceLineNo">144</span> return this;<a name="line.144"></a> +<span class="sourceLineNo">145</span> }<a name="line.145"></a> +<span class="sourceLineNo">146</span><a name="line.146"></a> +<span class="sourceLineNo">147</span> /**<a name="line.147"></a> +<span class="sourceLineNo">148</span> * Returns region replica id where Query will fetch data from.<a name="line.148"></a> +<span class="sourceLineNo">149</span> * @return region replica id or -1 if not set.<a name="line.149"></a> +<span class="sourceLineNo">150</span> */<a name="line.150"></a> +<span class="sourceLineNo">151</span> public int getReplicaId() {<a name="line.151"></a> +<span class="sourceLineNo">152</span> return this.targetReplicaId;<a name="line.152"></a> +<span class="sourceLineNo">153</span> }<a name="line.153"></a> +<span class="sourceLineNo">154</span><a name="line.154"></a> +<span class="sourceLineNo">155</span> /**<a name="line.155"></a> +<span class="sourceLineNo">156</span> * Set the isolation level for this query. If the<a name="line.156"></a> +<span class="sourceLineNo">157</span> * isolation level is set to READ_UNCOMMITTED, then<a name="line.157"></a> +<span class="sourceLineNo">158</span> * this query will return data from committed and<a name="line.158"></a> +<span class="sourceLineNo">159</span> * uncommitted transactions. If the isolation level<a name="line.159"></a> +<span class="sourceLineNo">160</span> * is set to READ_COMMITTED, then this query will return<a name="line.160"></a> +<span class="sourceLineNo">161</span> * data from committed transactions only. If a isolation<a name="line.161"></a> +<span class="sourceLineNo">162</span> * level is not explicitly set on a Query, then it<a name="line.162"></a> +<span class="sourceLineNo">163</span> * is assumed to be READ_COMMITTED.<a name="line.163"></a> +<span class="sourceLineNo">164</span> * @param level IsolationLevel for this query<a name="line.164"></a> +<span class="sourceLineNo">165</span> */<a name="line.165"></a> +<span class="sourceLineNo">166</span> public Query setIsolationLevel(IsolationLevel level) {<a name="line.166"></a> +<span class="sourceLineNo">167</span> setAttribute(ISOLATION_LEVEL, level.toBytes());<a name="line.167"></a> +<span class="sourceLineNo">168</span> return this;<a name="line.168"></a> +<span class="sourceLineNo">169</span> }<a name="line.169"></a> +<span class="sourceLineNo">170</span><a name="line.170"></a> +<span class="sourceLineNo">171</span> /**<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @return The isolation level of this query.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * If no isolation level was set for this query object,<a name="line.173"></a> +<span class="sourceLineNo">174</span> * then it returns READ_COMMITTED.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * @return The IsolationLevel for this query<a name="line.175"></a> +<span class="sourceLineNo">176</span> */<a name="line.176"></a> +<span class="sourceLineNo">177</span> public IsolationLevel getIsolationLevel() {<a name="line.177"></a> +<span class="sourceLineNo">178</span> byte[] attr = getAttribute(ISOLATION_LEVEL);<a name="line.178"></a> +<span class="sourceLineNo">179</span> return attr == null ? IsolationLevel.READ_COMMITTED :<a name="line.179"></a> +<span class="sourceLineNo">180</span> IsolationLevel.fromBytes(attr);<a name="line.180"></a> +<span class="sourceLineNo">181</span> }<a name="line.181"></a> +<span class="sourceLineNo">182</span><a name="line.182"></a> +<span class="sourceLineNo">183</span> /**<a name="line.183"></a> +<span class="sourceLineNo">184</span> * Set the value indicating whether loading CFs on demand should be allowed (cluster<a name="line.184"></a> +<span class="sourceLineNo">185</span> * default is false). On-demand CF loading doesn't load column families until necessary, e.g.<a name="line.185"></a> +<span class="sourceLineNo">186</span> * if you filter on one column, the other column family data will be loaded only for the rows<a name="line.186"></a> +<span class="sourceLineNo">187</span> * that are included in result, not all rows like in normal case.<a name="line.187"></a> +<span class="sourceLineNo">188</span> * With column-specific filters, like SingleColumnValueFilter w/filterIfMissing == true,<a name="line.188"></a> +<span class="sourceLineNo">189</span> * this can deliver huge perf gains when there's a cf with lots of data; however, it can<a name="line.189"></a> +<span class="sourceLineNo">190</span> * also lead to some inconsistent results, as follows:<a name="line.190"></a> +<span class="sourceLineNo">191</span> * - if someone does a concurrent update to both column families in question you may get a row<a name="line.191"></a> +<span class="sourceLineNo">192</span> * that never existed, e.g. for { rowKey = 5, { cat_videos =&gt; 1 }, { video =&gt; "my cat" } }<a name="line.192"></a> +<span class="sourceLineNo">193</span> * someone puts rowKey 5 with { cat_videos =&gt; 0 }, { video =&gt; "my dog" }, concurrent scan<a name="line.193"></a> +<span class="sourceLineNo">194</span> * filtering on "cat_videos == 1" can get { rowKey = 5, { cat_videos =&gt; 1 },<a name="line.194"></a> +<span class="sourceLineNo">195</span> * { video =&gt; "my dog" } }.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * - if there's a concurrent split and you have more than 2 column families, some rows may be<a name="line.196"></a> +<span class="sourceLineNo">197</span> * missing some column families.<a name="line.197"></a> +<span class="sourceLineNo">198</span> */<a name="line.198"></a> +<span class="sourceLineNo">199</span> public Query setLoadColumnFamiliesOnDemand(boolean value) {<a name="line.199"></a> +<span class="sourceLineNo">200</span> this.loadColumnFamiliesOnDemand = value;<a name="line.200"></a> +<span class="sourceLineNo">201</span> return this;<a name="line.201"></a> +<span class="sourceLineNo">202</span> }<a name="line.202"></a> +<span class="sourceLineNo">203</span><a name="line.203"></a> +<span class="sourceLineNo">204</span> /**<a name="line.204"></a> +<span class="sourceLineNo">205</span> * Get the raw loadColumnFamiliesOnDemand setting; if it's not set, can be null.<a name="line.205"></a> +<span class="sourceLineNo">206</span> */<a name="line.206"></a> +<span class="sourceLineNo">207</span> public Boolean getLoadColumnFamiliesOnDemandValue() {<a name="line.207"></a> +<span class="sourceLineNo">208</span> return this.loadColumnFamiliesOnDemand;<a name="line.208"></a> +<span class="sourceLineNo">209</span> }<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> * Get the logical value indicating whether on-demand CF loading should be allowed.<a name="line.212"></a> +<span class="sourceLineNo">213</span> */<a name="line.213"></a> +<span class="sourceLineNo">214</span> public boolean doLoadColumnFamiliesOnDemand() {<a name="line.214"></a> +<span class="sourceLineNo">215</span> return (this.loadColumnFamiliesOnDemand != null)<a name="line.215"></a> +<span class="sourceLineNo">216</span> && this.loadColumnFamiliesOnDemand;<a name="line.216"></a> +<span class="sourceLineNo">217</span> }<a name="line.217"></a> +<span class="sourceLineNo">218</span><a name="line.218"></a> +<span class="sourceLineNo">219</span> /**<a name="line.219"></a> +<span class="sourceLineNo">220</span> * Get versions of columns only within the specified timestamp range,<a name="line.220"></a> +<span class="sourceLineNo">221</span> * [minStamp, maxStamp) on a per CF bases. Note, default maximum versions to return is 1. If<a name="line.221"></a> +<span class="sourceLineNo">222</span> * your time range spans more than one version and you want all versions<a name="line.222"></a> +<span class="sourceLineNo">223</span> * returned, up the number of versions beyond the default.<a name="line.223"></a> +<span class="sourceLineNo">224</span> * Column Family time ranges take precedence over the global time range.<a name="line.224"></a> +<span class="sourceLineNo">225</span> *<a name="line.225"></a> +<span class="sourceLineNo">226</span> * @param cf the column family for which you want to restrict<a name="line.226"></a> +<span class="sourceLineNo">227</span> * @param minStamp minimum timestamp value, inclusive<a name="line.227"></a> +<span class="sourceLineNo">228</span> * @param maxStamp maximum timestamp value, exclusive<a name="line.228"></a> +<span class="sourceLineNo">229</span> * @return this<a name="line.229"></a> +<span class="sourceLineNo">230</span> */<a name="line.230"></a> +<span class="sourceLineNo">231</span><a name="line.231"></a> +<span class="sourceLineNo">232</span> public Query setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp) {<a name="line.232"></a> +<span class="sourceLineNo">233</span> colFamTimeRangeMap.put(cf, new TimeRange(minStamp, maxStamp));<a name="line.233"></a> +<span class="sourceLineNo">234</span> return this;<a name="line.234"></a> +<span class="sourceLineNo">235</span> }<a name="line.235"></a> +<span class="sourceLineNo">236</span><a name="line.236"></a> +<span class="sourceLineNo">237</span> /**<a name="line.237"></a> +<span class="sourceLineNo">238</span> * @return A map of column families to time ranges<a name="line.238"></a> +<span class="sourceLineNo">239</span> */<a name="line.239"></a> +<span class="sourceLineNo">240</span> public Map<byte[], TimeRange> getColumnFamilyTimeRange() {<a name="line.240"></a> +<span class="sourceLineNo">241</span> return this.colFamTimeRangeMap;<a name="line.241"></a> +<span class="sourceLineNo">242</span> }<a name="line.242"></a> +<span class="sourceLineNo">243</span>}<a name="line.243"></a>
