| <!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,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase.coprocessor;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.ArrayList;<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.Map;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.hadoop.fs.FileSystem;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.hadoop.fs.Path;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.Cell;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.CompareOperator;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.hadoop.hbase.client.Append;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.hadoop.hbase.client.Delete;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.hadoop.hbase.client.Durability;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.hadoop.hbase.client.Get;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.hadoop.hbase.client.Increment;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.hadoop.hbase.client.Mutation;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.hadoop.hbase.client.Put;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.hadoop.hbase.client.RegionInfo;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.hadoop.hbase.client.Result;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.hadoop.hbase.client.Scan;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.hadoop.hbase.filter.ByteArrayComparable;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.hadoop.hbase.io.FSDataInputStreamWrapper;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.hadoop.hbase.io.Reference;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.hadoop.hbase.io.hfile.CacheConfig;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.hadoop.hbase.regionserver.FlushLifeCycleTracker;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.hadoop.hbase.regionserver.InternalScanner;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.hadoop.hbase.regionserver.MiniBatchOperationInProgress;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.apache.hadoop.hbase.regionserver.OperationStatus;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.apache.hadoop.hbase.regionserver.Region;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.apache.hadoop.hbase.regionserver.Region.Operation;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.apache.hadoop.hbase.regionserver.RegionScanner;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.apache.hadoop.hbase.regionserver.ScanOptions;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.apache.hadoop.hbase.regionserver.ScanType;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.apache.hadoop.hbase.regionserver.Store;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.apache.hadoop.hbase.regionserver.StoreFile;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span>import org.apache.hadoop.hbase.regionserver.StoreFileReader;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionLifeCycleTracker;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>import org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span>import org.apache.hadoop.hbase.regionserver.querymatcher.DeleteTracker;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>import org.apache.hadoop.hbase.util.Pair;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span>import org.apache.hadoop.hbase.wal.WALEdit;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span>import org.apache.hadoop.hbase.wal.WALKey;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span>import org.apache.yetus.audience.InterfaceStability;<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> * Coprocessors implement this interface to observe and mediate client actions on the region.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Since most implementations will be interested in only a subset of hooks, this class uses<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * 'default' functions to avoid having to add unnecessary overrides. When the functions are<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * non-empty, it's simply to satisfy the compiler by returning value of expected (non-void) type. It<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * is done in a way that these default definitions act as no-op. So our suggestion to implementation<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * would be to not call these 'default' methods from overrides.<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * <p><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <h3>Exception Handling</h3><br><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * For all functions, exception handling is done as follows:<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <ul><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <li>Exceptions of type {@link IOException} are reported back to client.</li><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <li>For any other kind of exception:<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <ul><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <li>If the configuration {@link CoprocessorHost#ABORT_ON_ERROR_KEY} is set to true, then the<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * server aborts.</li><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <li>Otherwise, coprocessor is removed from the server and<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * {@link org.apache.hadoop.hbase.DoNotRetryIOException} is returned to the client.</li><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * </ul><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * </li><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * </ul><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * <p><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * <h3>For Split Related Hooks</h3> <br><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * In hbase2/AMv2, master runs splits, so the split related hooks are moved to<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * {@link MasterObserver}.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * <p><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * <h3>Increment Column Value</h3><br><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * We do not call this hook anymore.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.97"></a> |
| <span class="sourceLineNo">098</span>@InterfaceStability.Evolving<a name="line.98"></a> |
| <span class="sourceLineNo">099</span>// TODO as method signatures need to break, update to<a name="line.99"></a> |
| <span class="sourceLineNo">100</span>// ObserverContext<? extends RegionCoprocessorEnvironment><a name="line.100"></a> |
| <span class="sourceLineNo">101</span>// so we can use additional environment state that isn't exposed to coprocessors.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span>public interface RegionObserver {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> /** Mutation type for postMutationBeforeWAL hook */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> enum MutationType {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> APPEND, INCREMENT<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> /**<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> * Called before the region is reported as open to the master.<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * @param c the environment provided by the region server<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> */<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> default void preOpen(ObserverContext<RegionCoprocessorEnvironment> c) throws IOException {}<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> * Called after the region is reported as open to the master.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param c the environment provided by the region server<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> default void postOpen(ObserverContext<RegionCoprocessorEnvironment> c) {}<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> * Called before the memstore is flushed to disk.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param c the environment provided by the region server<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> default void preFlush(final ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> FlushLifeCycleTracker tracker) throws IOException {}<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> * Called before we open store scanner for flush. You can use the {@code options} to change max<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * versions and TTL for the scanner being opened.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param c the environment provided by the region server<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param store the store where flush is being requested<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param options used to change max versions and TTL for the scanner being opened<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> default void preFlushScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> ScanOptions options,FlushLifeCycleTracker tracker) throws IOException {}<a name="line.136"></a> |
| <span class="sourceLineNo">137</span><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> /**<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * Called before a Store's memstore is flushed to disk.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @param c the environment provided by the region server<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param store the store where flush is being requested<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @param scanner the scanner over existing data used in the memstore<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @return the scanner to use during flush. Should not be {@code null} unless the implementation<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * is writing new store files on its own.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> default InternalScanner preFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> InternalScanner scanner, FlushLifeCycleTracker tracker) throws IOException {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return scanner;<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> * Called after the memstore is flushed to disk.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @param c the environment provided by the region server<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @throws IOException if an error occurred on the coprocessor<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> */<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> default void postFlush(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> FlushLifeCycleTracker tracker) throws IOException {}<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> /**<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * Called after a Store's memstore is flushed to disk.<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param c the environment provided by the region server<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @param store the store being flushed<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @param resultFile the new store file written out during compaction<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param tracker tracker used to track the life cycle of a flush<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> */<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> default void postFlush(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> StoreFile resultFile, FlushLifeCycleTracker tracker) throws IOException {}<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> * Called before in memory compaction started.<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @param c the environment provided by the region server<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @param store the store where in memory compaction is being requested<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> */<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> default void preMemStoreCompaction(ObserverContext<RegionCoprocessorEnvironment> c, Store store)<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> throws IOException {}<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> * Called before we open store scanner for in memory compaction. You can use the {@code options}<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * to change max versions and TTL for the scanner being opened. Notice that this method will only<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * be called when you use {@code eager} mode. For {@code basic} mode we will not drop any cells<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * thus we do not open a store scanner.<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @param c the environment provided by the region server<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @param store the store where in memory compaction is being requested<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @param options used to change max versions and TTL for the scanner being opened<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> */<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> default void preMemStoreCompactionCompactScannerOpen(<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> ObserverContext<RegionCoprocessorEnvironment> c, Store store, ScanOptions options)<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> throws IOException {}<a name="line.190"></a> |
| <span class="sourceLineNo">191</span><a name="line.191"></a> |
| <span class="sourceLineNo">192</span> /**<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * Called before we do in memory compaction. Notice that this method will only be called when you<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * use {@code eager} mode. For {@code basic} mode we will not drop any cells thus there is no<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * {@link InternalScanner}.<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * @param c the environment provided by the region server<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @param store the store where in memory compaction is being executed<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> * @param scanner the scanner over existing data used in the memstore segments being compact<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * @return the scanner to use during in memory compaction. Must be non-null.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> */<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> default InternalScanner preMemStoreCompactionCompact(<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> ObserverContext<RegionCoprocessorEnvironment> c, Store store, InternalScanner scanner)<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> throws IOException {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> return scanner;<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<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> * Called after the in memory compaction is finished.<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> * @param c the environment provided by the region server<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> * @param store the store where in memory compaction is being executed<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> */<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> default void postMemStoreCompaction(ObserverContext<RegionCoprocessorEnvironment> c, Store store)<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> throws IOException {}<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> * Called prior to selecting the {@link StoreFile StoreFiles} to compact from the list of<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> * available candidates. To alter the files used for compaction, you may mutate the passed in list<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> * of candidates. If you remove all the candidates then the compaction will be canceled.<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> * <p>Supports Coprocessor 'bypass' -- 'bypass' is how this method indicates that it changed<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> * the passed in <code>candidates</code>.<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> * @param c the environment provided by the region server<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> * @param store the store where compaction is being requested<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> * @param candidates the store files currently available for compaction<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> */<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> default void preCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> List<? extends StoreFile> candidates, CompactionLifeCycleTracker tracker)<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> throws IOException {}<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> * Called after the {@link StoreFile}s to compact have been selected from the available<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> * candidates.<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @param c the environment provided by the region server<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> * @param store the store being compacted<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param selected the store files selected to compact<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @param request the requested compaction<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> default void postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> List<? extends StoreFile> selected, CompactionLifeCycleTracker tracker,<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> CompactionRequest request) {}<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> /**<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * Called before we open store scanner for compaction. You can use the {@code options} to change max<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> * versions and TTL for the scanner being opened.<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @param c the environment provided by the region server<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @param store the store being compacted<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @param scanType type of Scan<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> * @param options used to change max versions and TTL for the scanner being opened<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> * @param request the requested compaction<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> */<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> default void preCompactScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> ScanType scanType, ScanOptions options, CompactionLifeCycleTracker tracker,<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> CompactionRequest request) throws IOException {}<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> /**<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * Called prior to writing the {@link StoreFile}s selected for compaction into a new<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> * {@code StoreFile}.<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * <p><a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * To override or modify the compaction process, implementing classes can wrap the provided<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> * {@link InternalScanner} with a custom implementation that is returned from this method. The<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * custom scanner can then inspect {@link org.apache.hadoop.hbase.Cell}s from the wrapped scanner,<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * applying its own policy to what gets written.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * @param c the environment provided by the region server<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @param store the store being compacted<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @param scanner the scanner over existing data used in the store file rewriting<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @param scanType type of Scan<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * @param tracker tracker used to track the life cycle of a compaction<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @param request the requested compaction<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @return the scanner to use during compaction. Should not be {@code null} unless the<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> * implementation is writing new store files on its own.<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> */<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> default InternalScanner preCompact(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> InternalScanner scanner, ScanType scanType, CompactionLifeCycleTracker tracker,<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> CompactionRequest request) throws IOException {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> return scanner;<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> }<a name="line.279"></a> |
| <span class="sourceLineNo">280</span><a name="line.280"></a> |
| <span class="sourceLineNo">281</span> /**<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Called after compaction has completed and the new store file has been moved in to place.<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @param c the environment provided by the region server<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * @param store the store being compacted<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * @param resultFile the new store file written out during compaction<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * @param tracker used to track the life cycle of a compaction<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * @param request the requested compaction<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> */<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> default void postCompact(ObserverContext<RegionCoprocessorEnvironment> c, Store store,<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> StoreFile resultFile, CompactionLifeCycleTracker tracker, CompactionRequest request)<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> throws IOException {}<a name="line.291"></a> |
| <span class="sourceLineNo">292</span><a name="line.292"></a> |
| <span class="sourceLineNo">293</span> /**<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * Called before the region is reported as closed to the master.<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * @param c the environment provided by the region server<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * @param abortRequested true if the region server is aborting<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> */<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> default void preClose(ObserverContext<RegionCoprocessorEnvironment> c, boolean abortRequested)<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> throws IOException {}<a name="line.299"></a> |
| <span class="sourceLineNo">300</span><a name="line.300"></a> |
| <span class="sourceLineNo">301</span> /**<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> * Called after the region is reported as closed to the master.<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> * @param c the environment provided by the region server<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * @param abortRequested true if the region server is aborting<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> */<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> default void postClose(ObserverContext<RegionCoprocessorEnvironment> c, boolean abortRequested) {}<a name="line.306"></a> |
| <span class="sourceLineNo">307</span><a name="line.307"></a> |
| <span class="sourceLineNo">308</span> /**<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * Called before the client performs a Get<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * <p><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * @param c the environment provided by the region server<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * @param get the Get request<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * @param result The result to return to the client if default processing<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * is bypassed. Can be modified. Will not be used if default processing<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * is not bypassed.<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> */<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> default void preGetOp(ObserverContext<RegionCoprocessorEnvironment> c, Get get, List<Cell> result)<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> throws IOException {}<a name="line.320"></a> |
| <span class="sourceLineNo">321</span><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> /**<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * Called after the client performs a Get<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * <p><a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * Note: Do not retain references to any Cells in 'result' beyond the life of this invocation.<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> * @param c the environment provided by the region server<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> * @param get the Get request<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * @param result the result to return to the client, modify as necessary<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> */<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> default void postGetOp(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> List<Cell> result) throws IOException {}<a name="line.332"></a> |
| <span class="sourceLineNo">333</span><a name="line.333"></a> |
| <span class="sourceLineNo">334</span> /**<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * Called before the client tests for existence using a Get.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * <p><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * @param c the environment provided by the region server<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @param get the Get request<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> * @param exists the result returned by the region server<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> * @return the value to return to the client if bypassing default processing<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> */<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> default boolean preExists(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> boolean exists) throws IOException {<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> return exists;<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> /**<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * Called after the client tests for existence using a Get.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * @param c the environment provided by the region server<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @param get the Get request<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @param exists the result returned by the region server<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * @return the result to return to the client<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> */<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> default boolean postExists(ObserverContext<RegionCoprocessorEnvironment> c, Get get,<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> boolean exists) throws IOException {<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> return exists;<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> }<a name="line.359"></a> |
| <span class="sourceLineNo">360</span><a name="line.360"></a> |
| <span class="sourceLineNo">361</span> /**<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * Called before the client stores a value.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * <p><a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * <p><a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @param c the environment provided by the region server<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> * @param put The Put object<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> * @param edit The WALEdit object that will be written to the wal<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> * @param durability Persistence guarantee for this Put<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> */<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> default void prePut(ObserverContext<RegionCoprocessorEnvironment> c, Put put, WALEdit edit,<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> Durability durability) throws IOException {}<a name="line.375"></a> |
| <span class="sourceLineNo">376</span><a name="line.376"></a> |
| <span class="sourceLineNo">377</span> /**<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> * Called after the client stores a value.<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> * <p><a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * @param c the environment provided by the region server<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * @param put The Put object<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * @param edit The WALEdit object for the wal<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @param durability Persistence guarantee for this Put<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> */<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> default void postPut(ObserverContext<RegionCoprocessorEnvironment> c, Put put, WALEdit edit,<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> Durability durability) throws IOException {}<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> /**<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> * Called before the client deletes a value.<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> * <p><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * <p><a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * @param c the environment provided by the region server<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * @param delete The Delete object<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @param edit The WALEdit object for the wal<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * @param durability Persistence guarantee for this Delete<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> */<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> default void preDelete(ObserverContext<RegionCoprocessorEnvironment> c, Delete delete,<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> WALEdit edit, Durability durability) throws IOException {}<a name="line.404"></a> |
| <span class="sourceLineNo">405</span><a name="line.405"></a> |
| <span class="sourceLineNo">406</span> /**<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> * Called before the server updates the timestamp for version delete with latest timestamp.<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> * <p><a name="line.408"></a> |
| <span class="sourceLineNo">409</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> * @param c the environment provided by the region server<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> * @param mutation - the parent mutation associated with this delete cell<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> * @param cell - The deleteColumn with latest version cell<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> * @param byteNow - timestamp bytes<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> * @param get - the get formed using the current cell's row. Note that the get does not specify<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> * the family and qualifier<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> * @deprecated Since hbase-2.0.0. No replacement. To be removed in hbase-3.0.0 and replaced<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> * with something that doesn't expose IntefaceAudience.Private classes.<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> */<a name="line.419"></a> |
| <span class="sourceLineNo">420</span> @Deprecated<a name="line.420"></a> |
| <span class="sourceLineNo">421</span> default void prePrepareTimeStampForDeleteVersion(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> Mutation mutation, Cell cell, byte[] byteNow, Get get) throws IOException {}<a name="line.422"></a> |
| <span class="sourceLineNo">423</span><a name="line.423"></a> |
| <span class="sourceLineNo">424</span> /**<a name="line.424"></a> |
| <span class="sourceLineNo">425</span> * Called after the client deletes a value.<a name="line.425"></a> |
| <span class="sourceLineNo">426</span> * <p><a name="line.426"></a> |
| <span class="sourceLineNo">427</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> * @param c the environment provided by the region server<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> * @param delete The Delete object<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> * @param edit The WALEdit object for the wal<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> * @param durability Persistence guarantee for this Delete<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> */<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> default void postDelete(ObserverContext<RegionCoprocessorEnvironment> c, Delete delete,<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> WALEdit edit, Durability durability) throws IOException {}<a name="line.435"></a> |
| <span class="sourceLineNo">436</span><a name="line.436"></a> |
| <span class="sourceLineNo">437</span> /**<a name="line.437"></a> |
| <span class="sourceLineNo">438</span> * This will be called for every batch mutation operation happening at the server. This will be<a name="line.438"></a> |
| <span class="sourceLineNo">439</span> * called after acquiring the locks on the mutating rows and after applying the proper timestamp<a name="line.439"></a> |
| <span class="sourceLineNo">440</span> * for each Mutation at the server. The batch may contain Put/Delete. By setting OperationStatus<a name="line.440"></a> |
| <span class="sourceLineNo">441</span> * of Mutations ({@link MiniBatchOperationInProgress#setOperationStatus(int, OperationStatus)}),<a name="line.441"></a> |
| <span class="sourceLineNo">442</span> * {@link RegionObserver} can make Region to skip these Mutations.<a name="line.442"></a> |
| <span class="sourceLineNo">443</span> * <p><a name="line.443"></a> |
| <span class="sourceLineNo">444</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.444"></a> |
| <span class="sourceLineNo">445</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.445"></a> |
| <span class="sourceLineNo">446</span> * @param c the environment provided by the region server<a name="line.446"></a> |
| <span class="sourceLineNo">447</span> * @param miniBatchOp batch of Mutations getting applied to region.<a name="line.447"></a> |
| <span class="sourceLineNo">448</span> */<a name="line.448"></a> |
| <span class="sourceLineNo">449</span> default void preBatchMutate(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.449"></a> |
| <span class="sourceLineNo">450</span> MiniBatchOperationInProgress<Mutation> miniBatchOp) throws IOException {}<a name="line.450"></a> |
| <span class="sourceLineNo">451</span><a name="line.451"></a> |
| <span class="sourceLineNo">452</span> /**<a name="line.452"></a> |
| <span class="sourceLineNo">453</span> * This will be called after applying a batch of Mutations on a region. The Mutations are added to<a name="line.453"></a> |
| <span class="sourceLineNo">454</span> * memstore and WAL. The difference of this one with<a name="line.454"></a> |
| <span class="sourceLineNo">455</span> * {@link #postPut(ObserverContext, Put, WALEdit, Durability) }<a name="line.455"></a> |
| <span class="sourceLineNo">456</span> * and {@link #postDelete(ObserverContext, Delete, WALEdit, Durability) } is<a name="line.456"></a> |
| <span class="sourceLineNo">457</span> * this hook will be executed before the mvcc transaction completion.<a name="line.457"></a> |
| <span class="sourceLineNo">458</span> * <p><a name="line.458"></a> |
| <span class="sourceLineNo">459</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.459"></a> |
| <span class="sourceLineNo">460</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.460"></a> |
| <span class="sourceLineNo">461</span> * @param c the environment provided by the region server<a name="line.461"></a> |
| <span class="sourceLineNo">462</span> * @param miniBatchOp batch of Mutations applied to region. Coprocessors are discouraged from<a name="line.462"></a> |
| <span class="sourceLineNo">463</span> * manipulating its state.<a name="line.463"></a> |
| <span class="sourceLineNo">464</span> */<a name="line.464"></a> |
| <span class="sourceLineNo">465</span> // Coprocessors can do a form of bypass by changing state in miniBatchOp.<a name="line.465"></a> |
| <span class="sourceLineNo">466</span> default void postBatchMutate(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.466"></a> |
| <span class="sourceLineNo">467</span> MiniBatchOperationInProgress<Mutation> miniBatchOp) throws IOException {}<a name="line.467"></a> |
| <span class="sourceLineNo">468</span><a name="line.468"></a> |
| <span class="sourceLineNo">469</span> /**<a name="line.469"></a> |
| <span class="sourceLineNo">470</span> * This will be called for region operations where read lock is acquired in<a name="line.470"></a> |
| <span class="sourceLineNo">471</span> * {@link Region#startRegionOperation()}.<a name="line.471"></a> |
| <span class="sourceLineNo">472</span> * @param ctx<a name="line.472"></a> |
| <span class="sourceLineNo">473</span> * @param operation The operation is about to be taken on the region<a name="line.473"></a> |
| <span class="sourceLineNo">474</span> */<a name="line.474"></a> |
| <span class="sourceLineNo">475</span> default void postStartRegionOperation(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.475"></a> |
| <span class="sourceLineNo">476</span> Operation operation) throws IOException {}<a name="line.476"></a> |
| <span class="sourceLineNo">477</span><a name="line.477"></a> |
| <span class="sourceLineNo">478</span> /**<a name="line.478"></a> |
| <span class="sourceLineNo">479</span> * Called after releasing read lock in {@link Region#closeRegionOperation()}.<a name="line.479"></a> |
| <span class="sourceLineNo">480</span> * @param ctx<a name="line.480"></a> |
| <span class="sourceLineNo">481</span> * @param operation<a name="line.481"></a> |
| <span class="sourceLineNo">482</span> */<a name="line.482"></a> |
| <span class="sourceLineNo">483</span> default void postCloseRegionOperation(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.483"></a> |
| <span class="sourceLineNo">484</span> Operation operation) throws IOException {}<a name="line.484"></a> |
| <span class="sourceLineNo">485</span><a name="line.485"></a> |
| <span class="sourceLineNo">486</span> /**<a name="line.486"></a> |
| <span class="sourceLineNo">487</span> * Called after the completion of batch put/delete and will be called even if the batch operation<a name="line.487"></a> |
| <span class="sourceLineNo">488</span> * fails.<a name="line.488"></a> |
| <span class="sourceLineNo">489</span> * <p><a name="line.489"></a> |
| <span class="sourceLineNo">490</span> * Note: Do not retain references to any Cells in Mutations beyond the life of this invocation.<a name="line.490"></a> |
| <span class="sourceLineNo">491</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.491"></a> |
| <span class="sourceLineNo">492</span> * @param ctx<a name="line.492"></a> |
| <span class="sourceLineNo">493</span> * @param miniBatchOp<a name="line.493"></a> |
| <span class="sourceLineNo">494</span> * @param success true if batch operation is successful otherwise false.<a name="line.494"></a> |
| <span class="sourceLineNo">495</span> */<a name="line.495"></a> |
| <span class="sourceLineNo">496</span> default void postBatchMutateIndispensably(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.496"></a> |
| <span class="sourceLineNo">497</span> MiniBatchOperationInProgress<Mutation> miniBatchOp, boolean success) throws IOException {}<a name="line.497"></a> |
| <span class="sourceLineNo">498</span><a name="line.498"></a> |
| <span class="sourceLineNo">499</span> /**<a name="line.499"></a> |
| <span class="sourceLineNo">500</span> * Called before checkAndPut.<a name="line.500"></a> |
| <span class="sourceLineNo">501</span> * <p><a name="line.501"></a> |
| <span class="sourceLineNo">502</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.502"></a> |
| <span class="sourceLineNo">503</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.503"></a> |
| <span class="sourceLineNo">504</span> * <p><a name="line.504"></a> |
| <span class="sourceLineNo">505</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.505"></a> |
| <span class="sourceLineNo">506</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.506"></a> |
| <span class="sourceLineNo">507</span> * @param c the environment provided by the region server<a name="line.507"></a> |
| <span class="sourceLineNo">508</span> * @param row row to check<a name="line.508"></a> |
| <span class="sourceLineNo">509</span> * @param family column family<a name="line.509"></a> |
| <span class="sourceLineNo">510</span> * @param qualifier column qualifier<a name="line.510"></a> |
| <span class="sourceLineNo">511</span> * @param op the comparison operation<a name="line.511"></a> |
| <span class="sourceLineNo">512</span> * @param comparator the comparator<a name="line.512"></a> |
| <span class="sourceLineNo">513</span> * @param put data to put if check succeeds<a name="line.513"></a> |
| <span class="sourceLineNo">514</span> * @param result<a name="line.514"></a> |
| <span class="sourceLineNo">515</span> * @return the return value to return to client if bypassing default<a name="line.515"></a> |
| <span class="sourceLineNo">516</span> * processing<a name="line.516"></a> |
| <span class="sourceLineNo">517</span> */<a name="line.517"></a> |
| <span class="sourceLineNo">518</span> default boolean preCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c, byte[] row,<a name="line.518"></a> |
| <span class="sourceLineNo">519</span> byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Put put,<a name="line.519"></a> |
| <span class="sourceLineNo">520</span> boolean result) throws IOException {<a name="line.520"></a> |
| <span class="sourceLineNo">521</span> return result;<a name="line.521"></a> |
| <span class="sourceLineNo">522</span> }<a name="line.522"></a> |
| <span class="sourceLineNo">523</span><a name="line.523"></a> |
| <span class="sourceLineNo">524</span> /**<a name="line.524"></a> |
| <span class="sourceLineNo">525</span> * Called before checkAndPut but after acquiring rowlock.<a name="line.525"></a> |
| <span class="sourceLineNo">526</span> * <p><a name="line.526"></a> |
| <span class="sourceLineNo">527</span> * <b>Note:</b> Caution to be taken for not doing any long time operation in this hook.<a name="line.527"></a> |
| <span class="sourceLineNo">528</span> * Row will be locked for longer time. Trying to acquire lock on another row, within this,<a name="line.528"></a> |
| <span class="sourceLineNo">529</span> * can lead to potential deadlock.<a name="line.529"></a> |
| <span class="sourceLineNo">530</span> * <p><a name="line.530"></a> |
| <span class="sourceLineNo">531</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.531"></a> |
| <span class="sourceLineNo">532</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.532"></a> |
| <span class="sourceLineNo">533</span> * <p><a name="line.533"></a> |
| <span class="sourceLineNo">534</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.534"></a> |
| <span class="sourceLineNo">535</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.535"></a> |
| <span class="sourceLineNo">536</span> * @param c the environment provided by the region server<a name="line.536"></a> |
| <span class="sourceLineNo">537</span> * @param row row to check<a name="line.537"></a> |
| <span class="sourceLineNo">538</span> * @param family column family<a name="line.538"></a> |
| <span class="sourceLineNo">539</span> * @param qualifier column qualifier<a name="line.539"></a> |
| <span class="sourceLineNo">540</span> * @param op the comparison operation<a name="line.540"></a> |
| <span class="sourceLineNo">541</span> * @param comparator the comparator<a name="line.541"></a> |
| <span class="sourceLineNo">542</span> * @param put data to put if check succeeds<a name="line.542"></a> |
| <span class="sourceLineNo">543</span> * @param result<a name="line.543"></a> |
| <span class="sourceLineNo">544</span> * @return the return value to return to client if bypassing default<a name="line.544"></a> |
| <span class="sourceLineNo">545</span> * processing<a name="line.545"></a> |
| <span class="sourceLineNo">546</span> */<a name="line.546"></a> |
| <span class="sourceLineNo">547</span> default boolean preCheckAndPutAfterRowLock(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.547"></a> |
| <span class="sourceLineNo">548</span> byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.548"></a> |
| <span class="sourceLineNo">549</span> ByteArrayComparable comparator, Put put, boolean result) throws IOException {<a name="line.549"></a> |
| <span class="sourceLineNo">550</span> return result;<a name="line.550"></a> |
| <span class="sourceLineNo">551</span> }<a name="line.551"></a> |
| <span class="sourceLineNo">552</span><a name="line.552"></a> |
| <span class="sourceLineNo">553</span> /**<a name="line.553"></a> |
| <span class="sourceLineNo">554</span> * Called after checkAndPut<a name="line.554"></a> |
| <span class="sourceLineNo">555</span> * <p><a name="line.555"></a> |
| <span class="sourceLineNo">556</span> * Note: Do not retain references to any Cells in 'put' beyond the life of this invocation.<a name="line.556"></a> |
| <span class="sourceLineNo">557</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.557"></a> |
| <span class="sourceLineNo">558</span> * @param c the environment provided by the region server<a name="line.558"></a> |
| <span class="sourceLineNo">559</span> * @param row row to check<a name="line.559"></a> |
| <span class="sourceLineNo">560</span> * @param family column family<a name="line.560"></a> |
| <span class="sourceLineNo">561</span> * @param qualifier column qualifier<a name="line.561"></a> |
| <span class="sourceLineNo">562</span> * @param op the comparison operation<a name="line.562"></a> |
| <span class="sourceLineNo">563</span> * @param comparator the comparator<a name="line.563"></a> |
| <span class="sourceLineNo">564</span> * @param put data to put if check succeeds<a name="line.564"></a> |
| <span class="sourceLineNo">565</span> * @param result from the checkAndPut<a name="line.565"></a> |
| <span class="sourceLineNo">566</span> * @return the possibly transformed return value to return to client<a name="line.566"></a> |
| <span class="sourceLineNo">567</span> */<a name="line.567"></a> |
| <span class="sourceLineNo">568</span> default boolean postCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c, byte[] row,<a name="line.568"></a> |
| <span class="sourceLineNo">569</span> byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator, Put put,<a name="line.569"></a> |
| <span class="sourceLineNo">570</span> boolean result) throws IOException {<a name="line.570"></a> |
| <span class="sourceLineNo">571</span> return result;<a name="line.571"></a> |
| <span class="sourceLineNo">572</span> }<a name="line.572"></a> |
| <span class="sourceLineNo">573</span><a name="line.573"></a> |
| <span class="sourceLineNo">574</span> /**<a name="line.574"></a> |
| <span class="sourceLineNo">575</span> * Called before checkAndDelete.<a name="line.575"></a> |
| <span class="sourceLineNo">576</span> * <p><a name="line.576"></a> |
| <span class="sourceLineNo">577</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.577"></a> |
| <span class="sourceLineNo">578</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.578"></a> |
| <span class="sourceLineNo">579</span> * <p><a name="line.579"></a> |
| <span class="sourceLineNo">580</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.580"></a> |
| <span class="sourceLineNo">581</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.581"></a> |
| <span class="sourceLineNo">582</span> * @param c the environment provided by the region server<a name="line.582"></a> |
| <span class="sourceLineNo">583</span> * @param row row to check<a name="line.583"></a> |
| <span class="sourceLineNo">584</span> * @param family column family<a name="line.584"></a> |
| <span class="sourceLineNo">585</span> * @param qualifier column qualifier<a name="line.585"></a> |
| <span class="sourceLineNo">586</span> * @param op the comparison operation<a name="line.586"></a> |
| <span class="sourceLineNo">587</span> * @param comparator the comparator<a name="line.587"></a> |
| <span class="sourceLineNo">588</span> * @param delete delete to commit if check succeeds<a name="line.588"></a> |
| <span class="sourceLineNo">589</span> * @param result<a name="line.589"></a> |
| <span class="sourceLineNo">590</span> * @return the value to return to client if bypassing default processing<a name="line.590"></a> |
| <span class="sourceLineNo">591</span> */<a name="line.591"></a> |
| <span class="sourceLineNo">592</span> default boolean preCheckAndDelete(ObserverContext<RegionCoprocessorEnvironment> c, byte[] row,<a name="line.592"></a> |
| <span class="sourceLineNo">593</span> byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator,<a name="line.593"></a> |
| <span class="sourceLineNo">594</span> Delete delete, boolean result) throws IOException {<a name="line.594"></a> |
| <span class="sourceLineNo">595</span> return result;<a name="line.595"></a> |
| <span class="sourceLineNo">596</span> }<a name="line.596"></a> |
| <span class="sourceLineNo">597</span><a name="line.597"></a> |
| <span class="sourceLineNo">598</span> /**<a name="line.598"></a> |
| <span class="sourceLineNo">599</span> * Called before checkAndDelete but after acquiring rowock.<a name="line.599"></a> |
| <span class="sourceLineNo">600</span> * <p><a name="line.600"></a> |
| <span class="sourceLineNo">601</span> * <b>Note:</b> Caution to be taken for not doing any long time operation in this hook.<a name="line.601"></a> |
| <span class="sourceLineNo">602</span> * Row will be locked for longer time. Trying to acquire lock on another row, within this,<a name="line.602"></a> |
| <span class="sourceLineNo">603</span> * can lead to potential deadlock.<a name="line.603"></a> |
| <span class="sourceLineNo">604</span> * <p><a name="line.604"></a> |
| <span class="sourceLineNo">605</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.605"></a> |
| <span class="sourceLineNo">606</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.606"></a> |
| <span class="sourceLineNo">607</span> * <p><a name="line.607"></a> |
| <span class="sourceLineNo">608</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.608"></a> |
| <span class="sourceLineNo">609</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.609"></a> |
| <span class="sourceLineNo">610</span> * @param c the environment provided by the region server<a name="line.610"></a> |
| <span class="sourceLineNo">611</span> * @param row row to check<a name="line.611"></a> |
| <span class="sourceLineNo">612</span> * @param family column family<a name="line.612"></a> |
| <span class="sourceLineNo">613</span> * @param qualifier column qualifier<a name="line.613"></a> |
| <span class="sourceLineNo">614</span> * @param op the comparison operation<a name="line.614"></a> |
| <span class="sourceLineNo">615</span> * @param comparator the comparator<a name="line.615"></a> |
| <span class="sourceLineNo">616</span> * @param delete delete to commit if check succeeds<a name="line.616"></a> |
| <span class="sourceLineNo">617</span> * @param result<a name="line.617"></a> |
| <span class="sourceLineNo">618</span> * @return the value to return to client if bypassing default processing<a name="line.618"></a> |
| <span class="sourceLineNo">619</span> */<a name="line.619"></a> |
| <span class="sourceLineNo">620</span> default boolean preCheckAndDeleteAfterRowLock(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.620"></a> |
| <span class="sourceLineNo">621</span> byte[] row, byte[] family, byte[] qualifier, CompareOperator op,<a name="line.621"></a> |
| <span class="sourceLineNo">622</span> ByteArrayComparable comparator, Delete delete, boolean result) throws IOException {<a name="line.622"></a> |
| <span class="sourceLineNo">623</span> return result;<a name="line.623"></a> |
| <span class="sourceLineNo">624</span> }<a name="line.624"></a> |
| <span class="sourceLineNo">625</span><a name="line.625"></a> |
| <span class="sourceLineNo">626</span> /**<a name="line.626"></a> |
| <span class="sourceLineNo">627</span> * Called after checkAndDelete<a name="line.627"></a> |
| <span class="sourceLineNo">628</span> * <p><a name="line.628"></a> |
| <span class="sourceLineNo">629</span> * Note: Do not retain references to any Cells in 'delete' beyond the life of this invocation.<a name="line.629"></a> |
| <span class="sourceLineNo">630</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.630"></a> |
| <span class="sourceLineNo">631</span> * @param c the environment provided by the region server<a name="line.631"></a> |
| <span class="sourceLineNo">632</span> * @param row row to check<a name="line.632"></a> |
| <span class="sourceLineNo">633</span> * @param family column family<a name="line.633"></a> |
| <span class="sourceLineNo">634</span> * @param qualifier column qualifier<a name="line.634"></a> |
| <span class="sourceLineNo">635</span> * @param op the comparison operation<a name="line.635"></a> |
| <span class="sourceLineNo">636</span> * @param comparator the comparator<a name="line.636"></a> |
| <span class="sourceLineNo">637</span> * @param delete delete to commit if check succeeds<a name="line.637"></a> |
| <span class="sourceLineNo">638</span> * @param result from the CheckAndDelete<a name="line.638"></a> |
| <span class="sourceLineNo">639</span> * @return the possibly transformed returned value to return to client<a name="line.639"></a> |
| <span class="sourceLineNo">640</span> */<a name="line.640"></a> |
| <span class="sourceLineNo">641</span> default boolean postCheckAndDelete(ObserverContext<RegionCoprocessorEnvironment> c, byte[] row,<a name="line.641"></a> |
| <span class="sourceLineNo">642</span> byte[] family, byte[] qualifier, CompareOperator op, ByteArrayComparable comparator,<a name="line.642"></a> |
| <span class="sourceLineNo">643</span> Delete delete, boolean result) throws IOException {<a name="line.643"></a> |
| <span class="sourceLineNo">644</span> return result;<a name="line.644"></a> |
| <span class="sourceLineNo">645</span> }<a name="line.645"></a> |
| <span class="sourceLineNo">646</span><a name="line.646"></a> |
| <span class="sourceLineNo">647</span> /**<a name="line.647"></a> |
| <span class="sourceLineNo">648</span> * Called before Append.<a name="line.648"></a> |
| <span class="sourceLineNo">649</span> * <p><a name="line.649"></a> |
| <span class="sourceLineNo">650</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.650"></a> |
| <span class="sourceLineNo">651</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.651"></a> |
| <span class="sourceLineNo">652</span> * <p><a name="line.652"></a> |
| <span class="sourceLineNo">653</span> * Note: Do not retain references to any Cells in 'append' beyond the life of this invocation.<a name="line.653"></a> |
| <span class="sourceLineNo">654</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.654"></a> |
| <span class="sourceLineNo">655</span> * @param c the environment provided by the region server<a name="line.655"></a> |
| <span class="sourceLineNo">656</span> * @param append Append object<a name="line.656"></a> |
| <span class="sourceLineNo">657</span> * @return result to return to the client if bypassing default processing<a name="line.657"></a> |
| <span class="sourceLineNo">658</span> */<a name="line.658"></a> |
| <span class="sourceLineNo">659</span> default Result preAppend(ObserverContext<RegionCoprocessorEnvironment> c, Append append)<a name="line.659"></a> |
| <span class="sourceLineNo">660</span> throws IOException {<a name="line.660"></a> |
| <span class="sourceLineNo">661</span> return null;<a name="line.661"></a> |
| <span class="sourceLineNo">662</span> }<a name="line.662"></a> |
| <span class="sourceLineNo">663</span><a name="line.663"></a> |
| <span class="sourceLineNo">664</span> /**<a name="line.664"></a> |
| <span class="sourceLineNo">665</span> * Called before Append but after acquiring rowlock.<a name="line.665"></a> |
| <span class="sourceLineNo">666</span> * <p><a name="line.666"></a> |
| <span class="sourceLineNo">667</span> * <b>Note:</b> Caution to be taken for not doing any long time operation in this hook.<a name="line.667"></a> |
| <span class="sourceLineNo">668</span> * Row will be locked for longer time. Trying to acquire lock on another row, within this,<a name="line.668"></a> |
| <span class="sourceLineNo">669</span> * can lead to potential deadlock.<a name="line.669"></a> |
| <span class="sourceLineNo">670</span> * <p><a name="line.670"></a> |
| <span class="sourceLineNo">671</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.671"></a> |
| <span class="sourceLineNo">672</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.672"></a> |
| <span class="sourceLineNo">673</span> * <p><a name="line.673"></a> |
| <span class="sourceLineNo">674</span> * Note: Do not retain references to any Cells in 'append' beyond the life of this invocation.<a name="line.674"></a> |
| <span class="sourceLineNo">675</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.675"></a> |
| <span class="sourceLineNo">676</span> * @param c the environment provided by the region server<a name="line.676"></a> |
| <span class="sourceLineNo">677</span> * @param append Append object<a name="line.677"></a> |
| <span class="sourceLineNo">678</span> * @return result to return to the client if bypassing default processing<a name="line.678"></a> |
| <span class="sourceLineNo">679</span> */<a name="line.679"></a> |
| <span class="sourceLineNo">680</span> default Result preAppendAfterRowLock(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.680"></a> |
| <span class="sourceLineNo">681</span> Append append) throws IOException {<a name="line.681"></a> |
| <span class="sourceLineNo">682</span> return null;<a name="line.682"></a> |
| <span class="sourceLineNo">683</span> }<a name="line.683"></a> |
| <span class="sourceLineNo">684</span><a name="line.684"></a> |
| <span class="sourceLineNo">685</span> /**<a name="line.685"></a> |
| <span class="sourceLineNo">686</span> * Called after Append<a name="line.686"></a> |
| <span class="sourceLineNo">687</span> * <p><a name="line.687"></a> |
| <span class="sourceLineNo">688</span> * Note: Do not retain references to any Cells in 'append' beyond the life of this invocation.<a name="line.688"></a> |
| <span class="sourceLineNo">689</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.689"></a> |
| <span class="sourceLineNo">690</span> * @param c the environment provided by the region server<a name="line.690"></a> |
| <span class="sourceLineNo">691</span> * @param append Append object<a name="line.691"></a> |
| <span class="sourceLineNo">692</span> * @param result the result returned by increment<a name="line.692"></a> |
| <span class="sourceLineNo">693</span> * @return the result to return to the client<a name="line.693"></a> |
| <span class="sourceLineNo">694</span> */<a name="line.694"></a> |
| <span class="sourceLineNo">695</span> default Result postAppend(ObserverContext<RegionCoprocessorEnvironment> c, Append append,<a name="line.695"></a> |
| <span class="sourceLineNo">696</span> Result result) throws IOException {<a name="line.696"></a> |
| <span class="sourceLineNo">697</span> return result;<a name="line.697"></a> |
| <span class="sourceLineNo">698</span> }<a name="line.698"></a> |
| <span class="sourceLineNo">699</span><a name="line.699"></a> |
| <span class="sourceLineNo">700</span> /**<a name="line.700"></a> |
| <span class="sourceLineNo">701</span> * Called before Increment.<a name="line.701"></a> |
| <span class="sourceLineNo">702</span> * <p><a name="line.702"></a> |
| <span class="sourceLineNo">703</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.703"></a> |
| <span class="sourceLineNo">704</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.704"></a> |
| <span class="sourceLineNo">705</span> * <p><a name="line.705"></a> |
| <span class="sourceLineNo">706</span> * Note: Do not retain references to any Cells in 'increment' beyond the life of this invocation.<a name="line.706"></a> |
| <span class="sourceLineNo">707</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.707"></a> |
| <span class="sourceLineNo">708</span> * @param c the environment provided by the region server<a name="line.708"></a> |
| <span class="sourceLineNo">709</span> * @param increment increment object<a name="line.709"></a> |
| <span class="sourceLineNo">710</span> * @return result to return to the client if bypassing default processing<a name="line.710"></a> |
| <span class="sourceLineNo">711</span> */<a name="line.711"></a> |
| <span class="sourceLineNo">712</span> default Result preIncrement(ObserverContext<RegionCoprocessorEnvironment> c, Increment increment)<a name="line.712"></a> |
| <span class="sourceLineNo">713</span> throws IOException {<a name="line.713"></a> |
| <span class="sourceLineNo">714</span> return null;<a name="line.714"></a> |
| <span class="sourceLineNo">715</span> }<a name="line.715"></a> |
| <span class="sourceLineNo">716</span><a name="line.716"></a> |
| <span class="sourceLineNo">717</span> /**<a name="line.717"></a> |
| <span class="sourceLineNo">718</span> * Called before Increment but after acquiring rowlock.<a name="line.718"></a> |
| <span class="sourceLineNo">719</span> * <p><a name="line.719"></a> |
| <span class="sourceLineNo">720</span> * <b>Note:</b> Caution to be taken for not doing any long time operation in this hook.<a name="line.720"></a> |
| <span class="sourceLineNo">721</span> * Row will be locked for longer time. Trying to acquire lock on another row, within this,<a name="line.721"></a> |
| <span class="sourceLineNo">722</span> * can lead to potential deadlock.<a name="line.722"></a> |
| <span class="sourceLineNo">723</span> * <p><a name="line.723"></a> |
| <span class="sourceLineNo">724</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.724"></a> |
| <span class="sourceLineNo">725</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.725"></a> |
| <span class="sourceLineNo">726</span> * <p><a name="line.726"></a> |
| <span class="sourceLineNo">727</span> * Note: Do not retain references to any Cells in 'increment' beyond the life of this invocation.<a name="line.727"></a> |
| <span class="sourceLineNo">728</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.728"></a> |
| <span class="sourceLineNo">729</span> *<a name="line.729"></a> |
| <span class="sourceLineNo">730</span> * @param c<a name="line.730"></a> |
| <span class="sourceLineNo">731</span> * the environment provided by the region server<a name="line.731"></a> |
| <span class="sourceLineNo">732</span> * @param increment<a name="line.732"></a> |
| <span class="sourceLineNo">733</span> * increment object<a name="line.733"></a> |
| <span class="sourceLineNo">734</span> * @return result to return to the client if bypassing default processing<a name="line.734"></a> |
| <span class="sourceLineNo">735</span> * if an error occurred on the coprocessor<a name="line.735"></a> |
| <span class="sourceLineNo">736</span> */<a name="line.736"></a> |
| <span class="sourceLineNo">737</span> default Result preIncrementAfterRowLock(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.737"></a> |
| <span class="sourceLineNo">738</span> Increment increment) throws IOException {<a name="line.738"></a> |
| <span class="sourceLineNo">739</span> return null;<a name="line.739"></a> |
| <span class="sourceLineNo">740</span> }<a name="line.740"></a> |
| <span class="sourceLineNo">741</span><a name="line.741"></a> |
| <span class="sourceLineNo">742</span> /**<a name="line.742"></a> |
| <span class="sourceLineNo">743</span> * Called after increment<a name="line.743"></a> |
| <span class="sourceLineNo">744</span> * <p><a name="line.744"></a> |
| <span class="sourceLineNo">745</span> * Note: Do not retain references to any Cells in 'increment' beyond the life of this invocation.<a name="line.745"></a> |
| <span class="sourceLineNo">746</span> * If need a Cell reference for later use, copy the cell and use that.<a name="line.746"></a> |
| <span class="sourceLineNo">747</span> * @param c the environment provided by the region server<a name="line.747"></a> |
| <span class="sourceLineNo">748</span> * @param increment increment object<a name="line.748"></a> |
| <span class="sourceLineNo">749</span> * @param result the result returned by increment<a name="line.749"></a> |
| <span class="sourceLineNo">750</span> * @return the result to return to the client<a name="line.750"></a> |
| <span class="sourceLineNo">751</span> */<a name="line.751"></a> |
| <span class="sourceLineNo">752</span> default Result postIncrement(ObserverContext<RegionCoprocessorEnvironment> c, Increment increment,<a name="line.752"></a> |
| <span class="sourceLineNo">753</span> Result result) throws IOException {<a name="line.753"></a> |
| <span class="sourceLineNo">754</span> return result;<a name="line.754"></a> |
| <span class="sourceLineNo">755</span> }<a name="line.755"></a> |
| <span class="sourceLineNo">756</span><a name="line.756"></a> |
| <span class="sourceLineNo">757</span> /**<a name="line.757"></a> |
| <span class="sourceLineNo">758</span> * Called before the client opens a new scanner.<a name="line.758"></a> |
| <span class="sourceLineNo">759</span> * <p><a name="line.759"></a> |
| <span class="sourceLineNo">760</span> * Note: Do not retain references to any Cells returned by scanner, beyond the life of this<a name="line.760"></a> |
| <span class="sourceLineNo">761</span> * invocation. If need a Cell reference for later use, copy the cell and use that.<a name="line.761"></a> |
| <span class="sourceLineNo">762</span> * @param c the environment provided by the region server<a name="line.762"></a> |
| <span class="sourceLineNo">763</span> * @param scan the Scan specification<a name="line.763"></a> |
| <span class="sourceLineNo">764</span> */<a name="line.764"></a> |
| <span class="sourceLineNo">765</span> default void preScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Scan scan)<a name="line.765"></a> |
| <span class="sourceLineNo">766</span> throws IOException {<a name="line.766"></a> |
| <span class="sourceLineNo">767</span> }<a name="line.767"></a> |
| <span class="sourceLineNo">768</span><a name="line.768"></a> |
| <span class="sourceLineNo">769</span> /**<a name="line.769"></a> |
| <span class="sourceLineNo">770</span> * Called after the client opens a new scanner.<a name="line.770"></a> |
| <span class="sourceLineNo">771</span> * <p><a name="line.771"></a> |
| <span class="sourceLineNo">772</span> * Note: Do not retain references to any Cells returned by scanner, beyond the life of this<a name="line.772"></a> |
| <span class="sourceLineNo">773</span> * invocation. If need a Cell reference for later use, copy the cell and use that.<a name="line.773"></a> |
| <span class="sourceLineNo">774</span> * @param c the environment provided by the region server<a name="line.774"></a> |
| <span class="sourceLineNo">775</span> * @param scan the Scan specification<a name="line.775"></a> |
| <span class="sourceLineNo">776</span> * @param s if not null, the base scanner<a name="line.776"></a> |
| <span class="sourceLineNo">777</span> * @return the scanner instance to use<a name="line.777"></a> |
| <span class="sourceLineNo">778</span> */<a name="line.778"></a> |
| <span class="sourceLineNo">779</span> default RegionScanner postScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c, Scan scan,<a name="line.779"></a> |
| <span class="sourceLineNo">780</span> RegionScanner s) throws IOException {<a name="line.780"></a> |
| <span class="sourceLineNo">781</span> return s;<a name="line.781"></a> |
| <span class="sourceLineNo">782</span> }<a name="line.782"></a> |
| <span class="sourceLineNo">783</span><a name="line.783"></a> |
| <span class="sourceLineNo">784</span> /**<a name="line.784"></a> |
| <span class="sourceLineNo">785</span> * Called before the client asks for the next row on a scanner.<a name="line.785"></a> |
| <span class="sourceLineNo">786</span> * <p><a name="line.786"></a> |
| <span class="sourceLineNo">787</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.787"></a> |
| <span class="sourceLineNo">788</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.788"></a> |
| <span class="sourceLineNo">789</span> * <p><a name="line.789"></a> |
| <span class="sourceLineNo">790</span> * Note: Do not retain references to any Cells returned by scanner, beyond the life of this<a name="line.790"></a> |
| <span class="sourceLineNo">791</span> * invocation. If need a Cell reference for later use, copy the cell and use that.<a name="line.791"></a> |
| <span class="sourceLineNo">792</span> * @param c the environment provided by the region server<a name="line.792"></a> |
| <span class="sourceLineNo">793</span> * @param s the scanner<a name="line.793"></a> |
| <span class="sourceLineNo">794</span> * @param result The result to return to the client if default processing<a name="line.794"></a> |
| <span class="sourceLineNo">795</span> * is bypassed. Can be modified. Will not be returned if default processing<a name="line.795"></a> |
| <span class="sourceLineNo">796</span> * is not bypassed.<a name="line.796"></a> |
| <span class="sourceLineNo">797</span> * @param limit the maximum number of results to return<a name="line.797"></a> |
| <span class="sourceLineNo">798</span> * @param hasNext the 'has more' indication<a name="line.798"></a> |
| <span class="sourceLineNo">799</span> * @return 'has more' indication that should be sent to client<a name="line.799"></a> |
| <span class="sourceLineNo">800</span> */<a name="line.800"></a> |
| <span class="sourceLineNo">801</span> default boolean preScannerNext(ObserverContext<RegionCoprocessorEnvironment> c, InternalScanner s,<a name="line.801"></a> |
| <span class="sourceLineNo">802</span> List<Result> result, int limit, boolean hasNext) throws IOException {<a name="line.802"></a> |
| <span class="sourceLineNo">803</span> return hasNext;<a name="line.803"></a> |
| <span class="sourceLineNo">804</span> }<a name="line.804"></a> |
| <span class="sourceLineNo">805</span><a name="line.805"></a> |
| <span class="sourceLineNo">806</span> /**<a name="line.806"></a> |
| <span class="sourceLineNo">807</span> * Called after the client asks for the next row on a scanner.<a name="line.807"></a> |
| <span class="sourceLineNo">808</span> * <p><a name="line.808"></a> |
| <span class="sourceLineNo">809</span> * Note: Do not retain references to any Cells returned by scanner, beyond the life of this<a name="line.809"></a> |
| <span class="sourceLineNo">810</span> * invocation. If need a Cell reference for later use, copy the cell and use that.<a name="line.810"></a> |
| <span class="sourceLineNo">811</span> * @param c the environment provided by the region server<a name="line.811"></a> |
| <span class="sourceLineNo">812</span> * @param s the scanner<a name="line.812"></a> |
| <span class="sourceLineNo">813</span> * @param result the result to return to the client, can be modified<a name="line.813"></a> |
| <span class="sourceLineNo">814</span> * @param limit the maximum number of results to return<a name="line.814"></a> |
| <span class="sourceLineNo">815</span> * @param hasNext the 'has more' indication<a name="line.815"></a> |
| <span class="sourceLineNo">816</span> * @return 'has more' indication that should be sent to client<a name="line.816"></a> |
| <span class="sourceLineNo">817</span> */<a name="line.817"></a> |
| <span class="sourceLineNo">818</span> default boolean postScannerNext(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.818"></a> |
| <span class="sourceLineNo">819</span> InternalScanner s, List<Result> result, int limit, boolean hasNext) throws IOException {<a name="line.819"></a> |
| <span class="sourceLineNo">820</span> return hasNext;<a name="line.820"></a> |
| <span class="sourceLineNo">821</span> }<a name="line.821"></a> |
| <span class="sourceLineNo">822</span><a name="line.822"></a> |
| <span class="sourceLineNo">823</span> /**<a name="line.823"></a> |
| <span class="sourceLineNo">824</span> * This will be called by the scan flow when the current scanned row is being filtered out by the<a name="line.824"></a> |
| <span class="sourceLineNo">825</span> * filter. The filter may be filtering out the row via any of the below scenarios<a name="line.825"></a> |
| <span class="sourceLineNo">826</span> * <ol><a name="line.826"></a> |
| <span class="sourceLineNo">827</span> * <li><a name="line.827"></a> |
| <span class="sourceLineNo">828</span> * <code>boolean filterRowKey(byte [] buffer, int offset, int length)</code> returning true</li><a name="line.828"></a> |
| <span class="sourceLineNo">829</span> * <li><a name="line.829"></a> |
| <span class="sourceLineNo">830</span> * <code>boolean filterRow()</code> returning true</li><a name="line.830"></a> |
| <span class="sourceLineNo">831</span> * <li><a name="line.831"></a> |
| <span class="sourceLineNo">832</span> * <code>default void filterRow(List&lt;KeyValue&gt; kvs)</code> removing all the kvs from<a name="line.832"></a> |
| <span class="sourceLineNo">833</span> * the passed List</li><a name="line.833"></a> |
| <span class="sourceLineNo">834</span> * </ol><a name="line.834"></a> |
| <span class="sourceLineNo">835</span> * <p><a name="line.835"></a> |
| <span class="sourceLineNo">836</span> * Note: Do not retain references to any Cells returned by scanner, beyond the life of this<a name="line.836"></a> |
| <span class="sourceLineNo">837</span> * invocation. If need a Cell reference for later use, copy the cell and use that.<a name="line.837"></a> |
| <span class="sourceLineNo">838</span> * @param c the environment provided by the region server<a name="line.838"></a> |
| <span class="sourceLineNo">839</span> * @param s the scanner<a name="line.839"></a> |
| <span class="sourceLineNo">840</span> * @param curRowCell The cell in the current row which got filtered out<a name="line.840"></a> |
| <span class="sourceLineNo">841</span> * @param hasMore the 'has more' indication<a name="line.841"></a> |
| <span class="sourceLineNo">842</span> * @return whether more rows are available for the scanner or not<a name="line.842"></a> |
| <span class="sourceLineNo">843</span> */<a name="line.843"></a> |
| <span class="sourceLineNo">844</span> default boolean postScannerFilterRow(ObserverContext<RegionCoprocessorEnvironment> c,<a name="line.844"></a> |
| <span class="sourceLineNo">845</span> InternalScanner s, Cell curRowCell, boolean hasMore) throws IOException {<a name="line.845"></a> |
| <span class="sourceLineNo">846</span> return hasMore;<a name="line.846"></a> |
| <span class="sourceLineNo">847</span> }<a name="line.847"></a> |
| <span class="sourceLineNo">848</span><a name="line.848"></a> |
| <span class="sourceLineNo">849</span> /**<a name="line.849"></a> |
| <span class="sourceLineNo">850</span> * Called before the client closes a scanner.<a name="line.850"></a> |
| <span class="sourceLineNo">851</span> * <p><a name="line.851"></a> |
| <span class="sourceLineNo">852</span> * Call CoprocessorEnvironment#bypass to skip default actions.<a name="line.852"></a> |
| <span class="sourceLineNo">853</span> * If 'bypass' is set, we skip out on calling any subsequent chained coprocessors.<a name="line.853"></a> |
| <span class="sourceLineNo">854</span> * @param c the environment provided by the region server<a name="line.854"></a> |
| <span class="sourceLineNo">855</span> * @param s the scanner<a name="line.855"></a> |
| <span class="sourceLineNo">856</span> */<a name="line.856"></a> |
| <span class="sourceLineNo">857</span> default void preScannerClose(ObserverContext<RegionCoprocessorEnvironment> c, InternalScanner s)<a name="line.857"></a> |
| <span class="sourceLineNo">858</span> throws IOException {}<a name="line.858"></a> |
| <span class="sourceLineNo">859</span><a name="line.859"></a> |
| <span class="sourceLineNo">860</span> /**<a name="line.860"></a> |
| <span class="sourceLineNo">861</span> * Called after the client closes a scanner.<a name="line.861"></a> |
| <span class="sourceLineNo">862</span> * @param ctx the environment provided by the region server<a name="line.862"></a> |
| <span class="sourceLineNo">863</span> * @param s the scanner<a name="line.863"></a> |
| <span class="sourceLineNo">864</span> */<a name="line.864"></a> |
| <span class="sourceLineNo">865</span> default void postScannerClose(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.865"></a> |
| <span class="sourceLineNo">866</span> InternalScanner s) throws IOException {}<a name="line.866"></a> |
| <span class="sourceLineNo">867</span><a name="line.867"></a> |
| <span class="sourceLineNo">868</span> /**<a name="line.868"></a> |
| <span class="sourceLineNo">869</span> * Called before a store opens a new scanner.<a name="line.869"></a> |
| <span class="sourceLineNo">870</span> * <p><a name="line.870"></a> |
| <span class="sourceLineNo">871</span> * This hook is called when a "user" scanner is opened. Use {@code preFlushScannerOpen} and<a name="line.871"></a> |
| <span class="sourceLineNo">872</span> * {@code preCompactScannerOpen} to inject flush/compaction.<a name="line.872"></a> |
| <span class="sourceLineNo">873</span> * <p><a name="line.873"></a> |
| <span class="sourceLineNo">874</span> * Notice that, this method is used to change the inherent max versions and TTL for a Store. For<a name="line.874"></a> |
| <span class="sourceLineNo">875</span> * example, you can change the max versions option for a {@link Scan} object to 10 in<a name="line.875"></a> |
| <span class="sourceLineNo">876</span> * {@code preScannerOpen}, but if the max versions config on the Store is 1, then you still can<a name="line.876"></a> |
| <span class="sourceLineNo">877</span> * only read 1 version. You need also to inject here to change the max versions to 10 if you want<a name="line.877"></a> |
| <span class="sourceLineNo">878</span> * to get more versions.<a name="line.878"></a> |
| <span class="sourceLineNo">879</span> * @param ctx the environment provided by the region server<a name="line.879"></a> |
| <span class="sourceLineNo">880</span> * @param store the store which we want to get scanner from<a name="line.880"></a> |
| <span class="sourceLineNo">881</span> * @param options used to change max versions and TTL for the scanner being opened<a name="line.881"></a> |
| <span class="sourceLineNo">882</span> * @see #preFlushScannerOpen(ObserverContext, Store, ScanOptions, FlushLifeCycleTracker)<a name="line.882"></a> |
| <span class="sourceLineNo">883</span> * @see #preCompactScannerOpen(ObserverContext, Store, ScanType, ScanOptions,<a name="line.883"></a> |
| <span class="sourceLineNo">884</span> * CompactionLifeCycleTracker, CompactionRequest)<a name="line.884"></a> |
| <span class="sourceLineNo">885</span> */<a name="line.885"></a> |
| <span class="sourceLineNo">886</span> default void preStoreScannerOpen(ObserverContext<RegionCoprocessorEnvironment> ctx, Store store,<a name="line.886"></a> |
| <span class="sourceLineNo">887</span> ScanOptions options) throws IOException {}<a name="line.887"></a> |
| <span class="sourceLineNo">888</span><a name="line.888"></a> |
| <span class="sourceLineNo">889</span> /**<a name="line.889"></a> |
| <span class="sourceLineNo">890</span> * Called before replaying WALs for this region.<a name="line.890"></a> |
| <span class="sourceLineNo">891</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.891"></a> |
| <span class="sourceLineNo">892</span> * effect in this hook.<a name="line.892"></a> |
| <span class="sourceLineNo">893</span> * @param ctx the environment provided by the region server<a name="line.893"></a> |
| <span class="sourceLineNo">894</span> * @param info the RegionInfo for this region<a name="line.894"></a> |
| <span class="sourceLineNo">895</span> * @param edits the file of recovered edits<a name="line.895"></a> |
| <span class="sourceLineNo">896</span> */<a name="line.896"></a> |
| <span class="sourceLineNo">897</span> // todo: what about these?<a name="line.897"></a> |
| <span class="sourceLineNo">898</span> default void preReplayWALs(ObserverContext<? extends RegionCoprocessorEnvironment> ctx,<a name="line.898"></a> |
| <span class="sourceLineNo">899</span> RegionInfo info, Path edits) throws IOException {}<a name="line.899"></a> |
| <span class="sourceLineNo">900</span><a name="line.900"></a> |
| <span class="sourceLineNo">901</span> /**<a name="line.901"></a> |
| <span class="sourceLineNo">902</span> * Called after replaying WALs for this region.<a name="line.902"></a> |
| <span class="sourceLineNo">903</span> * @param ctx the environment provided by the region server<a name="line.903"></a> |
| <span class="sourceLineNo">904</span> * @param info the RegionInfo for this region<a name="line.904"></a> |
| <span class="sourceLineNo">905</span> * @param edits the file of recovered edits<a name="line.905"></a> |
| <span class="sourceLineNo">906</span> */<a name="line.906"></a> |
| <span class="sourceLineNo">907</span> default void postReplayWALs(ObserverContext<? extends RegionCoprocessorEnvironment> ctx,<a name="line.907"></a> |
| <span class="sourceLineNo">908</span> RegionInfo info, Path edits) throws IOException {}<a name="line.908"></a> |
| <span class="sourceLineNo">909</span><a name="line.909"></a> |
| <span class="sourceLineNo">910</span> /**<a name="line.910"></a> |
| <span class="sourceLineNo">911</span> * Called before a {@link WALEdit}<a name="line.911"></a> |
| <span class="sourceLineNo">912</span> * replayed for this region.<a name="line.912"></a> |
| <span class="sourceLineNo">913</span> * @param ctx the environment provided by the region server<a name="line.913"></a> |
| <span class="sourceLineNo">914</span> */<a name="line.914"></a> |
| <span class="sourceLineNo">915</span> default void preWALRestore(ObserverContext<? extends RegionCoprocessorEnvironment> ctx,<a name="line.915"></a> |
| <span class="sourceLineNo">916</span> RegionInfo info, WALKey logKey, WALEdit logEdit) throws IOException {}<a name="line.916"></a> |
| <span class="sourceLineNo">917</span><a name="line.917"></a> |
| <span class="sourceLineNo">918</span> /**<a name="line.918"></a> |
| <span class="sourceLineNo">919</span> * Called after a {@link WALEdit}<a name="line.919"></a> |
| <span class="sourceLineNo">920</span> * replayed for this region.<a name="line.920"></a> |
| <span class="sourceLineNo">921</span> * @param ctx the environment provided by the region server<a name="line.921"></a> |
| <span class="sourceLineNo">922</span> */<a name="line.922"></a> |
| <span class="sourceLineNo">923</span> default void postWALRestore(ObserverContext<? extends RegionCoprocessorEnvironment> ctx,<a name="line.923"></a> |
| <span class="sourceLineNo">924</span> RegionInfo info, WALKey logKey, WALEdit logEdit) throws IOException {}<a name="line.924"></a> |
| <span class="sourceLineNo">925</span><a name="line.925"></a> |
| <span class="sourceLineNo">926</span> /**<a name="line.926"></a> |
| <span class="sourceLineNo">927</span> * Called before bulkLoadHFile. Users can create a StoreFile instance to<a name="line.927"></a> |
| <span class="sourceLineNo">928</span> * access the contents of a HFile.<a name="line.928"></a> |
| <span class="sourceLineNo">929</span> *<a name="line.929"></a> |
| <span class="sourceLineNo">930</span> * @param ctx the environment provided by the region server<a name="line.930"></a> |
| <span class="sourceLineNo">931</span> * @param familyPaths pairs of { CF, HFile path } submitted for bulk load. Adding<a name="line.931"></a> |
| <span class="sourceLineNo">932</span> * or removing from this list will add or remove HFiles to be bulk loaded.<a name="line.932"></a> |
| <span class="sourceLineNo">933</span> */<a name="line.933"></a> |
| <span class="sourceLineNo">934</span> default void preBulkLoadHFile(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.934"></a> |
| <span class="sourceLineNo">935</span> List<Pair<byte[], String>> familyPaths) throws IOException {}<a name="line.935"></a> |
| <span class="sourceLineNo">936</span><a name="line.936"></a> |
| <span class="sourceLineNo">937</span> /**<a name="line.937"></a> |
| <span class="sourceLineNo">938</span> * Called before moving bulk loaded hfile to region directory.<a name="line.938"></a> |
| <span class="sourceLineNo">939</span> *<a name="line.939"></a> |
| <span class="sourceLineNo">940</span> * @param ctx the environment provided by the region server<a name="line.940"></a> |
| <span class="sourceLineNo">941</span> * @param family column family<a name="line.941"></a> |
| <span class="sourceLineNo">942</span> * @param pairs List of pairs of { HFile location in staging dir, HFile path in region dir }<a name="line.942"></a> |
| <span class="sourceLineNo">943</span> * Each pair are for the same hfile.<a name="line.943"></a> |
| <span class="sourceLineNo">944</span> */<a name="line.944"></a> |
| <span class="sourceLineNo">945</span> default void preCommitStoreFile(ObserverContext<RegionCoprocessorEnvironment> ctx, byte[] family,<a name="line.945"></a> |
| <span class="sourceLineNo">946</span> List<Pair<Path, Path>> pairs) throws IOException {}<a name="line.946"></a> |
| <span class="sourceLineNo">947</span><a name="line.947"></a> |
| <span class="sourceLineNo">948</span> /**<a name="line.948"></a> |
| <span class="sourceLineNo">949</span> * Called after moving bulk loaded hfile to region directory.<a name="line.949"></a> |
| <span class="sourceLineNo">950</span> *<a name="line.950"></a> |
| <span class="sourceLineNo">951</span> * @param ctx the environment provided by the region server<a name="line.951"></a> |
| <span class="sourceLineNo">952</span> * @param family column family<a name="line.952"></a> |
| <span class="sourceLineNo">953</span> * @param srcPath Path to file before the move<a name="line.953"></a> |
| <span class="sourceLineNo">954</span> * @param dstPath Path to file after the move<a name="line.954"></a> |
| <span class="sourceLineNo">955</span> */<a name="line.955"></a> |
| <span class="sourceLineNo">956</span> default void postCommitStoreFile(ObserverContext<RegionCoprocessorEnvironment> ctx, byte[] family,<a name="line.956"></a> |
| <span class="sourceLineNo">957</span> Path srcPath, Path dstPath) throws IOException {}<a name="line.957"></a> |
| <span class="sourceLineNo">958</span><a name="line.958"></a> |
| <span class="sourceLineNo">959</span> /**<a name="line.959"></a> |
| <span class="sourceLineNo">960</span> * Called after bulkLoadHFile.<a name="line.960"></a> |
| <span class="sourceLineNo">961</span> *<a name="line.961"></a> |
| <span class="sourceLineNo">962</span> * @param ctx the environment provided by the region server<a name="line.962"></a> |
| <span class="sourceLineNo">963</span> * @param stagingFamilyPaths pairs of { CF, HFile path } submitted for bulk load<a name="line.963"></a> |
| <span class="sourceLineNo">964</span> * @param finalPaths Map of CF to List of file paths for the loaded files<a name="line.964"></a> |
| <span class="sourceLineNo">965</span> * if the Map is not null, the bulkLoad was successful. Otherwise the bulk load failed.<a name="line.965"></a> |
| <span class="sourceLineNo">966</span> * bulkload is done by the time this hook is called.<a name="line.966"></a> |
| <span class="sourceLineNo">967</span> */<a name="line.967"></a> |
| <span class="sourceLineNo">968</span> default void postBulkLoadHFile(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.968"></a> |
| <span class="sourceLineNo">969</span> List<Pair<byte[], String>> stagingFamilyPaths, Map<byte[], List<Path>> finalPaths)<a name="line.969"></a> |
| <span class="sourceLineNo">970</span> throws IOException {<a name="line.970"></a> |
| <span class="sourceLineNo">971</span> }<a name="line.971"></a> |
| <span class="sourceLineNo">972</span><a name="line.972"></a> |
| <span class="sourceLineNo">973</span> /**<a name="line.973"></a> |
| <span class="sourceLineNo">974</span> * Called before creation of Reader for a store file.<a name="line.974"></a> |
| <span class="sourceLineNo">975</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.975"></a> |
| <span class="sourceLineNo">976</span> * effect in this hook.<a name="line.976"></a> |
| <span class="sourceLineNo">977</span> *<a name="line.977"></a> |
| <span class="sourceLineNo">978</span> * @param ctx the environment provided by the region server<a name="line.978"></a> |
| <span class="sourceLineNo">979</span> * @param fs fileystem to read from<a name="line.979"></a> |
| <span class="sourceLineNo">980</span> * @param p path to the file<a name="line.980"></a> |
| <span class="sourceLineNo">981</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.981"></a> |
| <span class="sourceLineNo">982</span> * @param size Full size of the file<a name="line.982"></a> |
| <span class="sourceLineNo">983</span> * @param cacheConf<a name="line.983"></a> |
| <span class="sourceLineNo">984</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.984"></a> |
| <span class="sourceLineNo">985</span> * @param reader the base reader, if not {@code null}, from previous RegionObserver in the chain<a name="line.985"></a> |
| <span class="sourceLineNo">986</span> * @return a Reader instance to use instead of the base reader if overriding<a name="line.986"></a> |
| <span class="sourceLineNo">987</span> * default behavior, null otherwise<a name="line.987"></a> |
| <span class="sourceLineNo">988</span> * @deprecated For Phoenix only, StoreFileReader is not a stable interface.<a name="line.988"></a> |
| <span class="sourceLineNo">989</span> */<a name="line.989"></a> |
| <span class="sourceLineNo">990</span> @Deprecated<a name="line.990"></a> |
| <span class="sourceLineNo">991</span> // Passing InterfaceAudience.Private args FSDataInputStreamWrapper, CacheConfig and Reference.<a name="line.991"></a> |
| <span class="sourceLineNo">992</span> // This is fine as the hook is deprecated any way.<a name="line.992"></a> |
| <span class="sourceLineNo">993</span> default StoreFileReader preStoreFileReaderOpen(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.993"></a> |
| <span class="sourceLineNo">994</span> FileSystem fs, Path p, FSDataInputStreamWrapper in, long size, CacheConfig cacheConf,<a name="line.994"></a> |
| <span class="sourceLineNo">995</span> Reference r, StoreFileReader reader) throws IOException {<a name="line.995"></a> |
| <span class="sourceLineNo">996</span> return reader;<a name="line.996"></a> |
| <span class="sourceLineNo">997</span> }<a name="line.997"></a> |
| <span class="sourceLineNo">998</span><a name="line.998"></a> |
| <span class="sourceLineNo">999</span> /**<a name="line.999"></a> |
| <span class="sourceLineNo">1000</span> * Called after the creation of Reader for a store file.<a name="line.1000"></a> |
| <span class="sourceLineNo">1001</span> *<a name="line.1001"></a> |
| <span class="sourceLineNo">1002</span> * @param ctx the environment provided by the region server<a name="line.1002"></a> |
| <span class="sourceLineNo">1003</span> * @param fs fileystem to read from<a name="line.1003"></a> |
| <span class="sourceLineNo">1004</span> * @param p path to the file<a name="line.1004"></a> |
| <span class="sourceLineNo">1005</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1005"></a> |
| <span class="sourceLineNo">1006</span> * @param size Full size of the file<a name="line.1006"></a> |
| <span class="sourceLineNo">1007</span> * @param cacheConf<a name="line.1007"></a> |
| <span class="sourceLineNo">1008</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1008"></a> |
| <span class="sourceLineNo">1009</span> * @param reader the base reader instance<a name="line.1009"></a> |
| <span class="sourceLineNo">1010</span> * @return The reader to use<a name="line.1010"></a> |
| <span class="sourceLineNo">1011</span> * @deprecated For Phoenix only, StoreFileReader is not a stable interface.<a name="line.1011"></a> |
| <span class="sourceLineNo">1012</span> */<a name="line.1012"></a> |
| <span class="sourceLineNo">1013</span> @Deprecated<a name="line.1013"></a> |
| <span class="sourceLineNo">1014</span> // Passing InterfaceAudience.Private args FSDataInputStreamWrapper, CacheConfig and Reference.<a name="line.1014"></a> |
| <span class="sourceLineNo">1015</span> // This is fine as the hook is deprecated any way.<a name="line.1015"></a> |
| <span class="sourceLineNo">1016</span> default StoreFileReader postStoreFileReaderOpen(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1016"></a> |
| <span class="sourceLineNo">1017</span> FileSystem fs, Path p, FSDataInputStreamWrapper in, long size, CacheConfig cacheConf,<a name="line.1017"></a> |
| <span class="sourceLineNo">1018</span> Reference r, StoreFileReader reader) throws IOException {<a name="line.1018"></a> |
| <span class="sourceLineNo">1019</span> return reader;<a name="line.1019"></a> |
| <span class="sourceLineNo">1020</span> }<a name="line.1020"></a> |
| <span class="sourceLineNo">1021</span><a name="line.1021"></a> |
| <span class="sourceLineNo">1022</span> /**<a name="line.1022"></a> |
| <span class="sourceLineNo">1023</span> * Called after a new cell has been created during an increment operation, but before<a name="line.1023"></a> |
| <span class="sourceLineNo">1024</span> * it is committed to the WAL or memstore.<a name="line.1024"></a> |
| <span class="sourceLineNo">1025</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1025"></a> |
| <span class="sourceLineNo">1026</span> * effect in this hook.<a name="line.1026"></a> |
| <span class="sourceLineNo">1027</span> * @param ctx the environment provided by the region server<a name="line.1027"></a> |
| <span class="sourceLineNo">1028</span> * @param opType the operation type<a name="line.1028"></a> |
| <span class="sourceLineNo">1029</span> * @param mutation the current mutation<a name="line.1029"></a> |
| <span class="sourceLineNo">1030</span> * @param oldCell old cell containing previous value<a name="line.1030"></a> |
| <span class="sourceLineNo">1031</span> * @param newCell the new cell containing the computed value<a name="line.1031"></a> |
| <span class="sourceLineNo">1032</span> * @return the new cell, possibly changed<a name="line.1032"></a> |
| <span class="sourceLineNo">1033</span> * @deprecated since 2.2.0 and will be removedin 4.0.0. Use<a name="line.1033"></a> |
| <span class="sourceLineNo">1034</span> * {@link #postIncrementBeforeWAL(ObserverContext, Mutation, List)} or<a name="line.1034"></a> |
| <span class="sourceLineNo">1035</span> * {@link #postAppendBeforeWAL(ObserverContext, Mutation, List)} instead.<a name="line.1035"></a> |
| <span class="sourceLineNo">1036</span> * @see #postIncrementBeforeWAL(ObserverContext, Mutation, List)<a name="line.1036"></a> |
| <span class="sourceLineNo">1037</span> * @see #postAppendBeforeWAL(ObserverContext, Mutation, List)<a name="line.1037"></a> |
| <span class="sourceLineNo">1038</span> * @see <a href="https://issues.apache.org/jira/browse/HBASE-21643">HBASE-21643</a><a name="line.1038"></a> |
| <span class="sourceLineNo">1039</span> */<a name="line.1039"></a> |
| <span class="sourceLineNo">1040</span> @Deprecated<a name="line.1040"></a> |
| <span class="sourceLineNo">1041</span> default Cell postMutationBeforeWAL(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1041"></a> |
| <span class="sourceLineNo">1042</span> MutationType opType, Mutation mutation, Cell oldCell, Cell newCell) throws IOException {<a name="line.1042"></a> |
| <span class="sourceLineNo">1043</span> return newCell;<a name="line.1043"></a> |
| <span class="sourceLineNo">1044</span> }<a name="line.1044"></a> |
| <span class="sourceLineNo">1045</span><a name="line.1045"></a> |
| <span class="sourceLineNo">1046</span> /**<a name="line.1046"></a> |
| <span class="sourceLineNo">1047</span> * Called after a list of new cells has been created during an increment operation, but before<a name="line.1047"></a> |
| <span class="sourceLineNo">1048</span> * they are committed to the WAL or memstore.<a name="line.1048"></a> |
| <span class="sourceLineNo">1049</span> *<a name="line.1049"></a> |
| <span class="sourceLineNo">1050</span> * @param ctx the environment provided by the region server<a name="line.1050"></a> |
| <span class="sourceLineNo">1051</span> * @param mutation the current mutation<a name="line.1051"></a> |
| <span class="sourceLineNo">1052</span> * @param cellPairs a list of cell pair. The first cell is old cell which may be null.<a name="line.1052"></a> |
| <span class="sourceLineNo">1053</span> * And the second cell is the new cell.<a name="line.1053"></a> |
| <span class="sourceLineNo">1054</span> * @return a list of cell pair, possibly changed.<a name="line.1054"></a> |
| <span class="sourceLineNo">1055</span> */<a name="line.1055"></a> |
| <span class="sourceLineNo">1056</span> default List<Pair<Cell, Cell>> postIncrementBeforeWAL(<a name="line.1056"></a> |
| <span class="sourceLineNo">1057</span> ObserverContext<RegionCoprocessorEnvironment> ctx, Mutation mutation,<a name="line.1057"></a> |
| <span class="sourceLineNo">1058</span> List<Pair<Cell, Cell>> cellPairs) throws IOException {<a name="line.1058"></a> |
| <span class="sourceLineNo">1059</span> List<Pair<Cell, Cell>> resultPairs = new ArrayList<>(cellPairs.size());<a name="line.1059"></a> |
| <span class="sourceLineNo">1060</span> for (Pair<Cell, Cell> pair : cellPairs) {<a name="line.1060"></a> |
| <span class="sourceLineNo">1061</span> resultPairs.add(new Pair<>(pair.getFirst(),<a name="line.1061"></a> |
| <span class="sourceLineNo">1062</span> postMutationBeforeWAL(ctx, MutationType.INCREMENT, mutation, pair.getFirst(),<a name="line.1062"></a> |
| <span class="sourceLineNo">1063</span> pair.getSecond())));<a name="line.1063"></a> |
| <span class="sourceLineNo">1064</span> }<a name="line.1064"></a> |
| <span class="sourceLineNo">1065</span> return resultPairs;<a name="line.1065"></a> |
| <span class="sourceLineNo">1066</span> }<a name="line.1066"></a> |
| <span class="sourceLineNo">1067</span><a name="line.1067"></a> |
| <span class="sourceLineNo">1068</span> /**<a name="line.1068"></a> |
| <span class="sourceLineNo">1069</span> * Called after a list of new cells has been created during an append operation, but before<a name="line.1069"></a> |
| <span class="sourceLineNo">1070</span> * they are committed to the WAL or memstore.<a name="line.1070"></a> |
| <span class="sourceLineNo">1071</span> *<a name="line.1071"></a> |
| <span class="sourceLineNo">1072</span> * @param ctx the environment provided by the region server<a name="line.1072"></a> |
| <span class="sourceLineNo">1073</span> * @param mutation the current mutation<a name="line.1073"></a> |
| <span class="sourceLineNo">1074</span> * @param cellPairs a list of cell pair. The first cell is old cell which may be null.<a name="line.1074"></a> |
| <span class="sourceLineNo">1075</span> * And the second cell is the new cell.<a name="line.1075"></a> |
| <span class="sourceLineNo">1076</span> * @return a list of cell pair, possibly changed.<a name="line.1076"></a> |
| <span class="sourceLineNo">1077</span> */<a name="line.1077"></a> |
| <span class="sourceLineNo">1078</span> default List<Pair<Cell, Cell>> postAppendBeforeWAL(<a name="line.1078"></a> |
| <span class="sourceLineNo">1079</span> ObserverContext<RegionCoprocessorEnvironment> ctx, Mutation mutation,<a name="line.1079"></a> |
| <span class="sourceLineNo">1080</span> List<Pair<Cell, Cell>> cellPairs) throws IOException {<a name="line.1080"></a> |
| <span class="sourceLineNo">1081</span> List<Pair<Cell, Cell>> resultPairs = new ArrayList<>(cellPairs.size());<a name="line.1081"></a> |
| <span class="sourceLineNo">1082</span> for (Pair<Cell, Cell> pair : cellPairs) {<a name="line.1082"></a> |
| <span class="sourceLineNo">1083</span> resultPairs.add(new Pair<>(pair.getFirst(),<a name="line.1083"></a> |
| <span class="sourceLineNo">1084</span> postMutationBeforeWAL(ctx, MutationType.INCREMENT, mutation, pair.getFirst(),<a name="line.1084"></a> |
| <span class="sourceLineNo">1085</span> pair.getSecond())));<a name="line.1085"></a> |
| <span class="sourceLineNo">1086</span> }<a name="line.1086"></a> |
| <span class="sourceLineNo">1087</span> return resultPairs;<a name="line.1087"></a> |
| <span class="sourceLineNo">1088</span> }<a name="line.1088"></a> |
| <span class="sourceLineNo">1089</span><a name="line.1089"></a> |
| <span class="sourceLineNo">1090</span> /**<a name="line.1090"></a> |
| <span class="sourceLineNo">1091</span> * Called after the ScanQueryMatcher creates ScanDeleteTracker. Implementing<a name="line.1091"></a> |
| <span class="sourceLineNo">1092</span> * this hook would help in creating customised DeleteTracker and returning<a name="line.1092"></a> |
| <span class="sourceLineNo">1093</span> * the newly created DeleteTracker<a name="line.1093"></a> |
| <span class="sourceLineNo">1094</span> * <p><a name="line.1094"></a> |
| <span class="sourceLineNo">1095</span> * Warn: This is used by internal coprocessors. Should not be implemented by user coprocessors<a name="line.1095"></a> |
| <span class="sourceLineNo">1096</span> * @param ctx the environment provided by the region server<a name="line.1096"></a> |
| <span class="sourceLineNo">1097</span> * @param delTracker the deleteTracker that is created by the QueryMatcher<a name="line.1097"></a> |
| <span class="sourceLineNo">1098</span> * @return the Delete Tracker<a name="line.1098"></a> |
| <span class="sourceLineNo">1099</span> * @deprecated Since 2.0 with out any replacement and will be removed in 3.0<a name="line.1099"></a> |
| <span class="sourceLineNo">1100</span> */<a name="line.1100"></a> |
| <span class="sourceLineNo">1101</span> @Deprecated<a name="line.1101"></a> |
| <span class="sourceLineNo">1102</span> default DeleteTracker postInstantiateDeleteTracker(<a name="line.1102"></a> |
| <span class="sourceLineNo">1103</span> ObserverContext<RegionCoprocessorEnvironment> ctx, DeleteTracker delTracker)<a name="line.1103"></a> |
| <span class="sourceLineNo">1104</span> throws IOException {<a name="line.1104"></a> |
| <span class="sourceLineNo">1105</span> return delTracker;<a name="line.1105"></a> |
| <span class="sourceLineNo">1106</span> }<a name="line.1106"></a> |
| <span class="sourceLineNo">1107</span><a name="line.1107"></a> |
| <span class="sourceLineNo">1108</span> /**<a name="line.1108"></a> |
| <span class="sourceLineNo">1109</span> * Called just before the WAL Entry is appended to the WAL. Implementing this hook allows<a name="line.1109"></a> |
| <span class="sourceLineNo">1110</span> * coprocessors to add extended attributes to the WALKey that then get persisted to the<a name="line.1110"></a> |
| <span class="sourceLineNo">1111</span> * WAL, and are available to replication endpoints to use in processing WAL Entries.<a name="line.1111"></a> |
| <span class="sourceLineNo">1112</span> * @param ctx the environment provided by the region server<a name="line.1112"></a> |
| <span class="sourceLineNo">1113</span> * @param key the WALKey associated with a particular append to a WAL<a name="line.1113"></a> |
| <span class="sourceLineNo">1114</span> */<a name="line.1114"></a> |
| <span class="sourceLineNo">1115</span> default void preWALAppend(ObserverContext<RegionCoprocessorEnvironment> ctx, WALKey key,<a name="line.1115"></a> |
| <span class="sourceLineNo">1116</span> WALEdit edit)<a name="line.1116"></a> |
| <span class="sourceLineNo">1117</span> throws IOException {<a name="line.1117"></a> |
| <span class="sourceLineNo">1118</span> }<a name="line.1118"></a> |
| <span class="sourceLineNo">1119</span>}<a name="line.1119"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
