| <!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.coprocessor;<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.ArrayList;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Collection;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Collections;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.SortedSet;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.TreeSet;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.CoprocessorEnvironment;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.HConstants;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.client.Mutation;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.ipc.CoprocessorRpcUtils;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.protobuf.ProtobufUtil;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.protobuf.generated.ClientProtos.MutationProto;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MultiRowMutationService;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MutateRowsRequest;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.protobuf.generated.MultiRowMutationProtos.MutateRowsResponse;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.regionserver.HRegion;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.regionserver.WrongRegionException;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import com.google.protobuf.RpcCallback;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import com.google.protobuf.RpcController;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import com.google.protobuf.Service;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span>/**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * This class demonstrates how to implement atomic multi row transactions using<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * {@link HRegion#mutateRowsWithLocks(Collection, Collection, long, long)}<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * and Coprocessor endpoints.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> *<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * Defines a protocol to perform multi row transactions.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * See {@link MultiRowMutationEndpoint} for the implementation.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * <br><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * See<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * {@link HRegion#mutateRowsWithLocks(Collection, Collection, long, long)}<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * for details and limitations.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <br><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Example:<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * <code><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * List&lt;Mutation&gt; mutations = ...;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Put p1 = new Put(row1);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Put p2 = new Put(row2);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * ...<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Mutate m1 = ProtobufUtil.toMutate(MutateType.PUT, p1);<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * Mutate m2 = ProtobufUtil.toMutate(MutateType.PUT, p2);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * MutateRowsRequest.Builder mrmBuilder = MutateRowsRequest.newBuilder();<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * mrmBuilder.addMutationRequest(m1);<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * mrmBuilder.addMutationRequest(m2);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * CoprocessorRpcChannel channel = t.coprocessorService(ROW);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * MultiRowMutationService.BlockingInterface service =<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * MultiRowMutationService.newBlockingStub(channel);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * MutateRowsRequest mrm = mrmBuilder.build();<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * service.mutateRows(null, mrm);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * </code><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> */<a name="line.78"></a> |
| <span class="sourceLineNo">079</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.79"></a> |
| <span class="sourceLineNo">080</span>@InterfaceStability.Evolving<a name="line.80"></a> |
| <span class="sourceLineNo">081</span>public class MultiRowMutationEndpoint extends MultiRowMutationService implements RegionCoprocessor {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> private RegionCoprocessorEnvironment env;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> @Override<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public void mutateRows(RpcController controller, MutateRowsRequest request,<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> RpcCallback<MutateRowsResponse> done) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> MutateRowsResponse response = MutateRowsResponse.getDefaultInstance();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> try {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> // set of rows to lock, sorted to avoid deadlocks<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> SortedSet<byte[]> rowsToLock = new TreeSet<>(Bytes.BYTES_COMPARATOR);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> List<MutationProto> mutateRequestList = request.getMutationRequestList();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> List<Mutation> mutations = new ArrayList<>(mutateRequestList.size());<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> for (MutationProto m : mutateRequestList) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> mutations.add(ProtobufUtil.toMutation(m));<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> RegionInfo regionInfo = env.getRegion().getRegionInfo();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> for (Mutation m : mutations) {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> // check whether rows are in range for this region<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> if (!HRegion.rowIsInRange(regionInfo, m.getRow())) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> String msg = "Requested row out of range '"<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> + Bytes.toStringBinary(m.getRow()) + "'";<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (rowsToLock.isEmpty()) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> // if this is the first row, region might have moved,<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> // allow client to retry<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> throw new WrongRegionException(msg);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> } else {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> // rows are split between regions, do not retry<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> throw new org.apache.hadoop.hbase.DoNotRetryIOException(msg);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> rowsToLock.add(m.getRow());<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> // call utility method on region<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> long nonceGroup = request.hasNonceGroup() ? request.getNonceGroup() : HConstants.NO_NONCE;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> long nonce = request.hasNonce() ? request.getNonce() : HConstants.NO_NONCE;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> env.getRegion().mutateRowsWithLocks(mutations, rowsToLock, nonceGroup, nonce);<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> } catch (IOException e) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> CoprocessorRpcUtils.setControllerException(controller, e);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> done.run(response);<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> @Override<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> public Iterable<Service> getServices() {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> return Collections.singleton(this);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<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> * Stores a reference to the coprocessor environment provided by the<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * {@link org.apache.hadoop.hbase.regionserver.RegionCoprocessorHost} from the region where this<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * coprocessor is loaded. Since this is a coprocessor endpoint, it always expects to be loaded<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * on a table region, so always expects this to be an instance of<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * {@link RegionCoprocessorEnvironment}.<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @param env the environment provided by the coprocessor host<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @throws IOException if the provided environment is not an instance of<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * {@code RegionCoprocessorEnvironment}<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> @Override<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public void start(CoprocessorEnvironment env) throws IOException {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> if (env instanceof RegionCoprocessorEnvironment) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> this.env = (RegionCoprocessorEnvironment)env;<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> } else {<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> throw new CoprocessorException("Must be loaded on a table region!");<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<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> @Override<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public void stop(CoprocessorEnvironment env) throws IOException {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> // nothing to do<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
