| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.client;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import static org.apache.hadoop.hbase.client.ConnectionUtils.retries2Attempts;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.concurrent.TimeUnit;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * For creating {@link AsyncBufferedMutator}.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> */<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>@InterfaceAudience.Public<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>public interface AsyncBufferedMutatorBuilder {<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span> /**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Set timeout for the background flush operation.<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> AsyncBufferedMutatorBuilder setOperationTimeout(long timeout, TimeUnit unit);<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Set timeout for each rpc request when doing background flush.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> AsyncBufferedMutatorBuilder setRpcTimeout(long timeout, TimeUnit unit);<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Set the base pause time for retrying. We use an exponential policy to generate sleep time when<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * retrying.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> AsyncBufferedMutatorBuilder setRetryPause(long pause, TimeUnit unit);<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Set the periodical flush interval. If the data in the buffer has not been flush for a long<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * time, i.e, reach this timeout limit, we will flush it automatically.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p/><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * Notice that, set the timeout to 0 or a negative value means disable periodical flush, not<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * 'flush immediately'. If you want to flush immediately then you should not use this class, as it<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * is designed to be 'buffered'.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> default AsyncBufferedMutatorBuilder setWriteBufferPeriodicFlush(long timeout, TimeUnit unit) {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> throw new UnsupportedOperationException("Not implemented");<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> }<a name="line.57"></a> |
| <span class="sourceLineNo">058</span><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> /**<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * Disable the periodical flush, i.e, set the timeout to 0.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> default AsyncBufferedMutatorBuilder disableWriteBufferPeriodicFlush() {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> return setWriteBufferPeriodicFlush(0, TimeUnit.NANOSECONDS);<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> }<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Set the max retry times for an operation. Usually it is the max attempt times minus 1.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <p><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * Operation timeout and max attempt times(or max retry times) are both limitations for retrying,<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * we will stop retrying when we reach any of the limitations.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @see #setMaxAttempts(int)<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @see #setOperationTimeout(long, TimeUnit)<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> default AsyncBufferedMutatorBuilder setMaxRetries(int maxRetries) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return setMaxAttempts(retries2Attempts(maxRetries));<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Set the max attempt times for an operation. Usually it is the max retry times plus 1. Operation<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * timeout and max attempt times(or max retry times) are both limitations for retrying, we will<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * stop retrying when we reach any of the limitations.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @see #setMaxRetries(int)<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @see #setOperationTimeout(long, TimeUnit)<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> AsyncBufferedMutatorBuilder setMaxAttempts(int maxAttempts);<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> * Set the number of retries that are allowed before we start to log.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> AsyncBufferedMutatorBuilder setStartLogErrorsCnt(int startLogErrorsCnt);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Override the write buffer size specified by the provided {@link AsyncConnection}'s<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * {@code hbase.client.write.buffer}.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> */<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> AsyncBufferedMutatorBuilder setWriteBufferSize(long writeBufferSize);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Override the maximum key-value size specified by the provided {@link AsyncConnection}'s<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * {@link org.apache.hadoop.conf.Configuration} instance, via the configuration key<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * {@code hbase.client.keyvalue.maxsize}.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> AsyncBufferedMutatorBuilder setMaxKeyValueSize(int maxKeyValueSize);<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> * Create the {@link AsyncBufferedMutator} instance.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> AsyncBufferedMutator build();<a name="line.109"></a> |
| <span class="sourceLineNo">110</span>}<a name="line.110"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
