Google Git
Sign in
apache / hbase-site / 82b7d6fa699c68d5902b74920e555d6ae22bcc01 / . / devapidocs / src-html / org / apache / hadoop / hbase / client / Append.html
blob: 8da84bc3ff1385c48382a342e9d91a7768e12664 [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.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.NavigableMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.UUID;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CellBuilder;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.CellBuilderType;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.KeyValue;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.io.TimeRange;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.security.access.Permission;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.security.visibility.CellVisibility;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.util.ClassSize;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.slf4j.Logger;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.slf4j.LoggerFactory;<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> * Performs Append operations on a single row.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * This operation ensures atomicty to readers. Appends are done under a single row lock, so write<a name="line.41"></a>
<span class="sourceLineNo">042</span> * operations to a row are synchronized, and readers are guaranteed to see this operation fully<a name="line.42"></a>
<span class="sourceLineNo">043</span> * completed.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * To append to a set of columns of a row, instantiate an Append object with the row to append to.<a name="line.45"></a>
<span class="sourceLineNo">046</span> * At least one column to append must be specified using the<a name="line.46"></a>
<span class="sourceLineNo">047</span> * {@link #addColumn(byte[], byte[], byte[])} method.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>@InterfaceAudience.Public<a name="line.49"></a>
<span class="sourceLineNo">050</span>public class Append extends Mutation {<a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final Logger LOG = LoggerFactory.getLogger(Append.class);<a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final long HEAP_OVERHEAD = (long) ClassSize.REFERENCE + ClassSize.TIMERANGE;<a name="line.52"></a>
<span class="sourceLineNo">053</span> private TimeRange tr = TimeRange.allTime();<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> * Sets the TimeRange to be used on the Get for this append.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * This is useful for when you have counters that only last for specific periods of time (ie.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * counters that are partitioned by time). By setting the range of valid times for this append,<a name="line.59"></a>
<span class="sourceLineNo">060</span> * you can potentially gain some performance with a more optimal Get operation. Be careful adding<a name="line.60"></a>
<span class="sourceLineNo">061</span> * the time range to this class as you will update the old cell if the time range doesn't include<a name="line.61"></a>
<span class="sourceLineNo">062</span> * the latest cells.<a name="line.62"></a>
<span class="sourceLineNo">063</span> * &lt;p&gt;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * This range is used as [minStamp, maxStamp).<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @param minStamp minimum timestamp value, inclusive<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param maxStamp maximum timestamp value, exclusive n<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> public Append setTimeRange(long minStamp, long maxStamp) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> tr = TimeRange.between(minStamp, maxStamp);<a name="line.69"></a>
<span class="sourceLineNo">070</span> return this;<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Gets the TimeRange used for this append. n<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> public TimeRange getTimeRange() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return this.tr;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span> @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span> protected long extraHeapSize() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return HEAP_OVERHEAD;<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> * n * True (default) if the append operation should return the results. A client that is not<a name="line.86"></a>
<span class="sourceLineNo">087</span> * interested in the result can save network bandwidth setting this to false.<a name="line.87"></a>
<span class="sourceLineNo">088</span> */<a name="line.88"></a>
<span class="sourceLineNo">089</span> @Override<a name="line.89"></a>
<span class="sourceLineNo">090</span> public Append setReturnResults(boolean returnResults) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> super.setReturnResults(returnResults);<a name="line.91"></a>
<span class="sourceLineNo">092</span> return this;<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> /** Returns current setting for returnResults */<a name="line.95"></a>
<span class="sourceLineNo">096</span> // This method makes public the superclasses's protected method.<a name="line.96"></a>
<span class="sourceLineNo">097</span> @Override<a name="line.97"></a>
<span class="sourceLineNo">098</span> public boolean isReturnResults() {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return super.isReturnResults();<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> * Create a Append operation for the specified row.<a name="line.103"></a>
<span class="sourceLineNo">104</span> * &lt;p&gt;<a name="line.104"></a>
<span class="sourceLineNo">105</span> * At least one column must be appended to.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param row row key; makes a local copy of passed in array.<a name="line.106"></a>
<span class="sourceLineNo">107</span> */<a name="line.107"></a>
<span class="sourceLineNo">108</span> public Append(byte[] row) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> this(row, 0, row.length);<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> * Copy constructor<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @param appendToCopy append to copy<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public Append(Append appendToCopy) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> super(appendToCopy);<a name="line.117"></a>
<span class="sourceLineNo">118</span> this.tr = appendToCopy.getTimeRange();<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> /**<a name="line.121"></a>
<span class="sourceLineNo">122</span> * Create a Append operation for the specified row.<a name="line.122"></a>
<span class="sourceLineNo">123</span> * &lt;p&gt;<a name="line.123"></a>
<span class="sourceLineNo">124</span> * At least one column must be appended to.<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @param rowArray Makes a copy out of this buffer. nn<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> public Append(final byte[] rowArray, final int rowOffset, final int rowLength) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> checkRow(rowArray, rowOffset, rowLength);<a name="line.128"></a>
<span class="sourceLineNo">129</span> this.row = Bytes.copy(rowArray, rowOffset, rowLength);<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> * Construct the Append with user defined data. NOTED: 1) all cells in the familyMap must have the<a name="line.133"></a>
<span class="sourceLineNo">134</span> * Type.Put 2) the row of each cell must be same with passed row.<a name="line.134"></a>
<span class="sourceLineNo">135</span> * @param row row. CAN'T be null<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @param ts timestamp<a name="line.136"></a>
<span class="sourceLineNo">137</span> * @param familyMap the map to collect all cells internally. CAN'T be null<a name="line.137"></a>
<span class="sourceLineNo">138</span> */<a name="line.138"></a>
<span class="sourceLineNo">139</span> public Append(byte[] row, long ts, NavigableMap&lt;byte[], List&lt;Cell&gt;&gt; familyMap) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> super(row, ts, familyMap);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<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> * Add the specified column and value to this Append operation.<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @param family family name<a name="line.145"></a>
<span class="sourceLineNo">146</span> * @param qualifier column qualifier<a name="line.146"></a>
<span class="sourceLineNo">147</span> * @param value value to append to specified column n<a name="line.147"></a>
<span class="sourceLineNo">148</span> */<a name="line.148"></a>
<span class="sourceLineNo">149</span> public Append addColumn(byte[] family, byte[] qualifier, byte[] value) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> KeyValue kv = new KeyValue(this.row, family, qualifier, this.ts, KeyValue.Type.Put, value);<a name="line.150"></a>
<span class="sourceLineNo">151</span> return add(kv);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<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> * Add column and value to this Append operation.<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @return This instance<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> @Override<a name="line.158"></a>
<span class="sourceLineNo">159</span> public Append add(final Cell cell) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> try {<a name="line.160"></a>
<span class="sourceLineNo">161</span> super.add(cell);<a name="line.161"></a>
<span class="sourceLineNo">162</span> } catch (IOException e) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> // we eat the exception of wrong row for BC..<a name="line.163"></a>
<span class="sourceLineNo">164</span> LOG.error(e.toString(), e);<a name="line.164"></a>
<span class="sourceLineNo">165</span> }<a name="line.165"></a>
<span class="sourceLineNo">166</span> return this;<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> @Override<a name="line.169"></a>
<span class="sourceLineNo">170</span> public Append setTimestamp(long timestamp) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> super.setTimestamp(timestamp);<a name="line.171"></a>
<span class="sourceLineNo">172</span> return this;<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> @Override<a name="line.175"></a>
<span class="sourceLineNo">176</span> public Append setAttribute(String name, byte[] value) {<a name="line.176"></a>
<span class="sourceLineNo">177</span> return (Append) super.setAttribute(name, value);<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> @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span> public Append setId(String id) {<a name="line.181"></a>
<span class="sourceLineNo">182</span> return (Append) super.setId(id);<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span> public Append setDurability(Durability d) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> return (Append) super.setDurability(d);<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> @Override<a name="line.190"></a>
<span class="sourceLineNo">191</span> public Append setClusterIds(List&lt;UUID&gt; clusterIds) {<a name="line.191"></a>
<span class="sourceLineNo">192</span> return (Append) super.setClusterIds(clusterIds);<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> @Override<a name="line.195"></a>
<span class="sourceLineNo">196</span> public Append setCellVisibility(CellVisibility expression) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> return (Append) super.setCellVisibility(expression);<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> @Override<a name="line.200"></a>
<span class="sourceLineNo">201</span> public Append setACL(String user, Permission perms) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> return (Append) super.setACL(user, perms);<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> @Override<a name="line.205"></a>
<span class="sourceLineNo">206</span> public Append setACL(Map&lt;String, Permission&gt; perms) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> return (Append) super.setACL(perms);<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> @Override<a name="line.210"></a>
<span class="sourceLineNo">211</span> public Append setPriority(int priority) {<a name="line.211"></a>
<span class="sourceLineNo">212</span> return (Append) super.setPriority(priority);<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> @Override<a name="line.215"></a>
<span class="sourceLineNo">216</span> public Append setTTL(long ttl) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> return (Append) super.setTTL(ttl);<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> @Override<a name="line.220"></a>
<span class="sourceLineNo">221</span> public CellBuilder getCellBuilder(CellBuilderType type) {<a name="line.221"></a>
<span class="sourceLineNo">222</span> return getCellBuilder(type, Cell.Type.Put);<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span>}<a name="line.224"></a>
</pre>
</div>
</body>
</html>