http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html index 59c2836..c804d26 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.ScanResumer.html @@ -103,38 +103,45 @@ <span class="sourceLineNo">095</span> void onNext(Result[] results, ScanController controller);<a name="line.95"></a> <span class="sourceLineNo">096</span><a name="line.96"></a> <span class="sourceLineNo">097</span> /**<a name="line.97"></a> -<span class="sourceLineNo">098</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> -<span class="sourceLineNo">099</span> * onNext.<a name="line.99"></a> +<span class="sourceLineNo">098</span> * Indicate that there is a heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> +<span class="sourceLineNo">099</span> * {@link #onNext(Result[], ScanController)}.<a name="line.99"></a> <span class="sourceLineNo">100</span> * <p><a name="line.100"></a> -<span class="sourceLineNo">101</span> * This method give you a chance to terminate a slow scan operation.<a name="line.101"></a> -<span class="sourceLineNo">102</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.102"></a> -<span class="sourceLineNo">103</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.103"></a> -<span class="sourceLineNo">104</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> default void onHeartbeat(ScanController controller) {<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> /**<a name="line.109"></a> -<span class="sourceLineNo">110</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.110"></a> -<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> -<span class="sourceLineNo">112</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> void onError(Throwable error);<a name="line.114"></a> +<span class="sourceLineNo">101</span> * Note that this method will always be called when RS returns something to us but we do not have<a name="line.101"></a> +<span class="sourceLineNo">102</span> * enough cells to call {@link #onNext(Result[], ScanController)}. Sometimes it may not be a<a name="line.102"></a> +<span class="sourceLineNo">103</span> * 'heartbeat' message for RS, for example, we have a large row with many cells and size limit is<a name="line.103"></a> +<span class="sourceLineNo">104</span> * exceeded before sending all the cells for this row. For RS it does send some data to us and the<a name="line.104"></a> +<span class="sourceLineNo">105</span> * time limit has not been reached, but we can not return the data to client so here we call this<a name="line.105"></a> +<span class="sourceLineNo">106</span> * method to tell client we have already received something.<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <p><a name="line.107"></a> +<span class="sourceLineNo">108</span> * This method give you a chance to terminate a slow scan operation.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.109"></a> +<span class="sourceLineNo">110</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.110"></a> +<span class="sourceLineNo">111</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> default void onHeartbeat(ScanController controller) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> <span class="sourceLineNo">115</span><a name="line.115"></a> <span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Indicate that the scan operation is completed normally.<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> void onComplete();<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> /**<a name="line.121"></a> -<span class="sourceLineNo">122</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.122"></a> -<span class="sourceLineNo">123</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.123"></a> -<span class="sourceLineNo">124</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.124"></a> -<span class="sourceLineNo">125</span> * store it somewhere to get the metrics at any time if you want.<a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.127"></a> -<span class="sourceLineNo">128</span> }<a name="line.128"></a> -<span class="sourceLineNo">129</span>}<a name="line.129"></a> +<span class="sourceLineNo">117</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * <p><a name="line.118"></a> +<span class="sourceLineNo">119</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> void onError(Throwable error);<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> /**<a name="line.123"></a> +<span class="sourceLineNo">124</span> * Indicate that the scan operation is completed normally.<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> void onComplete();<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> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.129"></a> +<span class="sourceLineNo">130</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.130"></a> +<span class="sourceLineNo">131</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.131"></a> +<span class="sourceLineNo">132</span> * store it somewhere to get the metrics at any time if you want.<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> }<a name="line.135"></a> +<span class="sourceLineNo">136</span>}<a name="line.136"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html index 59c2836..c804d26 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/RawScanResultConsumer.html @@ -103,38 +103,45 @@ <span class="sourceLineNo">095</span> void onNext(Result[] results, ScanController controller);<a name="line.95"></a> <span class="sourceLineNo">096</span><a name="line.96"></a> <span class="sourceLineNo">097</span> /**<a name="line.97"></a> -<span class="sourceLineNo">098</span> * Indicate that there is an heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> -<span class="sourceLineNo">099</span> * onNext.<a name="line.99"></a> +<span class="sourceLineNo">098</span> * Indicate that there is a heartbeat message but we have not cumulated enough cells to call<a name="line.98"></a> +<span class="sourceLineNo">099</span> * {@link #onNext(Result[], ScanController)}.<a name="line.99"></a> <span class="sourceLineNo">100</span> * <p><a name="line.100"></a> -<span class="sourceLineNo">101</span> * This method give you a chance to terminate a slow scan operation.<a name="line.101"></a> -<span class="sourceLineNo">102</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.102"></a> -<span class="sourceLineNo">103</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.103"></a> -<span class="sourceLineNo">104</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.104"></a> -<span class="sourceLineNo">105</span> */<a name="line.105"></a> -<span class="sourceLineNo">106</span> default void onHeartbeat(ScanController controller) {<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> /**<a name="line.109"></a> -<span class="sourceLineNo">110</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.110"></a> -<span class="sourceLineNo">111</span> * <p><a name="line.111"></a> -<span class="sourceLineNo">112</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.112"></a> -<span class="sourceLineNo">113</span> */<a name="line.113"></a> -<span class="sourceLineNo">114</span> void onError(Throwable error);<a name="line.114"></a> +<span class="sourceLineNo">101</span> * Note that this method will always be called when RS returns something to us but we do not have<a name="line.101"></a> +<span class="sourceLineNo">102</span> * enough cells to call {@link #onNext(Result[], ScanController)}. Sometimes it may not be a<a name="line.102"></a> +<span class="sourceLineNo">103</span> * 'heartbeat' message for RS, for example, we have a large row with many cells and size limit is<a name="line.103"></a> +<span class="sourceLineNo">104</span> * exceeded before sending all the cells for this row. For RS it does send some data to us and the<a name="line.104"></a> +<span class="sourceLineNo">105</span> * time limit has not been reached, but we can not return the data to client so here we call this<a name="line.105"></a> +<span class="sourceLineNo">106</span> * method to tell client we have already received something.<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <p><a name="line.107"></a> +<span class="sourceLineNo">108</span> * This method give you a chance to terminate a slow scan operation.<a name="line.108"></a> +<span class="sourceLineNo">109</span> * @param controller used to suspend or terminate the scan. Notice that the {@code controller}<a name="line.109"></a> +<span class="sourceLineNo">110</span> * instance is only valid within the scope of onHeartbeat method. You can only call its<a name="line.110"></a> +<span class="sourceLineNo">111</span> * method in onHeartbeat, do NOT store it and call it later outside onHeartbeat.<a name="line.111"></a> +<span class="sourceLineNo">112</span> */<a name="line.112"></a> +<span class="sourceLineNo">113</span> default void onHeartbeat(ScanController controller) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> <span class="sourceLineNo">115</span><a name="line.115"></a> <span class="sourceLineNo">116</span> /**<a name="line.116"></a> -<span class="sourceLineNo">117</span> * Indicate that the scan operation is completed normally.<a name="line.117"></a> -<span class="sourceLineNo">118</span> */<a name="line.118"></a> -<span class="sourceLineNo">119</span> void onComplete();<a name="line.119"></a> -<span class="sourceLineNo">120</span><a name="line.120"></a> -<span class="sourceLineNo">121</span> /**<a name="line.121"></a> -<span class="sourceLineNo">122</span> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.122"></a> -<span class="sourceLineNo">123</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.123"></a> -<span class="sourceLineNo">124</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.124"></a> -<span class="sourceLineNo">125</span> * store it somewhere to get the metrics at any time if you want.<a name="line.125"></a> -<span class="sourceLineNo">126</span> */<a name="line.126"></a> -<span class="sourceLineNo">127</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.127"></a> -<span class="sourceLineNo">128</span> }<a name="line.128"></a> -<span class="sourceLineNo">129</span>}<a name="line.129"></a> +<span class="sourceLineNo">117</span> * Indicate that we hit an unrecoverable error and the scan operation is terminated.<a name="line.117"></a> +<span class="sourceLineNo">118</span> * <p><a name="line.118"></a> +<span class="sourceLineNo">119</span> * We will not call {@link #onComplete()} after calling {@link #onError(Throwable)}.<a name="line.119"></a> +<span class="sourceLineNo">120</span> */<a name="line.120"></a> +<span class="sourceLineNo">121</span> void onError(Throwable error);<a name="line.121"></a> +<span class="sourceLineNo">122</span><a name="line.122"></a> +<span class="sourceLineNo">123</span> /**<a name="line.123"></a> +<span class="sourceLineNo">124</span> * Indicate that the scan operation is completed normally.<a name="line.124"></a> +<span class="sourceLineNo">125</span> */<a name="line.125"></a> +<span class="sourceLineNo">126</span> void onComplete();<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> * If {@code scan.isScanMetricsEnabled()} returns true, then this method will be called prior to<a name="line.129"></a> +<span class="sourceLineNo">130</span> * all other methods in this interface to give you the {@link ScanMetrics} instance for this scan<a name="line.130"></a> +<span class="sourceLineNo">131</span> * operation. The {@link ScanMetrics} instance will be updated on-the-fly during the scan, you can<a name="line.131"></a> +<span class="sourceLineNo">132</span> * store it somewhere to get the metrics at any time if you want.<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> default void onScanMetricsCreated(ScanMetrics scanMetrics) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> }<a name="line.135"></a> +<span class="sourceLineNo">136</span>}<a name="line.136"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/devapidocs/src-html/org/apache/hadoop/hbase/client/metrics/ServerSideScanMetrics.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/client/metrics/ServerSideScanMetrics.html b/devapidocs/src-html/org/apache/hadoop/hbase/client/metrics/ServerSideScanMetrics.html index efb6c84..5b9c2a7 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/client/metrics/ServerSideScanMetrics.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/client/metrics/ServerSideScanMetrics.html @@ -57,85 +57,96 @@ <span class="sourceLineNo">049</span> public static final String COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME = "ROWS_SCANNED";<a name="line.49"></a> <span class="sourceLineNo">050</span> public static final String COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME = "ROWS_FILTERED";<a name="line.50"></a> <span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> /** @deprecated Use {@link #COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME} instead */<a name="line.52"></a> -<span class="sourceLineNo">053</span> public static final String COUNT_OF_ROWS_SCANNED_KEY = COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME;<a name="line.53"></a> -<span class="sourceLineNo">054</span> /** @deprecated Use {@link #COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME} instead */<a name="line.54"></a> -<span class="sourceLineNo">055</span> public static final String COUNT_OF_ROWS_FILTERED_KEY = COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME;<a name="line.55"></a> -<span class="sourceLineNo">056</span><a name="line.56"></a> -<span class="sourceLineNo">057</span> /**<a name="line.57"></a> -<span class="sourceLineNo">058</span> * number of rows filtered during scan RPC<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> public final AtomicLong countOfRowsFiltered = createCounter(COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME);<a name="line.60"></a> -<span class="sourceLineNo">061</span><a name="line.61"></a> -<span class="sourceLineNo">062</span> /**<a name="line.62"></a> -<span class="sourceLineNo">063</span> * number of rows scanned during scan RPC. Not every row scanned will be returned to the client<a name="line.63"></a> -<span class="sourceLineNo">064</span> * since rows may be filtered.<a name="line.64"></a> -<span class="sourceLineNo">065</span> */<a name="line.65"></a> -<span class="sourceLineNo">066</span> public final AtomicLong countOfRowsScanned = createCounter(COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME);<a name="line.66"></a> +<span class="sourceLineNo">052</span> /**<a name="line.52"></a> +<span class="sourceLineNo">053</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0<a name="line.53"></a> +<span class="sourceLineNo">054</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-17886">HBASE-17886</a>).<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Use {@link #COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME}.<a name="line.55"></a> +<span class="sourceLineNo">056</span> */<a name="line.56"></a> +<span class="sourceLineNo">057</span> @Deprecated<a name="line.57"></a> +<span class="sourceLineNo">058</span> public static final String COUNT_OF_ROWS_SCANNED_KEY = COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME;<a name="line.58"></a> +<span class="sourceLineNo">059</span><a name="line.59"></a> +<span class="sourceLineNo">060</span> /**<a name="line.60"></a> +<span class="sourceLineNo">061</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0<a name="line.61"></a> +<span class="sourceLineNo">062</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-17886">HBASE-17886</a>).<a name="line.62"></a> +<span class="sourceLineNo">063</span> * Use {@link #COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME}.<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> @Deprecated<a name="line.65"></a> +<span class="sourceLineNo">066</span> public static final String COUNT_OF_ROWS_FILTERED_KEY = COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME;<a name="line.66"></a> <span class="sourceLineNo">067</span><a name="line.67"></a> <span class="sourceLineNo">068</span> /**<a name="line.68"></a> -<span class="sourceLineNo">069</span> * @param counterName<a name="line.69"></a> -<span class="sourceLineNo">070</span> * @param value<a name="line.70"></a> -<span class="sourceLineNo">071</span> */<a name="line.71"></a> -<span class="sourceLineNo">072</span> public void setCounter(String counterName, long value) {<a name="line.72"></a> -<span class="sourceLineNo">073</span> AtomicLong c = this.counters.get(counterName);<a name="line.73"></a> -<span class="sourceLineNo">074</span> if (c != null) {<a name="line.74"></a> -<span class="sourceLineNo">075</span> c.set(value);<a name="line.75"></a> -<span class="sourceLineNo">076</span> }<a name="line.76"></a> -<span class="sourceLineNo">077</span> }<a name="line.77"></a> +<span class="sourceLineNo">069</span> * number of rows filtered during scan RPC<a name="line.69"></a> +<span class="sourceLineNo">070</span> */<a name="line.70"></a> +<span class="sourceLineNo">071</span> public final AtomicLong countOfRowsFiltered = createCounter(COUNT_OF_ROWS_FILTERED_KEY_METRIC_NAME);<a name="line.71"></a> +<span class="sourceLineNo">072</span><a name="line.72"></a> +<span class="sourceLineNo">073</span> /**<a name="line.73"></a> +<span class="sourceLineNo">074</span> * number of rows scanned during scan RPC. Not every row scanned will be returned to the client<a name="line.74"></a> +<span class="sourceLineNo">075</span> * since rows may be filtered.<a name="line.75"></a> +<span class="sourceLineNo">076</span> */<a name="line.76"></a> +<span class="sourceLineNo">077</span> public final AtomicLong countOfRowsScanned = createCounter(COUNT_OF_ROWS_SCANNED_KEY_METRIC_NAME);<a name="line.77"></a> <span class="sourceLineNo">078</span><a name="line.78"></a> <span class="sourceLineNo">079</span> /**<a name="line.79"></a> <span class="sourceLineNo">080</span> * @param counterName<a name="line.80"></a> -<span class="sourceLineNo">081</span> * @return true if a counter exists with the counterName<a name="line.81"></a> +<span class="sourceLineNo">081</span> * @param value<a name="line.81"></a> <span class="sourceLineNo">082</span> */<a name="line.82"></a> -<span class="sourceLineNo">083</span> public boolean hasCounter(String counterName) {<a name="line.83"></a> -<span class="sourceLineNo">084</span> return this.counters.containsKey(counterName);<a name="line.84"></a> -<span class="sourceLineNo">085</span> }<a name="line.85"></a> -<span class="sourceLineNo">086</span><a name="line.86"></a> -<span class="sourceLineNo">087</span> /**<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param counterName<a name="line.88"></a> -<span class="sourceLineNo">089</span> * @return {@link AtomicLong} instance for this counter name, null if counter does not exist.<a name="line.89"></a> -<span class="sourceLineNo">090</span> */<a name="line.90"></a> -<span class="sourceLineNo">091</span> public AtomicLong getCounter(String counterName) {<a name="line.91"></a> -<span class="sourceLineNo">092</span> return this.counters.get(counterName);<a name="line.92"></a> -<span class="sourceLineNo">093</span> }<a name="line.93"></a> -<span class="sourceLineNo">094</span><a name="line.94"></a> -<span class="sourceLineNo">095</span> /**<a name="line.95"></a> -<span class="sourceLineNo">096</span> * @param counterName<a name="line.96"></a> -<span class="sourceLineNo">097</span> * @param delta<a name="line.97"></a> -<span class="sourceLineNo">098</span> */<a name="line.98"></a> -<span class="sourceLineNo">099</span> public void addToCounter(String counterName, long delta) {<a name="line.99"></a> -<span class="sourceLineNo">100</span> AtomicLong c = this.counters.get(counterName);<a name="line.100"></a> -<span class="sourceLineNo">101</span> if (c != null) {<a name="line.101"></a> -<span class="sourceLineNo">102</span> c.addAndGet(delta);<a name="line.102"></a> -<span class="sourceLineNo">103</span> }<a name="line.103"></a> +<span class="sourceLineNo">083</span> public void setCounter(String counterName, long value) {<a name="line.83"></a> +<span class="sourceLineNo">084</span> AtomicLong c = this.counters.get(counterName);<a name="line.84"></a> +<span class="sourceLineNo">085</span> if (c != null) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> c.set(value);<a name="line.86"></a> +<span class="sourceLineNo">087</span> }<a name="line.87"></a> +<span class="sourceLineNo">088</span> }<a name="line.88"></a> +<span class="sourceLineNo">089</span><a name="line.89"></a> +<span class="sourceLineNo">090</span> /**<a name="line.90"></a> +<span class="sourceLineNo">091</span> * @param counterName<a name="line.91"></a> +<span class="sourceLineNo">092</span> * @return true if a counter exists with the counterName<a name="line.92"></a> +<span class="sourceLineNo">093</span> */<a name="line.93"></a> +<span class="sourceLineNo">094</span> public boolean hasCounter(String counterName) {<a name="line.94"></a> +<span class="sourceLineNo">095</span> return this.counters.containsKey(counterName);<a name="line.95"></a> +<span class="sourceLineNo">096</span> }<a name="line.96"></a> +<span class="sourceLineNo">097</span><a name="line.97"></a> +<span class="sourceLineNo">098</span> /**<a name="line.98"></a> +<span class="sourceLineNo">099</span> * @param counterName<a name="line.99"></a> +<span class="sourceLineNo">100</span> * @return {@link AtomicLong} instance for this counter name, null if counter does not exist.<a name="line.100"></a> +<span class="sourceLineNo">101</span> */<a name="line.101"></a> +<span class="sourceLineNo">102</span> public AtomicLong getCounter(String counterName) {<a name="line.102"></a> +<span class="sourceLineNo">103</span> return this.counters.get(counterName);<a name="line.103"></a> <span class="sourceLineNo">104</span> }<a name="line.104"></a> <span class="sourceLineNo">105</span><a name="line.105"></a> <span class="sourceLineNo">106</span> /**<a name="line.106"></a> -<span class="sourceLineNo">107</span> * Get all of the values since the last time this function was called. Calling this function will<a name="line.107"></a> -<span class="sourceLineNo">108</span> * reset all AtomicLongs in the instance back to 0.<a name="line.108"></a> -<span class="sourceLineNo">109</span> * @return A Map of String -&gt; Long for metrics<a name="line.109"></a> -<span class="sourceLineNo">110</span> */<a name="line.110"></a> -<span class="sourceLineNo">111</span> public Map<String, Long> getMetricsMap() {<a name="line.111"></a> -<span class="sourceLineNo">112</span> return getMetricsMap(true);<a name="line.112"></a> -<span class="sourceLineNo">113</span> }<a name="line.113"></a> -<span class="sourceLineNo">114</span><a name="line.114"></a> -<span class="sourceLineNo">115</span> /**<a name="line.115"></a> -<span class="sourceLineNo">116</span> * Get all of the values. If reset is true, we will reset the all AtomicLongs back to 0.<a name="line.116"></a> -<span class="sourceLineNo">117</span> * @param reset whether to reset the AtomicLongs to 0.<a name="line.117"></a> -<span class="sourceLineNo">118</span> * @return A Map of String -&gt; Long for metrics<a name="line.118"></a> -<span class="sourceLineNo">119</span> */<a name="line.119"></a> -<span class="sourceLineNo">120</span> public Map<String, Long> getMetricsMap(boolean reset) {<a name="line.120"></a> -<span class="sourceLineNo">121</span> // Create a builder<a name="line.121"></a> -<span class="sourceLineNo">122</span> ImmutableMap.Builder<String, Long> builder = ImmutableMap.builder();<a name="line.122"></a> -<span class="sourceLineNo">123</span> for (Map.Entry<String, AtomicLong> e : this.counters.entrySet()) {<a name="line.123"></a> -<span class="sourceLineNo">124</span> long value = reset ? e.getValue().getAndSet(0) : e.getValue().get();<a name="line.124"></a> -<span class="sourceLineNo">125</span> builder.put(e.getKey(), value);<a name="line.125"></a> -<span class="sourceLineNo">126</span> }<a name="line.126"></a> -<span class="sourceLineNo">127</span> // Build the immutable map so that people can't mess around with it.<a name="line.127"></a> -<span class="sourceLineNo">128</span> return builder.build();<a name="line.128"></a> -<span class="sourceLineNo">129</span> }<a name="line.129"></a> -<span class="sourceLineNo">130</span>}<a name="line.130"></a> +<span class="sourceLineNo">107</span> * @param counterName<a name="line.107"></a> +<span class="sourceLineNo">108</span> * @param delta<a name="line.108"></a> +<span class="sourceLineNo">109</span> */<a name="line.109"></a> +<span class="sourceLineNo">110</span> public void addToCounter(String counterName, long delta) {<a name="line.110"></a> +<span class="sourceLineNo">111</span> AtomicLong c = this.counters.get(counterName);<a name="line.111"></a> +<span class="sourceLineNo">112</span> if (c != null) {<a name="line.112"></a> +<span class="sourceLineNo">113</span> c.addAndGet(delta);<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> +<span class="sourceLineNo">115</span> }<a name="line.115"></a> +<span class="sourceLineNo">116</span><a name="line.116"></a> +<span class="sourceLineNo">117</span> /**<a name="line.117"></a> +<span class="sourceLineNo">118</span> * Get all of the values since the last time this function was called. Calling this function will<a name="line.118"></a> +<span class="sourceLineNo">119</span> * reset all AtomicLongs in the instance back to 0.<a name="line.119"></a> +<span class="sourceLineNo">120</span> * @return A Map of String -&gt; Long for metrics<a name="line.120"></a> +<span class="sourceLineNo">121</span> */<a name="line.121"></a> +<span class="sourceLineNo">122</span> public Map<String, Long> getMetricsMap() {<a name="line.122"></a> +<span class="sourceLineNo">123</span> return getMetricsMap(true);<a name="line.123"></a> +<span class="sourceLineNo">124</span> }<a name="line.124"></a> +<span class="sourceLineNo">125</span><a name="line.125"></a> +<span class="sourceLineNo">126</span> /**<a name="line.126"></a> +<span class="sourceLineNo">127</span> * Get all of the values. If reset is true, we will reset the all AtomicLongs back to 0.<a name="line.127"></a> +<span class="sourceLineNo">128</span> * @param reset whether to reset the AtomicLongs to 0.<a name="line.128"></a> +<span class="sourceLineNo">129</span> * @return A Map of String -&gt; Long for metrics<a name="line.129"></a> +<span class="sourceLineNo">130</span> */<a name="line.130"></a> +<span class="sourceLineNo">131</span> public Map<String, Long> getMetricsMap(boolean reset) {<a name="line.131"></a> +<span class="sourceLineNo">132</span> // Create a builder<a name="line.132"></a> +<span class="sourceLineNo">133</span> ImmutableMap.Builder<String, Long> builder = ImmutableMap.builder();<a name="line.133"></a> +<span class="sourceLineNo">134</span> for (Map.Entry<String, AtomicLong> e : this.counters.entrySet()) {<a name="line.134"></a> +<span class="sourceLineNo">135</span> long value = reset ? e.getValue().getAndSet(0) : e.getValue().get();<a name="line.135"></a> +<span class="sourceLineNo">136</span> builder.put(e.getKey(), value);<a name="line.136"></a> +<span class="sourceLineNo">137</span> }<a name="line.137"></a> +<span class="sourceLineNo">138</span> // Build the immutable map so that people can't mess around with it.<a name="line.138"></a> +<span class="sourceLineNo">139</span> return builder.build();<a name="line.139"></a> +<span class="sourceLineNo">140</span> }<a name="line.140"></a> +<span class="sourceLineNo">141</span>}<a name="line.141"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.MutationType.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.MutationType.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.MutationType.html index f13eda1..86dbcf8 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.MutationType.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.MutationType.html @@ -1445,88 +1445,91 @@ <span class="sourceLineNo">1437</span> * @param stagingFamilyPaths pairs of { CF, HFile path } submitted for bulk load<a name="line.1437"></a> <span class="sourceLineNo">1438</span> * @param hasLoaded whether the bulkLoad was successful<a name="line.1438"></a> <span class="sourceLineNo">1439</span> * @return the new value of hasLoaded<a name="line.1439"></a> -<span class="sourceLineNo">1440</span> * @deprecated Use {@link #postBulkLoadHFile(ObserverContext, List, Map, boolean)}<a name="line.1440"></a> -<span class="sourceLineNo">1441</span> */<a name="line.1441"></a> -<span class="sourceLineNo">1442</span> default boolean postBulkLoadHFile(final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1442"></a> -<span class="sourceLineNo">1443</span> List<Pair<byte[], String>> stagingFamilyPaths, boolean hasLoaded) throws IOException {<a name="line.1443"></a> -<span class="sourceLineNo">1444</span> return hasLoaded;<a name="line.1444"></a> -<span class="sourceLineNo">1445</span> }<a name="line.1445"></a> -<span class="sourceLineNo">1446</span><a name="line.1446"></a> -<span class="sourceLineNo">1447</span> /**<a name="line.1447"></a> -<span class="sourceLineNo">1448</span> * Called before creation of Reader for a store file.<a name="line.1448"></a> -<span class="sourceLineNo">1449</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1449"></a> -<span class="sourceLineNo">1450</span> * effect in this hook.<a name="line.1450"></a> -<span class="sourceLineNo">1451</span> *<a name="line.1451"></a> -<span class="sourceLineNo">1452</span> * @param ctx the environment provided by the region server<a name="line.1452"></a> -<span class="sourceLineNo">1453</span> * @param fs fileystem to read from<a name="line.1453"></a> -<span class="sourceLineNo">1454</span> * @param p path to the file<a name="line.1454"></a> -<span class="sourceLineNo">1455</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1455"></a> -<span class="sourceLineNo">1456</span> * @param size Full size of the file<a name="line.1456"></a> -<span class="sourceLineNo">1457</span> * @param cacheConf<a name="line.1457"></a> -<span class="sourceLineNo">1458</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1458"></a> -<span class="sourceLineNo">1459</span> * @param reader the base reader, if not {@code null}, from previous RegionObserver in the chain<a name="line.1459"></a> -<span class="sourceLineNo">1460</span> * @return a Reader instance to use instead of the base reader if overriding<a name="line.1460"></a> -<span class="sourceLineNo">1461</span> * default behavior, null otherwise<a name="line.1461"></a> -<span class="sourceLineNo">1462</span> */<a name="line.1462"></a> -<span class="sourceLineNo">1463</span> default StoreFileReader preStoreFileReaderOpen(<a name="line.1463"></a> -<span class="sourceLineNo">1464</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1464"></a> -<span class="sourceLineNo">1465</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1465"></a> -<span class="sourceLineNo">1466</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1466"></a> -<span class="sourceLineNo">1467</span> return reader;<a name="line.1467"></a> -<span class="sourceLineNo">1468</span> }<a name="line.1468"></a> -<span class="sourceLineNo">1469</span><a name="line.1469"></a> -<span class="sourceLineNo">1470</span> /**<a name="line.1470"></a> -<span class="sourceLineNo">1471</span> * Called after the creation of Reader for a store file.<a name="line.1471"></a> -<span class="sourceLineNo">1472</span> *<a name="line.1472"></a> -<span class="sourceLineNo">1473</span> * @param ctx the environment provided by the region server<a name="line.1473"></a> -<span class="sourceLineNo">1474</span> * @param fs fileystem to read from<a name="line.1474"></a> -<span class="sourceLineNo">1475</span> * @param p path to the file<a name="line.1475"></a> -<span class="sourceLineNo">1476</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1476"></a> -<span class="sourceLineNo">1477</span> * @param size Full size of the file<a name="line.1477"></a> -<span class="sourceLineNo">1478</span> * @param cacheConf<a name="line.1478"></a> -<span class="sourceLineNo">1479</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1479"></a> -<span class="sourceLineNo">1480</span> * @param reader the base reader instance<a name="line.1480"></a> -<span class="sourceLineNo">1481</span> * @return The reader to use<a name="line.1481"></a> -<span class="sourceLineNo">1482</span> */<a name="line.1482"></a> -<span class="sourceLineNo">1483</span> default StoreFileReader postStoreFileReaderOpen(<a name="line.1483"></a> -<span class="sourceLineNo">1484</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1484"></a> -<span class="sourceLineNo">1485</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1485"></a> -<span class="sourceLineNo">1486</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1486"></a> -<span class="sourceLineNo">1487</span> return reader;<a name="line.1487"></a> -<span class="sourceLineNo">1488</span> }<a name="line.1488"></a> -<span class="sourceLineNo">1489</span><a name="line.1489"></a> -<span class="sourceLineNo">1490</span> /**<a name="line.1490"></a> -<span class="sourceLineNo">1491</span> * Called after a new cell has been created during an increment operation, but before<a name="line.1491"></a> -<span class="sourceLineNo">1492</span> * it is committed to the WAL or memstore.<a name="line.1492"></a> -<span class="sourceLineNo">1493</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1493"></a> -<span class="sourceLineNo">1494</span> * effect in this hook.<a name="line.1494"></a> -<span class="sourceLineNo">1495</span> * @param ctx the environment provided by the region server<a name="line.1495"></a> -<span class="sourceLineNo">1496</span> * @param opType the operation type<a name="line.1496"></a> -<span class="sourceLineNo">1497</span> * @param mutation the current mutation<a name="line.1497"></a> -<span class="sourceLineNo">1498</span> * @param oldCell old cell containing previous value<a name="line.1498"></a> -<span class="sourceLineNo">1499</span> * @param newCell the new cell containing the computed value<a name="line.1499"></a> -<span class="sourceLineNo">1500</span> * @return the new cell, possibly changed<a name="line.1500"></a> -<span class="sourceLineNo">1501</span> */<a name="line.1501"></a> -<span class="sourceLineNo">1502</span> default Cell postMutationBeforeWAL(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1502"></a> -<span class="sourceLineNo">1503</span> MutationType opType, Mutation mutation, Cell oldCell, Cell newCell) throws IOException {<a name="line.1503"></a> -<span class="sourceLineNo">1504</span> return newCell;<a name="line.1504"></a> -<span class="sourceLineNo">1505</span> }<a name="line.1505"></a> -<span class="sourceLineNo">1506</span><a name="line.1506"></a> -<span class="sourceLineNo">1507</span> /**<a name="line.1507"></a> -<span class="sourceLineNo">1508</span> * Called after the ScanQueryMatcher creates ScanDeleteTracker. Implementing<a name="line.1508"></a> -<span class="sourceLineNo">1509</span> * this hook would help in creating customised DeleteTracker and returning<a name="line.1509"></a> -<span class="sourceLineNo">1510</span> * the newly created DeleteTracker<a name="line.1510"></a> -<span class="sourceLineNo">1511</span> *<a name="line.1511"></a> -<span class="sourceLineNo">1512</span> * @param ctx the environment provided by the region server<a name="line.1512"></a> -<span class="sourceLineNo">1513</span> * @param delTracker the deleteTracker that is created by the QueryMatcher<a name="line.1513"></a> -<span class="sourceLineNo">1514</span> * @return the Delete Tracker<a name="line.1514"></a> -<span class="sourceLineNo">1515</span> */<a name="line.1515"></a> -<span class="sourceLineNo">1516</span> default DeleteTracker postInstantiateDeleteTracker(<a name="line.1516"></a> -<span class="sourceLineNo">1517</span> final ObserverContext<RegionCoprocessorEnvironment> ctx, DeleteTracker delTracker)<a name="line.1517"></a> -<span class="sourceLineNo">1518</span> throws IOException {<a name="line.1518"></a> -<span class="sourceLineNo">1519</span> return delTracker;<a name="line.1519"></a> -<span class="sourceLineNo">1520</span> }<a name="line.1520"></a> -<span class="sourceLineNo">1521</span>}<a name="line.1521"></a> +<span class="sourceLineNo">1440</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0<a name="line.1440"></a> +<span class="sourceLineNo">1441</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-17123">HBASE-17123</a>).<a name="line.1441"></a> +<span class="sourceLineNo">1442</span> * Use {@link #postBulkLoadHFile(ObserverContext, List, Map, boolean)}.<a name="line.1442"></a> +<span class="sourceLineNo">1443</span> */<a name="line.1443"></a> +<span class="sourceLineNo">1444</span> @Deprecated<a name="line.1444"></a> +<span class="sourceLineNo">1445</span> default boolean postBulkLoadHFile(final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1445"></a> +<span class="sourceLineNo">1446</span> List<Pair<byte[], String>> stagingFamilyPaths, boolean hasLoaded) throws IOException {<a name="line.1446"></a> +<span class="sourceLineNo">1447</span> return hasLoaded;<a name="line.1447"></a> +<span class="sourceLineNo">1448</span> }<a name="line.1448"></a> +<span class="sourceLineNo">1449</span><a name="line.1449"></a> +<span class="sourceLineNo">1450</span> /**<a name="line.1450"></a> +<span class="sourceLineNo">1451</span> * Called before creation of Reader for a store file.<a name="line.1451"></a> +<span class="sourceLineNo">1452</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1452"></a> +<span class="sourceLineNo">1453</span> * effect in this hook.<a name="line.1453"></a> +<span class="sourceLineNo">1454</span> *<a name="line.1454"></a> +<span class="sourceLineNo">1455</span> * @param ctx the environment provided by the region server<a name="line.1455"></a> +<span class="sourceLineNo">1456</span> * @param fs fileystem to read from<a name="line.1456"></a> +<span class="sourceLineNo">1457</span> * @param p path to the file<a name="line.1457"></a> +<span class="sourceLineNo">1458</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1458"></a> +<span class="sourceLineNo">1459</span> * @param size Full size of the file<a name="line.1459"></a> +<span class="sourceLineNo">1460</span> * @param cacheConf<a name="line.1460"></a> +<span class="sourceLineNo">1461</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1461"></a> +<span class="sourceLineNo">1462</span> * @param reader the base reader, if not {@code null}, from previous RegionObserver in the chain<a name="line.1462"></a> +<span class="sourceLineNo">1463</span> * @return a Reader instance to use instead of the base reader if overriding<a name="line.1463"></a> +<span class="sourceLineNo">1464</span> * default behavior, null otherwise<a name="line.1464"></a> +<span class="sourceLineNo">1465</span> */<a name="line.1465"></a> +<span class="sourceLineNo">1466</span> default StoreFileReader preStoreFileReaderOpen(<a name="line.1466"></a> +<span class="sourceLineNo">1467</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1467"></a> +<span class="sourceLineNo">1468</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1468"></a> +<span class="sourceLineNo">1469</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1469"></a> +<span class="sourceLineNo">1470</span> return reader;<a name="line.1470"></a> +<span class="sourceLineNo">1471</span> }<a name="line.1471"></a> +<span class="sourceLineNo">1472</span><a name="line.1472"></a> +<span class="sourceLineNo">1473</span> /**<a name="line.1473"></a> +<span class="sourceLineNo">1474</span> * Called after the creation of Reader for a store file.<a name="line.1474"></a> +<span class="sourceLineNo">1475</span> *<a name="line.1475"></a> +<span class="sourceLineNo">1476</span> * @param ctx the environment provided by the region server<a name="line.1476"></a> +<span class="sourceLineNo">1477</span> * @param fs fileystem to read from<a name="line.1477"></a> +<span class="sourceLineNo">1478</span> * @param p path to the file<a name="line.1478"></a> +<span class="sourceLineNo">1479</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1479"></a> +<span class="sourceLineNo">1480</span> * @param size Full size of the file<a name="line.1480"></a> +<span class="sourceLineNo">1481</span> * @param cacheConf<a name="line.1481"></a> +<span class="sourceLineNo">1482</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1482"></a> +<span class="sourceLineNo">1483</span> * @param reader the base reader instance<a name="line.1483"></a> +<span class="sourceLineNo">1484</span> * @return The reader to use<a name="line.1484"></a> +<span class="sourceLineNo">1485</span> */<a name="line.1485"></a> +<span class="sourceLineNo">1486</span> default StoreFileReader postStoreFileReaderOpen(<a name="line.1486"></a> +<span class="sourceLineNo">1487</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1487"></a> +<span class="sourceLineNo">1488</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1488"></a> +<span class="sourceLineNo">1489</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1489"></a> +<span class="sourceLineNo">1490</span> return reader;<a name="line.1490"></a> +<span class="sourceLineNo">1491</span> }<a name="line.1491"></a> +<span class="sourceLineNo">1492</span><a name="line.1492"></a> +<span class="sourceLineNo">1493</span> /**<a name="line.1493"></a> +<span class="sourceLineNo">1494</span> * Called after a new cell has been created during an increment operation, but before<a name="line.1494"></a> +<span class="sourceLineNo">1495</span> * it is committed to the WAL or memstore.<a name="line.1495"></a> +<span class="sourceLineNo">1496</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1496"></a> +<span class="sourceLineNo">1497</span> * effect in this hook.<a name="line.1497"></a> +<span class="sourceLineNo">1498</span> * @param ctx the environment provided by the region server<a name="line.1498"></a> +<span class="sourceLineNo">1499</span> * @param opType the operation type<a name="line.1499"></a> +<span class="sourceLineNo">1500</span> * @param mutation the current mutation<a name="line.1500"></a> +<span class="sourceLineNo">1501</span> * @param oldCell old cell containing previous value<a name="line.1501"></a> +<span class="sourceLineNo">1502</span> * @param newCell the new cell containing the computed value<a name="line.1502"></a> +<span class="sourceLineNo">1503</span> * @return the new cell, possibly changed<a name="line.1503"></a> +<span class="sourceLineNo">1504</span> */<a name="line.1504"></a> +<span class="sourceLineNo">1505</span> default Cell postMutationBeforeWAL(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1505"></a> +<span class="sourceLineNo">1506</span> MutationType opType, Mutation mutation, Cell oldCell, Cell newCell) throws IOException {<a name="line.1506"></a> +<span class="sourceLineNo">1507</span> return newCell;<a name="line.1507"></a> +<span class="sourceLineNo">1508</span> }<a name="line.1508"></a> +<span class="sourceLineNo">1509</span><a name="line.1509"></a> +<span class="sourceLineNo">1510</span> /**<a name="line.1510"></a> +<span class="sourceLineNo">1511</span> * Called after the ScanQueryMatcher creates ScanDeleteTracker. Implementing<a name="line.1511"></a> +<span class="sourceLineNo">1512</span> * this hook would help in creating customised DeleteTracker and returning<a name="line.1512"></a> +<span class="sourceLineNo">1513</span> * the newly created DeleteTracker<a name="line.1513"></a> +<span class="sourceLineNo">1514</span> *<a name="line.1514"></a> +<span class="sourceLineNo">1515</span> * @param ctx the environment provided by the region server<a name="line.1515"></a> +<span class="sourceLineNo">1516</span> * @param delTracker the deleteTracker that is created by the QueryMatcher<a name="line.1516"></a> +<span class="sourceLineNo">1517</span> * @return the Delete Tracker<a name="line.1517"></a> +<span class="sourceLineNo">1518</span> */<a name="line.1518"></a> +<span class="sourceLineNo">1519</span> default DeleteTracker postInstantiateDeleteTracker(<a name="line.1519"></a> +<span class="sourceLineNo">1520</span> final ObserverContext<RegionCoprocessorEnvironment> ctx, DeleteTracker delTracker)<a name="line.1520"></a> +<span class="sourceLineNo">1521</span> throws IOException {<a name="line.1521"></a> +<span class="sourceLineNo">1522</span> return delTracker;<a name="line.1522"></a> +<span class="sourceLineNo">1523</span> }<a name="line.1523"></a> +<span class="sourceLineNo">1524</span>}<a name="line.1524"></a> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/1ada5f22/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html ---------------------------------------------------------------------- diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html index f13eda1..86dbcf8 100644 --- a/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html +++ b/devapidocs/src-html/org/apache/hadoop/hbase/coprocessor/RegionObserver.html @@ -1445,88 +1445,91 @@ <span class="sourceLineNo">1437</span> * @param stagingFamilyPaths pairs of { CF, HFile path } submitted for bulk load<a name="line.1437"></a> <span class="sourceLineNo">1438</span> * @param hasLoaded whether the bulkLoad was successful<a name="line.1438"></a> <span class="sourceLineNo">1439</span> * @return the new value of hasLoaded<a name="line.1439"></a> -<span class="sourceLineNo">1440</span> * @deprecated Use {@link #postBulkLoadHFile(ObserverContext, List, Map, boolean)}<a name="line.1440"></a> -<span class="sourceLineNo">1441</span> */<a name="line.1441"></a> -<span class="sourceLineNo">1442</span> default boolean postBulkLoadHFile(final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1442"></a> -<span class="sourceLineNo">1443</span> List<Pair<byte[], String>> stagingFamilyPaths, boolean hasLoaded) throws IOException {<a name="line.1443"></a> -<span class="sourceLineNo">1444</span> return hasLoaded;<a name="line.1444"></a> -<span class="sourceLineNo">1445</span> }<a name="line.1445"></a> -<span class="sourceLineNo">1446</span><a name="line.1446"></a> -<span class="sourceLineNo">1447</span> /**<a name="line.1447"></a> -<span class="sourceLineNo">1448</span> * Called before creation of Reader for a store file.<a name="line.1448"></a> -<span class="sourceLineNo">1449</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1449"></a> -<span class="sourceLineNo">1450</span> * effect in this hook.<a name="line.1450"></a> -<span class="sourceLineNo">1451</span> *<a name="line.1451"></a> -<span class="sourceLineNo">1452</span> * @param ctx the environment provided by the region server<a name="line.1452"></a> -<span class="sourceLineNo">1453</span> * @param fs fileystem to read from<a name="line.1453"></a> -<span class="sourceLineNo">1454</span> * @param p path to the file<a name="line.1454"></a> -<span class="sourceLineNo">1455</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1455"></a> -<span class="sourceLineNo">1456</span> * @param size Full size of the file<a name="line.1456"></a> -<span class="sourceLineNo">1457</span> * @param cacheConf<a name="line.1457"></a> -<span class="sourceLineNo">1458</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1458"></a> -<span class="sourceLineNo">1459</span> * @param reader the base reader, if not {@code null}, from previous RegionObserver in the chain<a name="line.1459"></a> -<span class="sourceLineNo">1460</span> * @return a Reader instance to use instead of the base reader if overriding<a name="line.1460"></a> -<span class="sourceLineNo">1461</span> * default behavior, null otherwise<a name="line.1461"></a> -<span class="sourceLineNo">1462</span> */<a name="line.1462"></a> -<span class="sourceLineNo">1463</span> default StoreFileReader preStoreFileReaderOpen(<a name="line.1463"></a> -<span class="sourceLineNo">1464</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1464"></a> -<span class="sourceLineNo">1465</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1465"></a> -<span class="sourceLineNo">1466</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1466"></a> -<span class="sourceLineNo">1467</span> return reader;<a name="line.1467"></a> -<span class="sourceLineNo">1468</span> }<a name="line.1468"></a> -<span class="sourceLineNo">1469</span><a name="line.1469"></a> -<span class="sourceLineNo">1470</span> /**<a name="line.1470"></a> -<span class="sourceLineNo">1471</span> * Called after the creation of Reader for a store file.<a name="line.1471"></a> -<span class="sourceLineNo">1472</span> *<a name="line.1472"></a> -<span class="sourceLineNo">1473</span> * @param ctx the environment provided by the region server<a name="line.1473"></a> -<span class="sourceLineNo">1474</span> * @param fs fileystem to read from<a name="line.1474"></a> -<span class="sourceLineNo">1475</span> * @param p path to the file<a name="line.1475"></a> -<span class="sourceLineNo">1476</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1476"></a> -<span class="sourceLineNo">1477</span> * @param size Full size of the file<a name="line.1477"></a> -<span class="sourceLineNo">1478</span> * @param cacheConf<a name="line.1478"></a> -<span class="sourceLineNo">1479</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1479"></a> -<span class="sourceLineNo">1480</span> * @param reader the base reader instance<a name="line.1480"></a> -<span class="sourceLineNo">1481</span> * @return The reader to use<a name="line.1481"></a> -<span class="sourceLineNo">1482</span> */<a name="line.1482"></a> -<span class="sourceLineNo">1483</span> default StoreFileReader postStoreFileReaderOpen(<a name="line.1483"></a> -<span class="sourceLineNo">1484</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1484"></a> -<span class="sourceLineNo">1485</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1485"></a> -<span class="sourceLineNo">1486</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1486"></a> -<span class="sourceLineNo">1487</span> return reader;<a name="line.1487"></a> -<span class="sourceLineNo">1488</span> }<a name="line.1488"></a> -<span class="sourceLineNo">1489</span><a name="line.1489"></a> -<span class="sourceLineNo">1490</span> /**<a name="line.1490"></a> -<span class="sourceLineNo">1491</span> * Called after a new cell has been created during an increment operation, but before<a name="line.1491"></a> -<span class="sourceLineNo">1492</span> * it is committed to the WAL or memstore.<a name="line.1492"></a> -<span class="sourceLineNo">1493</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1493"></a> -<span class="sourceLineNo">1494</span> * effect in this hook.<a name="line.1494"></a> -<span class="sourceLineNo">1495</span> * @param ctx the environment provided by the region server<a name="line.1495"></a> -<span class="sourceLineNo">1496</span> * @param opType the operation type<a name="line.1496"></a> -<span class="sourceLineNo">1497</span> * @param mutation the current mutation<a name="line.1497"></a> -<span class="sourceLineNo">1498</span> * @param oldCell old cell containing previous value<a name="line.1498"></a> -<span class="sourceLineNo">1499</span> * @param newCell the new cell containing the computed value<a name="line.1499"></a> -<span class="sourceLineNo">1500</span> * @return the new cell, possibly changed<a name="line.1500"></a> -<span class="sourceLineNo">1501</span> */<a name="line.1501"></a> -<span class="sourceLineNo">1502</span> default Cell postMutationBeforeWAL(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1502"></a> -<span class="sourceLineNo">1503</span> MutationType opType, Mutation mutation, Cell oldCell, Cell newCell) throws IOException {<a name="line.1503"></a> -<span class="sourceLineNo">1504</span> return newCell;<a name="line.1504"></a> -<span class="sourceLineNo">1505</span> }<a name="line.1505"></a> -<span class="sourceLineNo">1506</span><a name="line.1506"></a> -<span class="sourceLineNo">1507</span> /**<a name="line.1507"></a> -<span class="sourceLineNo">1508</span> * Called after the ScanQueryMatcher creates ScanDeleteTracker. Implementing<a name="line.1508"></a> -<span class="sourceLineNo">1509</span> * this hook would help in creating customised DeleteTracker and returning<a name="line.1509"></a> -<span class="sourceLineNo">1510</span> * the newly created DeleteTracker<a name="line.1510"></a> -<span class="sourceLineNo">1511</span> *<a name="line.1511"></a> -<span class="sourceLineNo">1512</span> * @param ctx the environment provided by the region server<a name="line.1512"></a> -<span class="sourceLineNo">1513</span> * @param delTracker the deleteTracker that is created by the QueryMatcher<a name="line.1513"></a> -<span class="sourceLineNo">1514</span> * @return the Delete Tracker<a name="line.1514"></a> -<span class="sourceLineNo">1515</span> */<a name="line.1515"></a> -<span class="sourceLineNo">1516</span> default DeleteTracker postInstantiateDeleteTracker(<a name="line.1516"></a> -<span class="sourceLineNo">1517</span> final ObserverContext<RegionCoprocessorEnvironment> ctx, DeleteTracker delTracker)<a name="line.1517"></a> -<span class="sourceLineNo">1518</span> throws IOException {<a name="line.1518"></a> -<span class="sourceLineNo">1519</span> return delTracker;<a name="line.1519"></a> -<span class="sourceLineNo">1520</span> }<a name="line.1520"></a> -<span class="sourceLineNo">1521</span>}<a name="line.1521"></a> +<span class="sourceLineNo">1440</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0<a name="line.1440"></a> +<span class="sourceLineNo">1441</span> * (<a href="https://issues.apache.org/jira/browse/HBASE-17123">HBASE-17123</a>).<a name="line.1441"></a> +<span class="sourceLineNo">1442</span> * Use {@link #postBulkLoadHFile(ObserverContext, List, Map, boolean)}.<a name="line.1442"></a> +<span class="sourceLineNo">1443</span> */<a name="line.1443"></a> +<span class="sourceLineNo">1444</span> @Deprecated<a name="line.1444"></a> +<span class="sourceLineNo">1445</span> default boolean postBulkLoadHFile(final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1445"></a> +<span class="sourceLineNo">1446</span> List<Pair<byte[], String>> stagingFamilyPaths, boolean hasLoaded) throws IOException {<a name="line.1446"></a> +<span class="sourceLineNo">1447</span> return hasLoaded;<a name="line.1447"></a> +<span class="sourceLineNo">1448</span> }<a name="line.1448"></a> +<span class="sourceLineNo">1449</span><a name="line.1449"></a> +<span class="sourceLineNo">1450</span> /**<a name="line.1450"></a> +<span class="sourceLineNo">1451</span> * Called before creation of Reader for a store file.<a name="line.1451"></a> +<span class="sourceLineNo">1452</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1452"></a> +<span class="sourceLineNo">1453</span> * effect in this hook.<a name="line.1453"></a> +<span class="sourceLineNo">1454</span> *<a name="line.1454"></a> +<span class="sourceLineNo">1455</span> * @param ctx the environment provided by the region server<a name="line.1455"></a> +<span class="sourceLineNo">1456</span> * @param fs fileystem to read from<a name="line.1456"></a> +<span class="sourceLineNo">1457</span> * @param p path to the file<a name="line.1457"></a> +<span class="sourceLineNo">1458</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1458"></a> +<span class="sourceLineNo">1459</span> * @param size Full size of the file<a name="line.1459"></a> +<span class="sourceLineNo">1460</span> * @param cacheConf<a name="line.1460"></a> +<span class="sourceLineNo">1461</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1461"></a> +<span class="sourceLineNo">1462</span> * @param reader the base reader, if not {@code null}, from previous RegionObserver in the chain<a name="line.1462"></a> +<span class="sourceLineNo">1463</span> * @return a Reader instance to use instead of the base reader if overriding<a name="line.1463"></a> +<span class="sourceLineNo">1464</span> * default behavior, null otherwise<a name="line.1464"></a> +<span class="sourceLineNo">1465</span> */<a name="line.1465"></a> +<span class="sourceLineNo">1466</span> default StoreFileReader preStoreFileReaderOpen(<a name="line.1466"></a> +<span class="sourceLineNo">1467</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1467"></a> +<span class="sourceLineNo">1468</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1468"></a> +<span class="sourceLineNo">1469</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1469"></a> +<span class="sourceLineNo">1470</span> return reader;<a name="line.1470"></a> +<span class="sourceLineNo">1471</span> }<a name="line.1471"></a> +<span class="sourceLineNo">1472</span><a name="line.1472"></a> +<span class="sourceLineNo">1473</span> /**<a name="line.1473"></a> +<span class="sourceLineNo">1474</span> * Called after the creation of Reader for a store file.<a name="line.1474"></a> +<span class="sourceLineNo">1475</span> *<a name="line.1475"></a> +<span class="sourceLineNo">1476</span> * @param ctx the environment provided by the region server<a name="line.1476"></a> +<span class="sourceLineNo">1477</span> * @param fs fileystem to read from<a name="line.1477"></a> +<span class="sourceLineNo">1478</span> * @param p path to the file<a name="line.1478"></a> +<span class="sourceLineNo">1479</span> * @param in {@link FSDataInputStreamWrapper}<a name="line.1479"></a> +<span class="sourceLineNo">1480</span> * @param size Full size of the file<a name="line.1480"></a> +<span class="sourceLineNo">1481</span> * @param cacheConf<a name="line.1481"></a> +<span class="sourceLineNo">1482</span> * @param r original reference file. This will be not null only when reading a split file.<a name="line.1482"></a> +<span class="sourceLineNo">1483</span> * @param reader the base reader instance<a name="line.1483"></a> +<span class="sourceLineNo">1484</span> * @return The reader to use<a name="line.1484"></a> +<span class="sourceLineNo">1485</span> */<a name="line.1485"></a> +<span class="sourceLineNo">1486</span> default StoreFileReader postStoreFileReaderOpen(<a name="line.1486"></a> +<span class="sourceLineNo">1487</span> final ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1487"></a> +<span class="sourceLineNo">1488</span> final FileSystem fs, final Path p, final FSDataInputStreamWrapper in, long size,<a name="line.1488"></a> +<span class="sourceLineNo">1489</span> final CacheConfig cacheConf, final Reference r, StoreFileReader reader) throws IOException {<a name="line.1489"></a> +<span class="sourceLineNo">1490</span> return reader;<a name="line.1490"></a> +<span class="sourceLineNo">1491</span> }<a name="line.1491"></a> +<span class="sourceLineNo">1492</span><a name="line.1492"></a> +<span class="sourceLineNo">1493</span> /**<a name="line.1493"></a> +<span class="sourceLineNo">1494</span> * Called after a new cell has been created during an increment operation, but before<a name="line.1494"></a> +<span class="sourceLineNo">1495</span> * it is committed to the WAL or memstore.<a name="line.1495"></a> +<span class="sourceLineNo">1496</span> * Calling {@link org.apache.hadoop.hbase.coprocessor.ObserverContext#bypass()} has no<a name="line.1496"></a> +<span class="sourceLineNo">1497</span> * effect in this hook.<a name="line.1497"></a> +<span class="sourceLineNo">1498</span> * @param ctx the environment provided by the region server<a name="line.1498"></a> +<span class="sourceLineNo">1499</span> * @param opType the operation type<a name="line.1499"></a> +<span class="sourceLineNo">1500</span> * @param mutation the current mutation<a name="line.1500"></a> +<span class="sourceLineNo">1501</span> * @param oldCell old cell containing previous value<a name="line.1501"></a> +<span class="sourceLineNo">1502</span> * @param newCell the new cell containing the computed value<a name="line.1502"></a> +<span class="sourceLineNo">1503</span> * @return the new cell, possibly changed<a name="line.1503"></a> +<span class="sourceLineNo">1504</span> */<a name="line.1504"></a> +<span class="sourceLineNo">1505</span> default Cell postMutationBeforeWAL(ObserverContext<RegionCoprocessorEnvironment> ctx,<a name="line.1505"></a> +<span class="sourceLineNo">1506</span> MutationType opType, Mutation mutation, Cell oldCell, Cell newCell) throws IOException {<a name="line.1506"></a> +<span class="sourceLineNo">1507</span> return newCell;<a name="line.1507"></a> +<span class="sourceLineNo">1508</span> }<a name="line.1508"></a> +<span class="sourceLineNo">1509</span><a name="line.1509"></a> +<span class="sourceLineNo">1510</span> /**<a name="line.1510"></a> +<span class="sourceLineNo">1511</span> * Called after the ScanQueryMatcher creates ScanDeleteTracker. Implementing<a name="line.1511"></a> +<span class="sourceLineNo">1512</span> * this hook would help in creating customised DeleteTracker and returning<a name="line.1512"></a> +<span class="sourceLineNo">1513</span> * the newly created DeleteTracker<a name="line.1513"></a> +<span class="sourceLineNo">1514</span> *<a name="line.1514"></a> +<span class="sourceLineNo">1515</span> * @param ctx the environment provided by the region server<a name="line.1515"></a> +<span class="sourceLineNo">1516</span> * @param delTracker the deleteTracker that is created by the QueryMatcher<a name="line.1516"></a> +<span class="sourceLineNo">1517</span> * @return the Delete Tracker<a name="line.1517"></a> +<span class="sourceLineNo">1518</span> */<a name="line.1518"></a> +<span class="sourceLineNo">1519</span> default DeleteTracker postInstantiateDeleteTracker(<a name="line.1519"></a> +<span class="sourceLineNo">1520</span> final ObserverContext<RegionCoprocessorEnvironment> ctx, DeleteTracker delTracker)<a name="line.1520"></a> +<span class="sourceLineNo">1521</span> throws IOException {<a name="line.1521"></a> +<span class="sourceLineNo">1522</span> return delTracker;<a name="line.1522"></a> +<span class="sourceLineNo">1523</span> }<a name="line.1523"></a> +<span class="sourceLineNo">1524</span>}<a name="line.1524"></a>
