| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.client, interface: BufferedMutator"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Closeable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.List;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26"></span> |
| <span class="source-line-no">027</span><span id="line-27">/**</span> |
| <span class="source-line-no">028</span><span id="line-28"> * <p></span> |
| <span class="source-line-no">029</span><span id="line-29"> * Used to communicate with a single HBase table similar to {@link Table} but meant for batched,</span> |
| <span class="source-line-no">030</span><span id="line-30"> * asynchronous puts. Obtain an instance from a {@link Connection} and call {@link #close()}</span> |
| <span class="source-line-no">031</span><span id="line-31"> * afterwards. Customizations can be applied to the {@code BufferedMutator} via the</span> |
| <span class="source-line-no">032</span><span id="line-32"> * {@link BufferedMutatorParams}.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * </p></span> |
| <span class="source-line-no">034</span><span id="line-34"> * <p></span> |
| <span class="source-line-no">035</span><span id="line-35"> * Exception handling with asynchronously via the {@link BufferedMutator.ExceptionListener}. The</span> |
| <span class="source-line-no">036</span><span id="line-36"> * default implementation is to throw the exception upon receipt. This behavior can be overridden</span> |
| <span class="source-line-no">037</span><span id="line-37"> * with a custom implementation, provided as a parameter with</span> |
| <span class="source-line-no">038</span><span id="line-38"> * {@link BufferedMutatorParams#listener(BufferedMutator.ExceptionListener)}.</span> |
| <span class="source-line-no">039</span><span id="line-39"> * </p></span> |
| <span class="source-line-no">040</span><span id="line-40"> * <p></span> |
| <span class="source-line-no">041</span><span id="line-41"> * Map/Reduce jobs are good use cases for using {@code BufferedMutator}. Map/reduce jobs benefit</span> |
| <span class="source-line-no">042</span><span id="line-42"> * from batching, but have no natural flush point. {@code BufferedMutator} receives the puts from</span> |
| <span class="source-line-no">043</span><span id="line-43"> * the M/R job and will batch puts based on some heuristic, such as the accumulated size of the</span> |
| <span class="source-line-no">044</span><span id="line-44"> * puts, and submit batches of puts asynchronously so that the M/R logic can continue without</span> |
| <span class="source-line-no">045</span><span id="line-45"> * interruption.</span> |
| <span class="source-line-no">046</span><span id="line-46"> * </p></span> |
| <span class="source-line-no">047</span><span id="line-47"> * <p></span> |
| <span class="source-line-no">048</span><span id="line-48"> * {@code BufferedMutator} can also be used on more exotic circumstances. Map/Reduce batch jobs will</span> |
| <span class="source-line-no">049</span><span id="line-49"> * have a single {@code BufferedMutator} per thread. A single {@code BufferedMutator} can also be</span> |
| <span class="source-line-no">050</span><span id="line-50"> * effectively used in high volume online systems to batch puts, with the caveat that extreme</span> |
| <span class="source-line-no">051</span><span id="line-51"> * circumstances, such as JVM or machine failure, may cause some data loss.</span> |
| <span class="source-line-no">052</span><span id="line-52"> * </p></span> |
| <span class="source-line-no">053</span><span id="line-53"> * <p></span> |
| <span class="source-line-no">054</span><span id="line-54"> * NOTE: This class replaces the functionality that used to be available via</span> |
| <span class="source-line-no">055</span><span id="line-55"> * HTable#setAutoFlush(boolean) set to {@code false}.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * </p></span> |
| <span class="source-line-no">057</span><span id="line-57"> * <p></span> |
| <span class="source-line-no">058</span><span id="line-58"> * See also the {@code BufferedMutatorExample} in the hbase-examples module.</span> |
| <span class="source-line-no">059</span><span id="line-59"> * </p></span> |
| <span class="source-line-no">060</span><span id="line-60"> * @see ConnectionFactory</span> |
| <span class="source-line-no">061</span><span id="line-61"> * @see Connection</span> |
| <span class="source-line-no">062</span><span id="line-62"> * @since 1.0.0</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64">@InterfaceAudience.Public</span> |
| <span class="source-line-no">065</span><span id="line-65">public interface BufferedMutator extends Closeable {</span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Key to use setting non-default BufferedMutator implementation in Configuration.</span> |
| <span class="source-line-no">068</span><span id="line-68"> * <p/></span> |
| <span class="source-line-no">069</span><span id="line-69"> * @deprecated Since 3.0.0, will be removed in 4.0.0. For internal test use only, do not use it</span> |
| <span class="source-line-no">070</span><span id="line-70"> * any more.</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> @Deprecated</span> |
| <span class="source-line-no">073</span><span id="line-73"> String CLASSNAME_KEY = "hbase.client.bufferedmutator.classname";</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * Having the timer tick run more often that once every 100ms is needless and will probably cause</span> |
| <span class="source-line-no">077</span><span id="line-77"> * too many timer events firing having a negative impact on performance.</span> |
| <span class="source-line-no">078</span><span id="line-78"> */</span> |
| <span class="source-line-no">079</span><span id="line-79"> long MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS = 100;</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /**</span> |
| <span class="source-line-no">082</span><span id="line-82"> * Gets the fully qualified table name instance of the table that this BufferedMutator writes to.</span> |
| <span class="source-line-no">083</span><span id="line-83"> */</span> |
| <span class="source-line-no">084</span><span id="line-84"> TableName getName();</span> |
| <span class="source-line-no">085</span><span id="line-85"></span> |
| <span class="source-line-no">086</span><span id="line-86"> /**</span> |
| <span class="source-line-no">087</span><span id="line-87"> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.</span> |
| <span class="source-line-no">088</span><span id="line-88"> * <p></span> |
| <span class="source-line-no">089</span><span id="line-89"> * The reference returned is not a copy, so any change made to it will affect this instance.</span> |
| <span class="source-line-no">090</span><span id="line-90"> */</span> |
| <span class="source-line-no">091</span><span id="line-91"> Configuration getConfiguration();</span> |
| <span class="source-line-no">092</span><span id="line-92"></span> |
| <span class="source-line-no">093</span><span id="line-93"> /**</span> |
| <span class="source-line-no">094</span><span id="line-94"> * Sends a {@link Mutation} to the table. The mutations will be buffered and sent over the wire as</span> |
| <span class="source-line-no">095</span><span id="line-95"> * part of a batch. Currently only supports {@link Put} and {@link Delete} mutations.</span> |
| <span class="source-line-no">096</span><span id="line-96"> * @param mutation The data to send.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> void mutate(Mutation mutation) throws IOException;</span> |
| <span class="source-line-no">100</span><span id="line-100"></span> |
| <span class="source-line-no">101</span><span id="line-101"> /**</span> |
| <span class="source-line-no">102</span><span id="line-102"> * Send some {@link Mutation}s to the table. The mutations will be buffered and sent over the wire</span> |
| <span class="source-line-no">103</span><span id="line-103"> * as part of a batch. There is no guarantee of sending entire content of {@code mutations} in a</span> |
| <span class="source-line-no">104</span><span id="line-104"> * single batch; it will be broken up according to the write buffer capacity.</span> |
| <span class="source-line-no">105</span><span id="line-105"> * @param mutations The data to send.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">107</span><span id="line-107"> */</span> |
| <span class="source-line-no">108</span><span id="line-108"> void mutate(List<? extends Mutation> mutations) throws IOException;</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> /**</span> |
| <span class="source-line-no">111</span><span id="line-111"> * Performs a {@link #flush()} and releases any resources held.</span> |
| <span class="source-line-no">112</span><span id="line-112"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> @Override</span> |
| <span class="source-line-no">115</span><span id="line-115"> void close() throws IOException;</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /**</span> |
| <span class="source-line-no">118</span><span id="line-118"> * Executes all the buffered, asynchronous {@link Mutation} operations and waits until they are</span> |
| <span class="source-line-no">119</span><span id="line-119"> * done.</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> void flush() throws IOException;</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> /**</span> |
| <span class="source-line-no">125</span><span id="line-125"> * Sets the maximum time before the buffer is automatically flushed checking once per second.</span> |
| <span class="source-line-no">126</span><span id="line-126"> * @param timeoutMs The maximum number of milliseconds how long records may be buffered before</span> |
| <span class="source-line-no">127</span><span id="line-127"> * they are flushed. Set to 0 to disable.</span> |
| <span class="source-line-no">128</span><span id="line-128"> */</span> |
| <span class="source-line-no">129</span><span id="line-129"> default void setWriteBufferPeriodicFlush(long timeoutMs) {</span> |
| <span class="source-line-no">130</span><span id="line-130"> setWriteBufferPeriodicFlush(timeoutMs, 1000L);</span> |
| <span class="source-line-no">131</span><span id="line-131"> }</span> |
| <span class="source-line-no">132</span><span id="line-132"></span> |
| <span class="source-line-no">133</span><span id="line-133"> /**</span> |
| <span class="source-line-no">134</span><span id="line-134"> * Sets the maximum time before the buffer is automatically flushed.</span> |
| <span class="source-line-no">135</span><span id="line-135"> * @param timeoutMs The maximum number of milliseconds how long records may be buffered before</span> |
| <span class="source-line-no">136</span><span id="line-136"> * they are flushed. Set to 0 to disable.</span> |
| <span class="source-line-no">137</span><span id="line-137"> * @param timerTickMs The number of milliseconds between each check if the timeout has been</span> |
| <span class="source-line-no">138</span><span id="line-138"> * exceeded. Must be 100ms (as defined in</span> |
| <span class="source-line-no">139</span><span id="line-139"> * {@link #MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS}) or larger to avoid</span> |
| <span class="source-line-no">140</span><span id="line-140"> * performance problems.</span> |
| <span class="source-line-no">141</span><span id="line-141"> */</span> |
| <span class="source-line-no">142</span><span id="line-142"> default void setWriteBufferPeriodicFlush(long timeoutMs, long timerTickMs) {</span> |
| <span class="source-line-no">143</span><span id="line-143"> throw new UnsupportedOperationException(</span> |
| <span class="source-line-no">144</span><span id="line-144"> "The BufferedMutator::setWriteBufferPeriodicFlush has not been implemented");</span> |
| <span class="source-line-no">145</span><span id="line-145"> }</span> |
| <span class="source-line-no">146</span><span id="line-146"></span> |
| <span class="source-line-no">147</span><span id="line-147"> /**</span> |
| <span class="source-line-no">148</span><span id="line-148"> * Disable periodic flushing of the write buffer.</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> default void disableWriteBufferPeriodicFlush() {</span> |
| <span class="source-line-no">151</span><span id="line-151"> setWriteBufferPeriodicFlush(0, MIN_WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS);</span> |
| <span class="source-line-no">152</span><span id="line-152"> }</span> |
| <span class="source-line-no">153</span><span id="line-153"></span> |
| <span class="source-line-no">154</span><span id="line-154"> /**</span> |
| <span class="source-line-no">155</span><span id="line-155"> * Returns the current periodic flush timeout value in milliseconds.</span> |
| <span class="source-line-no">156</span><span id="line-156"> * @return The maximum number of milliseconds how long records may be buffered before they are</span> |
| <span class="source-line-no">157</span><span id="line-157"> * flushed. The value 0 means this is disabled.</span> |
| <span class="source-line-no">158</span><span id="line-158"> */</span> |
| <span class="source-line-no">159</span><span id="line-159"> default long getWriteBufferPeriodicFlushTimeoutMs() {</span> |
| <span class="source-line-no">160</span><span id="line-160"> throw new UnsupportedOperationException(</span> |
| <span class="source-line-no">161</span><span id="line-161"> "The BufferedMutator::getWriteBufferPeriodicFlushTimeoutMs has not been implemented");</span> |
| <span class="source-line-no">162</span><span id="line-162"> }</span> |
| <span class="source-line-no">163</span><span id="line-163"></span> |
| <span class="source-line-no">164</span><span id="line-164"> /**</span> |
| <span class="source-line-no">165</span><span id="line-165"> * Returns the current periodic flush timertick interval in milliseconds.</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @return The number of milliseconds between each check if the timeout has been exceeded. This</span> |
| <span class="source-line-no">167</span><span id="line-167"> * value only has a real meaning if the timeout has been set to > 0</span> |
| <span class="source-line-no">168</span><span id="line-168"> */</span> |
| <span class="source-line-no">169</span><span id="line-169"> default long getWriteBufferPeriodicFlushTimerTickMs() {</span> |
| <span class="source-line-no">170</span><span id="line-170"> throw new UnsupportedOperationException(</span> |
| <span class="source-line-no">171</span><span id="line-171"> "The BufferedMutator::getWriteBufferPeriodicFlushTimerTickMs has not been implemented");</span> |
| <span class="source-line-no">172</span><span id="line-172"> }</span> |
| <span class="source-line-no">173</span><span id="line-173"></span> |
| <span class="source-line-no">174</span><span id="line-174"> /**</span> |
| <span class="source-line-no">175</span><span id="line-175"> * Returns the maximum size in bytes of the write buffer for this HTable.</span> |
| <span class="source-line-no">176</span><span id="line-176"> * <p></span> |
| <span class="source-line-no">177</span><span id="line-177"> * The default value comes from the configuration parameter {@code hbase.client.write.buffer}.</span> |
| <span class="source-line-no">178</span><span id="line-178"> * @return The size of the write buffer in bytes.</span> |
| <span class="source-line-no">179</span><span id="line-179"> */</span> |
| <span class="source-line-no">180</span><span id="line-180"> default long getWriteBufferSize() {</span> |
| <span class="source-line-no">181</span><span id="line-181"> throw new UnsupportedOperationException(</span> |
| <span class="source-line-no">182</span><span id="line-182"> "The BufferedMutator::getWriteBufferSize has not been implemented");</span> |
| <span class="source-line-no">183</span><span id="line-183"> }</span> |
| <span class="source-line-no">184</span><span id="line-184"></span> |
| <span class="source-line-no">185</span><span id="line-185"> /**</span> |
| <span class="source-line-no">186</span><span id="line-186"> * Set rpc timeout for this mutator instance</span> |
| <span class="source-line-no">187</span><span id="line-187"> * @deprecated Since 3.0.0, will be removed in 4.0.0. Please set this through the</span> |
| <span class="source-line-no">188</span><span id="line-188"> * {@link BufferedMutatorParams}.</span> |
| <span class="source-line-no">189</span><span id="line-189"> */</span> |
| <span class="source-line-no">190</span><span id="line-190"> @Deprecated</span> |
| <span class="source-line-no">191</span><span id="line-191"> default void setRpcTimeout(int timeout) {</span> |
| <span class="source-line-no">192</span><span id="line-192"> throw new UnsupportedOperationException(</span> |
| <span class="source-line-no">193</span><span id="line-193"> "The BufferedMutator::setRpcTimeout has not been implemented");</span> |
| <span class="source-line-no">194</span><span id="line-194"> }</span> |
| <span class="source-line-no">195</span><span id="line-195"></span> |
| <span class="source-line-no">196</span><span id="line-196"> /**</span> |
| <span class="source-line-no">197</span><span id="line-197"> * Set operation timeout for this mutator instance</span> |
| <span class="source-line-no">198</span><span id="line-198"> * @deprecated Since 3.0.0, will be removed in 4.0.0. Please set this through the</span> |
| <span class="source-line-no">199</span><span id="line-199"> * {@link BufferedMutatorParams}.</span> |
| <span class="source-line-no">200</span><span id="line-200"> */</span> |
| <span class="source-line-no">201</span><span id="line-201"> @Deprecated</span> |
| <span class="source-line-no">202</span><span id="line-202"> default void setOperationTimeout(int timeout) {</span> |
| <span class="source-line-no">203</span><span id="line-203"> throw new UnsupportedOperationException(</span> |
| <span class="source-line-no">204</span><span id="line-204"> "The BufferedMutator::setOperationTimeout has not been implemented");</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</span> |
| <span class="source-line-no">206</span><span id="line-206"></span> |
| <span class="source-line-no">207</span><span id="line-207"> /**</span> |
| <span class="source-line-no">208</span><span id="line-208"> * Listens for asynchronous exceptions on a {@link BufferedMutator}.</span> |
| <span class="source-line-no">209</span><span id="line-209"> */</span> |
| <span class="source-line-no">210</span><span id="line-210"> @InterfaceAudience.Public</span> |
| <span class="source-line-no">211</span><span id="line-211"> interface ExceptionListener {</span> |
| <span class="source-line-no">212</span><span id="line-212"> public void onException(RetriesExhaustedWithDetailsException exception, BufferedMutator mutator)</span> |
| <span class="source-line-no">213</span><span id="line-213"> throws RetriesExhaustedWithDetailsException;</span> |
| <span class="source-line-no">214</span><span id="line-214"> }</span> |
| <span class="source-line-no">215</span><span id="line-215">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
