| <!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: Table, interface: CheckAndMutateBuilder"> |
| <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.Collections;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.List;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.Map;</span> |
| <span class="source-line-no">025</span><span id="line-25">import java.util.TreeMap;</span> |
| <span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.TimeUnit;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.commons.lang3.NotImplementedException;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.Cell;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.hbase.CompareOperator;</span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.client.coprocessor.Batch;</span> |
| <span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.filter.Filter;</span> |
| <span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.io.TimeRange;</span> |
| <span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel;</span> |
| <span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.util.Bytes;</span> |
| <span class="source-line-no">037</span><span id="line-37">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">038</span><span id="line-38"></span> |
| <span class="source-line-no">039</span><span id="line-39">import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors;</span> |
| <span class="source-line-no">040</span><span id="line-40">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span> |
| <span class="source-line-no">041</span><span id="line-41">import org.apache.hbase.thirdparty.com.google.protobuf.Service;</span> |
| <span class="source-line-no">042</span><span id="line-42">import org.apache.hbase.thirdparty.com.google.protobuf.ServiceException;</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44">/**</span> |
| <span class="source-line-no">045</span><span id="line-45"> * Used to communicate with a single HBase table. Obtain an instance from a {@link Connection} and</span> |
| <span class="source-line-no">046</span><span id="line-46"> * call {@link #close()} afterwards.</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>Table</code> can be used to get, put, delete or scan data from a table.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @see ConnectionFactory</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @see Connection</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @see Admin</span> |
| <span class="source-line-no">052</span><span id="line-52"> * @see RegionLocator</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @since 0.99.0</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55">@InterfaceAudience.Public</span> |
| <span class="source-line-no">056</span><span id="line-56">public interface Table extends Closeable {</span> |
| <span class="source-line-no">057</span><span id="line-57"> /**</span> |
| <span class="source-line-no">058</span><span id="line-58"> * Gets the fully qualified table name instance of this table.</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> TableName getName();</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Returns the {@link org.apache.hadoop.conf.Configuration} object used by this instance.</span> |
| <span class="source-line-no">064</span><span id="line-64"> * <p></span> |
| <span class="source-line-no">065</span><span id="line-65"> * The reference returned is not a copy, so any change made to it will affect this instance.</span> |
| <span class="source-line-no">066</span><span id="line-66"> */</span> |
| <span class="source-line-no">067</span><span id="line-67"> Configuration getConfiguration();</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> /**</span> |
| <span class="source-line-no">070</span><span id="line-70"> * Gets the {@link org.apache.hadoop.hbase.client.TableDescriptor table descriptor} for this</span> |
| <span class="source-line-no">071</span><span id="line-71"> * table.</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @throws java.io.IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">073</span><span id="line-73"> */</span> |
| <span class="source-line-no">074</span><span id="line-74"> TableDescriptor getDescriptor() throws IOException;</span> |
| <span class="source-line-no">075</span><span id="line-75"></span> |
| <span class="source-line-no">076</span><span id="line-76"> /**</span> |
| <span class="source-line-no">077</span><span id="line-77"> * Gets the {@link RegionLocator} for this table.</span> |
| <span class="source-line-no">078</span><span id="line-78"> */</span> |
| <span class="source-line-no">079</span><span id="line-79"> RegionLocator getRegionLocator() throws IOException;</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"> * Test for the existence of columns in the table, as specified by the Get.</span> |
| <span class="source-line-no">083</span><span id="line-83"> * <p></span> |
| <span class="source-line-no">084</span><span id="line-84"> * This will return true if the Get matches one or more keys, false if not.</span> |
| <span class="source-line-no">085</span><span id="line-85"> * <p></span> |
| <span class="source-line-no">086</span><span id="line-86"> * This is a server-side call so it prevents any data from being transfered to the client.</span> |
| <span class="source-line-no">087</span><span id="line-87"> * @param get the Get</span> |
| <span class="source-line-no">088</span><span id="line-88"> * @return true if the specified Get matches one or more keys, false if not</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @throws IOException e</span> |
| <span class="source-line-no">090</span><span id="line-90"> */</span> |
| <span class="source-line-no">091</span><span id="line-91"> default boolean exists(Get get) throws IOException {</span> |
| <span class="source-line-no">092</span><span id="line-92"> return exists(Collections.singletonList(get))[0];</span> |
| <span class="source-line-no">093</span><span id="line-93"> }</span> |
| <span class="source-line-no">094</span><span id="line-94"></span> |
| <span class="source-line-no">095</span><span id="line-95"> /**</span> |
| <span class="source-line-no">096</span><span id="line-96"> * Test for the existence of columns in the table, as specified by the Gets.</span> |
| <span class="source-line-no">097</span><span id="line-97"> * <p></span> |
| <span class="source-line-no">098</span><span id="line-98"> * This will return an array of booleans. Each value will be true if the related Get matches one</span> |
| <span class="source-line-no">099</span><span id="line-99"> * or more keys, false if not.</span> |
| <span class="source-line-no">100</span><span id="line-100"> * <p></span> |
| <span class="source-line-no">101</span><span id="line-101"> * This is a server-side call so it prevents any data from being transferred to the client.</span> |
| <span class="source-line-no">102</span><span id="line-102"> * @param gets the Gets</span> |
| <span class="source-line-no">103</span><span id="line-103"> * @return Array of boolean. True if the specified Get matches one or more keys, false if not.</span> |
| <span class="source-line-no">104</span><span id="line-104"> * @throws IOException e</span> |
| <span class="source-line-no">105</span><span id="line-105"> */</span> |
| <span class="source-line-no">106</span><span id="line-106"> default boolean[] exists(List<Get> gets) throws IOException {</span> |
| <span class="source-line-no">107</span><span id="line-107"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">108</span><span id="line-108"> }</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"> * Method that does a batch call on Deletes, Gets, Puts, Increments, Appends, RowMutations. The</span> |
| <span class="source-line-no">112</span><span id="line-112"> * ordering of execution of the actions is not defined. Meaning if you do a Put and a Get in the</span> |
| <span class="source-line-no">113</span><span id="line-113"> * same {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the</span> |
| <span class="source-line-no">114</span><span id="line-114"> * Put had put.</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @param actions list of Get, Put, Delete, Increment, Append, RowMutations.</span> |
| <span class="source-line-no">116</span><span id="line-116"> * @param results Empty Object[], same size as actions. Provides access to partial results, in</span> |
| <span class="source-line-no">117</span><span id="line-117"> * case an exception is thrown. A null in the result array means that the call for</span> |
| <span class="source-line-no">118</span><span id="line-118"> * that action failed, even after retries. The order of the objects in the results</span> |
| <span class="source-line-no">119</span><span id="line-119"> * array corresponds to the order of actions in the request list.</span> |
| <span class="source-line-no">120</span><span id="line-120"> * @since 0.90.0</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> default void batch(final List<? extends Row> actions, final Object[] results)</span> |
| <span class="source-line-no">123</span><span id="line-123"> throws IOException, InterruptedException {</span> |
| <span class="source-line-no">124</span><span id="line-124"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">125</span><span id="line-125"> }</span> |
| <span class="source-line-no">126</span><span id="line-126"></span> |
| <span class="source-line-no">127</span><span id="line-127"> /**</span> |
| <span class="source-line-no">128</span><span id="line-128"> * Same as {@link #batch(List, Object[])}, but with a callback.</span> |
| <span class="source-line-no">129</span><span id="line-129"> * @since 0.96.0</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @deprecated since 3.0.0, will removed in 4.0.0. Please use the batch related methods in</span> |
| <span class="source-line-no">131</span><span id="line-131"> * {@link AsyncTable} directly if you want to use callback. We reuse the callback for</span> |
| <span class="source-line-no">132</span><span id="line-132"> * coprocessor here, and the problem is that for batch operation, the</span> |
| <span class="source-line-no">133</span><span id="line-133"> * {@link AsyncTable} does not tell us the region, so in this method we need an extra</span> |
| <span class="source-line-no">134</span><span id="line-134"> * locating after we get the result, which is not good.</span> |
| <span class="source-line-no">135</span><span id="line-135"> */</span> |
| <span class="source-line-no">136</span><span id="line-136"> @Deprecated</span> |
| <span class="source-line-no">137</span><span id="line-137"> default <R> void batchCallback(final List<? extends Row> actions, final Object[] results,</span> |
| <span class="source-line-no">138</span><span id="line-138"> final Batch.Callback<R> callback) throws IOException, InterruptedException {</span> |
| <span class="source-line-no">139</span><span id="line-139"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">140</span><span id="line-140"> }</span> |
| <span class="source-line-no">141</span><span id="line-141"></span> |
| <span class="source-line-no">142</span><span id="line-142"> /**</span> |
| <span class="source-line-no">143</span><span id="line-143"> * Extracts certain cells from a given row.</span> |
| <span class="source-line-no">144</span><span id="line-144"> * @param get The object that specifies what data to fetch and from which row.</span> |
| <span class="source-line-no">145</span><span id="line-145"> * @return The data coming from the specified row, if it exists. If the row specified doesn't</span> |
| <span class="source-line-no">146</span><span id="line-146"> * exist, the {@link Result} instance returned won't contain any</span> |
| <span class="source-line-no">147</span><span id="line-147"> * {@link org.apache.hadoop.hbase.KeyValue}, as indicated by {@link Result#isEmpty()}.</span> |
| <span class="source-line-no">148</span><span id="line-148"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">149</span><span id="line-149"> * @since 0.20.0</span> |
| <span class="source-line-no">150</span><span id="line-150"> */</span> |
| <span class="source-line-no">151</span><span id="line-151"> default Result get(Get get) throws IOException {</span> |
| <span class="source-line-no">152</span><span id="line-152"> return get(Collections.singletonList(get))[0];</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"> /**</span> |
| <span class="source-line-no">156</span><span id="line-156"> * Extracts specified cells from the given rows, as a batch.</span> |
| <span class="source-line-no">157</span><span id="line-157"> * @param gets The objects that specify what data to fetch and from which rows.</span> |
| <span class="source-line-no">158</span><span id="line-158"> * @return The data coming from the specified rows, if it exists. If the row specified doesn't</span> |
| <span class="source-line-no">159</span><span id="line-159"> * exist, the {@link Result} instance returned won't contain any</span> |
| <span class="source-line-no">160</span><span id="line-160"> * {@link org.apache.hadoop.hbase.Cell}s, as indicated by {@link Result#isEmpty()}. If</span> |
| <span class="source-line-no">161</span><span id="line-161"> * there are any failures even after retries, there will be a <code>null</code> in the</span> |
| <span class="source-line-no">162</span><span id="line-162"> * results' array for those Gets, AND an exception will be thrown. The ordering of the</span> |
| <span class="source-line-no">163</span><span id="line-163"> * Result array corresponds to the order of the list of passed in Gets.</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">165</span><span id="line-165"> * @since 0.90.0</span> |
| <span class="source-line-no">166</span><span id="line-166"> * @apiNote {@link #put(List)} runs pre-flight validations on the input list on client. Currently</span> |
| <span class="source-line-no">167</span><span id="line-167"> * {@link #get(List)} doesn't run any validations on the client-side, currently there is</span> |
| <span class="source-line-no">168</span><span id="line-168"> * no need, but this may change in the future. An {@link IllegalArgumentException} will</span> |
| <span class="source-line-no">169</span><span id="line-169"> * be thrown in this case.</span> |
| <span class="source-line-no">170</span><span id="line-170"> */</span> |
| <span class="source-line-no">171</span><span id="line-171"> default Result[] get(List<Get> gets) throws IOException {</span> |
| <span class="source-line-no">172</span><span id="line-172"> throw new NotImplementedException("Add an implementation!");</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"> /**</span> |
| <span class="source-line-no">176</span><span id="line-176"> * Returns a scanner on the current table as specified by the {@link Scan} object. Note that the</span> |
| <span class="source-line-no">177</span><span id="line-177"> * passed {@link Scan}'s start row and caching properties maybe changed.</span> |
| <span class="source-line-no">178</span><span id="line-178"> * @param scan A configured {@link Scan} object.</span> |
| <span class="source-line-no">179</span><span id="line-179"> * @return A scanner.</span> |
| <span class="source-line-no">180</span><span id="line-180"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">181</span><span id="line-181"> * @since 0.20.0</span> |
| <span class="source-line-no">182</span><span id="line-182"> */</span> |
| <span class="source-line-no">183</span><span id="line-183"> default ResultScanner getScanner(Scan scan) throws IOException {</span> |
| <span class="source-line-no">184</span><span id="line-184"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">185</span><span id="line-185"> }</span> |
| <span class="source-line-no">186</span><span id="line-186"></span> |
| <span class="source-line-no">187</span><span id="line-187"> /**</span> |
| <span class="source-line-no">188</span><span id="line-188"> * Gets a scanner on the current table for the given family.</span> |
| <span class="source-line-no">189</span><span id="line-189"> * @param family The column family to scan.</span> |
| <span class="source-line-no">190</span><span id="line-190"> * @return A scanner.</span> |
| <span class="source-line-no">191</span><span id="line-191"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">192</span><span id="line-192"> * @since 0.20.0</span> |
| <span class="source-line-no">193</span><span id="line-193"> */</span> |
| <span class="source-line-no">194</span><span id="line-194"> default ResultScanner getScanner(byte[] family) throws IOException {</span> |
| <span class="source-line-no">195</span><span id="line-195"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">196</span><span id="line-196"> }</span> |
| <span class="source-line-no">197</span><span id="line-197"></span> |
| <span class="source-line-no">198</span><span id="line-198"> /**</span> |
| <span class="source-line-no">199</span><span id="line-199"> * Gets a scanner on the current table for the given family and qualifier.</span> |
| <span class="source-line-no">200</span><span id="line-200"> * @param family The column family to scan.</span> |
| <span class="source-line-no">201</span><span id="line-201"> * @param qualifier The column qualifier to scan.</span> |
| <span class="source-line-no">202</span><span id="line-202"> * @return A scanner.</span> |
| <span class="source-line-no">203</span><span id="line-203"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">204</span><span id="line-204"> * @since 0.20.0</span> |
| <span class="source-line-no">205</span><span id="line-205"> */</span> |
| <span class="source-line-no">206</span><span id="line-206"> default ResultScanner getScanner(byte[] family, byte[] qualifier) throws IOException {</span> |
| <span class="source-line-no">207</span><span id="line-207"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">208</span><span id="line-208"> }</span> |
| <span class="source-line-no">209</span><span id="line-209"></span> |
| <span class="source-line-no">210</span><span id="line-210"> /**</span> |
| <span class="source-line-no">211</span><span id="line-211"> * Puts some data in the table.</span> |
| <span class="source-line-no">212</span><span id="line-212"> * @param put The data to put.</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">214</span><span id="line-214"> * @since 0.20.0</span> |
| <span class="source-line-no">215</span><span id="line-215"> */</span> |
| <span class="source-line-no">216</span><span id="line-216"> default void put(Put put) throws IOException {</span> |
| <span class="source-line-no">217</span><span id="line-217"> put(Collections.singletonList(put));</span> |
| <span class="source-line-no">218</span><span id="line-218"> }</span> |
| <span class="source-line-no">219</span><span id="line-219"></span> |
| <span class="source-line-no">220</span><span id="line-220"> /**</span> |
| <span class="source-line-no">221</span><span id="line-221"> * Batch puts the specified data into the table.</span> |
| <span class="source-line-no">222</span><span id="line-222"> * <p></span> |
| <span class="source-line-no">223</span><span id="line-223"> * This can be used for group commit, or for submitting user defined batches. Before sending a</span> |
| <span class="source-line-no">224</span><span id="line-224"> * batch of mutations to the server, the client runs a few validations on the input list. If an</span> |
| <span class="source-line-no">225</span><span id="line-225"> * error is found, for example, a mutation was supplied but was missing it's column an</span> |
| <span class="source-line-no">226</span><span id="line-226"> * {@link IllegalArgumentException} will be thrown and no mutations will be applied. If there are</span> |
| <span class="source-line-no">227</span><span id="line-227"> * any failures even after retries, a {@link RetriesExhaustedWithDetailsException} will be thrown.</span> |
| <span class="source-line-no">228</span><span id="line-228"> * RetriesExhaustedWithDetailsException contains lists of failed mutations and corresponding</span> |
| <span class="source-line-no">229</span><span id="line-229"> * remote exceptions. The ordering of mutations and exceptions in the encapsulating exception</span> |
| <span class="source-line-no">230</span><span id="line-230"> * corresponds to the order of the input list of Put requests.</span> |
| <span class="source-line-no">231</span><span id="line-231"> * @param puts The list of mutations to apply.</span> |
| <span class="source-line-no">232</span><span id="line-232"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">233</span><span id="line-233"> * @since 0.20.0</span> |
| <span class="source-line-no">234</span><span id="line-234"> */</span> |
| <span class="source-line-no">235</span><span id="line-235"> default void put(List<Put> puts) throws IOException {</span> |
| <span class="source-line-no">236</span><span id="line-236"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">237</span><span id="line-237"> }</span> |
| <span class="source-line-no">238</span><span id="line-238"></span> |
| <span class="source-line-no">239</span><span id="line-239"> /**</span> |
| <span class="source-line-no">240</span><span id="line-240"> * Deletes the specified cells/row.</span> |
| <span class="source-line-no">241</span><span id="line-241"> * @param delete The object that specifies what to delete.</span> |
| <span class="source-line-no">242</span><span id="line-242"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">243</span><span id="line-243"> * @since 0.20.0</span> |
| <span class="source-line-no">244</span><span id="line-244"> */</span> |
| <span class="source-line-no">245</span><span id="line-245"> default void delete(Delete delete) throws IOException {</span> |
| <span class="source-line-no">246</span><span id="line-246"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">247</span><span id="line-247"> }</span> |
| <span class="source-line-no">248</span><span id="line-248"></span> |
| <span class="source-line-no">249</span><span id="line-249"> /**</span> |
| <span class="source-line-no">250</span><span id="line-250"> * Batch Deletes the specified cells/rows from the table.</span> |
| <span class="source-line-no">251</span><span id="line-251"> * <p></span> |
| <span class="source-line-no">252</span><span id="line-252"> * If a specified row does not exist, {@link Delete} will report as though sucessful delete; no</span> |
| <span class="source-line-no">253</span><span id="line-253"> * exception will be thrown. If there are any failures even after retries, a</span> |
| <span class="source-line-no">254</span><span id="line-254"> * {@link RetriesExhaustedWithDetailsException} will be thrown.</span> |
| <span class="source-line-no">255</span><span id="line-255"> * RetriesExhaustedWithDetailsException contains lists of failed {@link Delete}s and corresponding</span> |
| <span class="source-line-no">256</span><span id="line-256"> * remote exceptions.</span> |
| <span class="source-line-no">257</span><span id="line-257"> * @param deletes List of things to delete. The input list gets modified by this method. All</span> |
| <span class="source-line-no">258</span><span id="line-258"> * successfully applied {@link Delete}s in the list are removed (in particular it</span> |
| <span class="source-line-no">259</span><span id="line-259"> * gets re-ordered, so the order in which the elements are inserted in the list</span> |
| <span class="source-line-no">260</span><span id="line-260"> * gives no guarantee as to the order in which the {@link Delete}s are executed).</span> |
| <span class="source-line-no">261</span><span id="line-261"> * @throws IOException if a remote or network exception occurs. In that case the {@code deletes}</span> |
| <span class="source-line-no">262</span><span id="line-262"> * argument will contain the {@link Delete} instances that have not be</span> |
| <span class="source-line-no">263</span><span id="line-263"> * successfully applied.</span> |
| <span class="source-line-no">264</span><span id="line-264"> * @since 0.20.1</span> |
| <span class="source-line-no">265</span><span id="line-265"> * @apiNote In 3.0.0 version, the input list {@code deletes} will no longer be modified. Also,</span> |
| <span class="source-line-no">266</span><span id="line-266"> * {@link #put(List)} runs pre-flight validations on the input list on client. Currently</span> |
| <span class="source-line-no">267</span><span id="line-267"> * {@link #delete(List)} doesn't run validations on the client, there is no need</span> |
| <span class="source-line-no">268</span><span id="line-268"> * currently, but this may change in the future. An {@link IllegalArgumentException} will</span> |
| <span class="source-line-no">269</span><span id="line-269"> * be thrown in this case.</span> |
| <span class="source-line-no">270</span><span id="line-270"> */</span> |
| <span class="source-line-no">271</span><span id="line-271"> default void delete(List<Delete> deletes) throws IOException {</span> |
| <span class="source-line-no">272</span><span id="line-272"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">273</span><span id="line-273"> }</span> |
| <span class="source-line-no">274</span><span id="line-274"></span> |
| <span class="source-line-no">275</span><span id="line-275"> /**</span> |
| <span class="source-line-no">276</span><span id="line-276"> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it</span> |
| <span class="source-line-no">277</span><span id="line-277"> * adds the Put/Delete/RowMutations.</span> |
| <span class="source-line-no">278</span><span id="line-278"> * <p></span> |
| <span class="source-line-no">279</span><span id="line-279"> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.</span> |
| <span class="source-line-no">280</span><span id="line-280"> * This is a fluent style API, the code is like:</span> |
| <span class="source-line-no">281</span><span id="line-281"> *</span> |
| <span class="source-line-no">282</span><span id="line-282"> * <pre></span> |
| <span class="source-line-no">283</span><span id="line-283"> * <code></span> |
| <span class="source-line-no">284</span><span id="line-284"> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put);</span> |
| <span class="source-line-no">285</span><span id="line-285"> * </code></span> |
| <span class="source-line-no">286</span><span id="line-286"> * </pre></span> |
| <span class="source-line-no">287</span><span id="line-287"> *</span> |
| <span class="source-line-no">288</span><span id="line-288"> * @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">289</span><span id="line-289"> * any more.</span> |
| <span class="source-line-no">290</span><span id="line-290"> */</span> |
| <span class="source-line-no">291</span><span id="line-291"> @Deprecated</span> |
| <span class="source-line-no">292</span><span id="line-292"> default CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family) {</span> |
| <span class="source-line-no">293</span><span id="line-293"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">294</span><span id="line-294"> }</span> |
| <span class="source-line-no">295</span><span id="line-295"></span> |
| <span class="source-line-no">296</span><span id="line-296"> /**</span> |
| <span class="source-line-no">297</span><span id="line-297"> * A helper class for sending checkAndMutate request.</span> |
| <span class="source-line-no">298</span><span id="line-298"> * @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">299</span><span id="line-299"> * any more.</span> |
| <span class="source-line-no">300</span><span id="line-300"> */</span> |
| <span class="source-line-no">301</span><span id="line-301"> @Deprecated</span> |
| <span class="source-line-no">302</span><span id="line-302"> interface CheckAndMutateBuilder {</span> |
| <span class="source-line-no">303</span><span id="line-303"></span> |
| <span class="source-line-no">304</span><span id="line-304"> /**</span> |
| <span class="source-line-no">305</span><span id="line-305"> * Specify a column qualifer</span> |
| <span class="source-line-no">306</span><span id="line-306"> * @param qualifier column qualifier to check.</span> |
| <span class="source-line-no">307</span><span id="line-307"> */</span> |
| <span class="source-line-no">308</span><span id="line-308"> CheckAndMutateBuilder qualifier(byte[] qualifier);</span> |
| <span class="source-line-no">309</span><span id="line-309"></span> |
| <span class="source-line-no">310</span><span id="line-310"> /**</span> |
| <span class="source-line-no">311</span><span id="line-311"> * Specify a timerange</span> |
| <span class="source-line-no">312</span><span id="line-312"> * @param timeRange timeRange to check</span> |
| <span class="source-line-no">313</span><span id="line-313"> */</span> |
| <span class="source-line-no">314</span><span id="line-314"> CheckAndMutateBuilder timeRange(TimeRange timeRange);</span> |
| <span class="source-line-no">315</span><span id="line-315"></span> |
| <span class="source-line-no">316</span><span id="line-316"> /**</span> |
| <span class="source-line-no">317</span><span id="line-317"> * Check for lack of column.</span> |
| <span class="source-line-no">318</span><span id="line-318"> */</span> |
| <span class="source-line-no">319</span><span id="line-319"> CheckAndMutateBuilder ifNotExists();</span> |
| <span class="source-line-no">320</span><span id="line-320"></span> |
| <span class="source-line-no">321</span><span id="line-321"> /**</span> |
| <span class="source-line-no">322</span><span id="line-322"> * Check for equality.</span> |
| <span class="source-line-no">323</span><span id="line-323"> * @param value the expected value</span> |
| <span class="source-line-no">324</span><span id="line-324"> */</span> |
| <span class="source-line-no">325</span><span id="line-325"> default CheckAndMutateBuilder ifEquals(byte[] value) {</span> |
| <span class="source-line-no">326</span><span id="line-326"> return ifMatches(CompareOperator.EQUAL, value);</span> |
| <span class="source-line-no">327</span><span id="line-327"> }</span> |
| <span class="source-line-no">328</span><span id="line-328"></span> |
| <span class="source-line-no">329</span><span id="line-329"> /**</span> |
| <span class="source-line-no">330</span><span id="line-330"> * Check for match.</span> |
| <span class="source-line-no">331</span><span id="line-331"> * @param compareOp comparison operator to use</span> |
| <span class="source-line-no">332</span><span id="line-332"> * @param value the expected value</span> |
| <span class="source-line-no">333</span><span id="line-333"> */</span> |
| <span class="source-line-no">334</span><span id="line-334"> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);</span> |
| <span class="source-line-no">335</span><span id="line-335"></span> |
| <span class="source-line-no">336</span><span id="line-336"> /**</span> |
| <span class="source-line-no">337</span><span id="line-337"> * Specify a Put to commit if the check succeeds.</span> |
| <span class="source-line-no">338</span><span id="line-338"> * @param put data to put if check succeeds</span> |
| <span class="source-line-no">339</span><span id="line-339"> * @return {@code true} if the new put was executed, {@code false} otherwise.</span> |
| <span class="source-line-no">340</span><span id="line-340"> */</span> |
| <span class="source-line-no">341</span><span id="line-341"> boolean thenPut(Put put) throws IOException;</span> |
| <span class="source-line-no">342</span><span id="line-342"></span> |
| <span class="source-line-no">343</span><span id="line-343"> /**</span> |
| <span class="source-line-no">344</span><span id="line-344"> * Specify a Delete to commit if the check succeeds.</span> |
| <span class="source-line-no">345</span><span id="line-345"> * @param delete data to delete if check succeeds</span> |
| <span class="source-line-no">346</span><span id="line-346"> * @return {@code true} if the new delete was executed, {@code false} otherwise.</span> |
| <span class="source-line-no">347</span><span id="line-347"> */</span> |
| <span class="source-line-no">348</span><span id="line-348"> boolean thenDelete(Delete delete) throws IOException;</span> |
| <span class="source-line-no">349</span><span id="line-349"></span> |
| <span class="source-line-no">350</span><span id="line-350"> /**</span> |
| <span class="source-line-no">351</span><span id="line-351"> * Specify a RowMutations to commit if the check succeeds.</span> |
| <span class="source-line-no">352</span><span id="line-352"> * @param mutation mutations to perform if check succeeds</span> |
| <span class="source-line-no">353</span><span id="line-353"> * @return true if the new mutation was executed, false otherwise.</span> |
| <span class="source-line-no">354</span><span id="line-354"> */</span> |
| <span class="source-line-no">355</span><span id="line-355"> boolean thenMutate(RowMutations mutation) throws IOException;</span> |
| <span class="source-line-no">356</span><span id="line-356"> }</span> |
| <span class="source-line-no">357</span><span id="line-357"></span> |
| <span class="source-line-no">358</span><span id="line-358"> /**</span> |
| <span class="source-line-no">359</span><span id="line-359"> * Atomically checks if a row matches the specified filter. If it does, it adds the</span> |
| <span class="source-line-no">360</span><span id="line-360"> * Put/Delete/RowMutations.</span> |
| <span class="source-line-no">361</span><span id="line-361"> * <p></span> |
| <span class="source-line-no">362</span><span id="line-362"> * Use the returned {@link CheckAndMutateWithFilterBuilder} to construct your request and then</span> |
| <span class="source-line-no">363</span><span id="line-363"> * execute it. This is a fluent style API, the code is like:</span> |
| <span class="source-line-no">364</span><span id="line-364"> *</span> |
| <span class="source-line-no">365</span><span id="line-365"> * <pre></span> |
| <span class="source-line-no">366</span><span id="line-366"> * <code></span> |
| <span class="source-line-no">367</span><span id="line-367"> * table.checkAndMutate(row, filter).thenPut(put);</span> |
| <span class="source-line-no">368</span><span id="line-368"> * </code></span> |
| <span class="source-line-no">369</span><span id="line-369"> * </pre></span> |
| <span class="source-line-no">370</span><span id="line-370"> *</span> |
| <span class="source-line-no">371</span><span id="line-371"> * @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">372</span><span id="line-372"> * any more.</span> |
| <span class="source-line-no">373</span><span id="line-373"> */</span> |
| <span class="source-line-no">374</span><span id="line-374"> @Deprecated</span> |
| <span class="source-line-no">375</span><span id="line-375"> default CheckAndMutateWithFilterBuilder checkAndMutate(byte[] row, Filter filter) {</span> |
| <span class="source-line-no">376</span><span id="line-376"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">377</span><span id="line-377"> }</span> |
| <span class="source-line-no">378</span><span id="line-378"></span> |
| <span class="source-line-no">379</span><span id="line-379"> /**</span> |
| <span class="source-line-no">380</span><span id="line-380"> * A helper class for sending checkAndMutate request with a filter.</span> |
| <span class="source-line-no">381</span><span id="line-381"> * @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">382</span><span id="line-382"> * any more.</span> |
| <span class="source-line-no">383</span><span id="line-383"> */</span> |
| <span class="source-line-no">384</span><span id="line-384"> @Deprecated</span> |
| <span class="source-line-no">385</span><span id="line-385"> interface CheckAndMutateWithFilterBuilder {</span> |
| <span class="source-line-no">386</span><span id="line-386"></span> |
| <span class="source-line-no">387</span><span id="line-387"> /**</span> |
| <span class="source-line-no">388</span><span id="line-388"> * Specify a timerange.</span> |
| <span class="source-line-no">389</span><span id="line-389"> * @param timeRange timeRange to check</span> |
| <span class="source-line-no">390</span><span id="line-390"> */</span> |
| <span class="source-line-no">391</span><span id="line-391"> CheckAndMutateWithFilterBuilder timeRange(TimeRange timeRange);</span> |
| <span class="source-line-no">392</span><span id="line-392"></span> |
| <span class="source-line-no">393</span><span id="line-393"> /**</span> |
| <span class="source-line-no">394</span><span id="line-394"> * Specify a Put to commit if the check succeeds.</span> |
| <span class="source-line-no">395</span><span id="line-395"> * @param put data to put if check succeeds</span> |
| <span class="source-line-no">396</span><span id="line-396"> * @return {@code true} if the new put was executed, {@code false} otherwise.</span> |
| <span class="source-line-no">397</span><span id="line-397"> */</span> |
| <span class="source-line-no">398</span><span id="line-398"> boolean thenPut(Put put) throws IOException;</span> |
| <span class="source-line-no">399</span><span id="line-399"></span> |
| <span class="source-line-no">400</span><span id="line-400"> /**</span> |
| <span class="source-line-no">401</span><span id="line-401"> * Specify a Delete to commit if the check succeeds.</span> |
| <span class="source-line-no">402</span><span id="line-402"> * @param delete data to delete if check succeeds</span> |
| <span class="source-line-no">403</span><span id="line-403"> * @return {@code true} if the new delete was executed, {@code false} otherwise.</span> |
| <span class="source-line-no">404</span><span id="line-404"> */</span> |
| <span class="source-line-no">405</span><span id="line-405"> boolean thenDelete(Delete delete) throws IOException;</span> |
| <span class="source-line-no">406</span><span id="line-406"></span> |
| <span class="source-line-no">407</span><span id="line-407"> /**</span> |
| <span class="source-line-no">408</span><span id="line-408"> * Specify a RowMutations to commit if the check succeeds.</span> |
| <span class="source-line-no">409</span><span id="line-409"> * @param mutation mutations to perform if check succeeds</span> |
| <span class="source-line-no">410</span><span id="line-410"> * @return true if the new mutation was executed, false otherwise.</span> |
| <span class="source-line-no">411</span><span id="line-411"> */</span> |
| <span class="source-line-no">412</span><span id="line-412"> boolean thenMutate(RowMutations mutation) throws IOException;</span> |
| <span class="source-line-no">413</span><span id="line-413"> }</span> |
| <span class="source-line-no">414</span><span id="line-414"></span> |
| <span class="source-line-no">415</span><span id="line-415"> /**</span> |
| <span class="source-line-no">416</span><span id="line-416"> * checkAndMutate that atomically checks if a row matches the specified condition. If it does, it</span> |
| <span class="source-line-no">417</span><span id="line-417"> * performs the specified action.</span> |
| <span class="source-line-no">418</span><span id="line-418"> * @param checkAndMutate The CheckAndMutate object.</span> |
| <span class="source-line-no">419</span><span id="line-419"> * @return A CheckAndMutateResult object that represents the result for the CheckAndMutate.</span> |
| <span class="source-line-no">420</span><span id="line-420"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">421</span><span id="line-421"> */</span> |
| <span class="source-line-no">422</span><span id="line-422"> default CheckAndMutateResult checkAndMutate(CheckAndMutate checkAndMutate) throws IOException {</span> |
| <span class="source-line-no">423</span><span id="line-423"> return checkAndMutate(Collections.singletonList(checkAndMutate)).get(0);</span> |
| <span class="source-line-no">424</span><span id="line-424"> }</span> |
| <span class="source-line-no">425</span><span id="line-425"></span> |
| <span class="source-line-no">426</span><span id="line-426"> /**</span> |
| <span class="source-line-no">427</span><span id="line-427"> * Batch version of checkAndMutate. The specified CheckAndMutates are batched only in the sense</span> |
| <span class="source-line-no">428</span><span id="line-428"> * that they are sent to a RS in one RPC, but each CheckAndMutate operation is still executed</span> |
| <span class="source-line-no">429</span><span id="line-429"> * atomically (and thus, each may fail independently of others).</span> |
| <span class="source-line-no">430</span><span id="line-430"> * @param checkAndMutates The list of CheckAndMutate.</span> |
| <span class="source-line-no">431</span><span id="line-431"> * @return A list of CheckAndMutateResult objects that represents the result for each</span> |
| <span class="source-line-no">432</span><span id="line-432"> * CheckAndMutate.</span> |
| <span class="source-line-no">433</span><span id="line-433"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">434</span><span id="line-434"> */</span> |
| <span class="source-line-no">435</span><span id="line-435"> default List<CheckAndMutateResult> checkAndMutate(List<CheckAndMutate> checkAndMutates)</span> |
| <span class="source-line-no">436</span><span id="line-436"> throws IOException {</span> |
| <span class="source-line-no">437</span><span id="line-437"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">438</span><span id="line-438"> }</span> |
| <span class="source-line-no">439</span><span id="line-439"></span> |
| <span class="source-line-no">440</span><span id="line-440"> /**</span> |
| <span class="source-line-no">441</span><span id="line-441"> * Performs multiple mutations atomically on a single row. Currently {@link Put} and</span> |
| <span class="source-line-no">442</span><span id="line-442"> * {@link Delete} are supported.</span> |
| <span class="source-line-no">443</span><span id="line-443"> * @param rm object that specifies the set of mutations to perform atomically</span> |
| <span class="source-line-no">444</span><span id="line-444"> * @return results of Increment/Append operations</span> |
| <span class="source-line-no">445</span><span id="line-445"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">446</span><span id="line-446"> */</span> |
| <span class="source-line-no">447</span><span id="line-447"> default Result mutateRow(final RowMutations rm) throws IOException {</span> |
| <span class="source-line-no">448</span><span id="line-448"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">449</span><span id="line-449"> }</span> |
| <span class="source-line-no">450</span><span id="line-450"></span> |
| <span class="source-line-no">451</span><span id="line-451"> /**</span> |
| <span class="source-line-no">452</span><span id="line-452"> * Appends values to one or more columns within a single row.</span> |
| <span class="source-line-no">453</span><span id="line-453"> * <p></span> |
| <span class="source-line-no">454</span><span id="line-454"> * This operation guaranteed atomicity to readers. Appends are done under a single row lock, so</span> |
| <span class="source-line-no">455</span><span id="line-455"> * write operations to a row are synchronized, and readers are guaranteed to see this operation</span> |
| <span class="source-line-no">456</span><span id="line-456"> * fully completed.</span> |
| <span class="source-line-no">457</span><span id="line-457"> * @param append object that specifies the columns and values to be appended</span> |
| <span class="source-line-no">458</span><span id="line-458"> * @throws IOException e</span> |
| <span class="source-line-no">459</span><span id="line-459"> * @return values of columns after the append operation (maybe null)</span> |
| <span class="source-line-no">460</span><span id="line-460"> */</span> |
| <span class="source-line-no">461</span><span id="line-461"> default Result append(final Append append) throws IOException {</span> |
| <span class="source-line-no">462</span><span id="line-462"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">463</span><span id="line-463"> }</span> |
| <span class="source-line-no">464</span><span id="line-464"></span> |
| <span class="source-line-no">465</span><span id="line-465"> /**</span> |
| <span class="source-line-no">466</span><span id="line-466"> * Increments one or more columns within a single row.</span> |
| <span class="source-line-no">467</span><span id="line-467"> * <p></span> |
| <span class="source-line-no">468</span><span id="line-468"> * This operation ensures atomicity to readers. Increments are done under a single row lock, so</span> |
| <span class="source-line-no">469</span><span id="line-469"> * write operations to a row are synchronized, and readers are guaranteed to see this operation</span> |
| <span class="source-line-no">470</span><span id="line-470"> * fully completed.</span> |
| <span class="source-line-no">471</span><span id="line-471"> * @param increment object that specifies the columns and amounts to be used for the increment</span> |
| <span class="source-line-no">472</span><span id="line-472"> * operations</span> |
| <span class="source-line-no">473</span><span id="line-473"> * @throws IOException e</span> |
| <span class="source-line-no">474</span><span id="line-474"> * @return values of columns after the increment</span> |
| <span class="source-line-no">475</span><span id="line-475"> */</span> |
| <span class="source-line-no">476</span><span id="line-476"> default Result increment(final Increment increment) throws IOException {</span> |
| <span class="source-line-no">477</span><span id="line-477"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">478</span><span id="line-478"> }</span> |
| <span class="source-line-no">479</span><span id="line-479"></span> |
| <span class="source-line-no">480</span><span id="line-480"> /**</span> |
| <span class="source-line-no">481</span><span id="line-481"> * See {@link #incrementColumnValue(byte[], byte[], byte[], long, Durability)}</span> |
| <span class="source-line-no">482</span><span id="line-482"> * <p></span> |
| <span class="source-line-no">483</span><span id="line-483"> * The {@link Durability} is defaulted to {@link Durability#SYNC_WAL}.</span> |
| <span class="source-line-no">484</span><span id="line-484"> * @param row The row that contains the cell to increment.</span> |
| <span class="source-line-no">485</span><span id="line-485"> * @param family The column family of the cell to increment.</span> |
| <span class="source-line-no">486</span><span id="line-486"> * @param qualifier The column qualifier of the cell to increment.</span> |
| <span class="source-line-no">487</span><span id="line-487"> * @param amount The amount to increment the cell with (or decrement, if the amount is</span> |
| <span class="source-line-no">488</span><span id="line-488"> * negative).</span> |
| <span class="source-line-no">489</span><span id="line-489"> * @return The new value, post increment.</span> |
| <span class="source-line-no">490</span><span id="line-490"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">491</span><span id="line-491"> */</span> |
| <span class="source-line-no">492</span><span id="line-492"> default long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)</span> |
| <span class="source-line-no">493</span><span id="line-493"> throws IOException {</span> |
| <span class="source-line-no">494</span><span id="line-494"> Increment increment = new Increment(row).addColumn(family, qualifier, amount);</span> |
| <span class="source-line-no">495</span><span id="line-495"> Cell cell = increment(increment).getColumnLatestCell(family, qualifier);</span> |
| <span class="source-line-no">496</span><span id="line-496"> return Bytes.toLong(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());</span> |
| <span class="source-line-no">497</span><span id="line-497"> }</span> |
| <span class="source-line-no">498</span><span id="line-498"></span> |
| <span class="source-line-no">499</span><span id="line-499"> /**</span> |
| <span class="source-line-no">500</span><span id="line-500"> * Atomically increments a column value. If the column value already exists and is not a</span> |
| <span class="source-line-no">501</span><span id="line-501"> * big-endian long, this could throw an exception. If the column value does not yet exist it is</span> |
| <span class="source-line-no">502</span><span id="line-502"> * initialized to <code>amount</code> and written to the specified column.</span> |
| <span class="source-line-no">503</span><span id="line-503"> * <p></span> |
| <span class="source-line-no">504</span><span id="line-504"> * Setting durability to {@link Durability#SKIP_WAL} means that in a fail scenario you will lose</span> |
| <span class="source-line-no">505</span><span id="line-505"> * any increments that have not been flushed.</span> |
| <span class="source-line-no">506</span><span id="line-506"> * @param row The row that contains the cell to increment.</span> |
| <span class="source-line-no">507</span><span id="line-507"> * @param family The column family of the cell to increment.</span> |
| <span class="source-line-no">508</span><span id="line-508"> * @param qualifier The column qualifier of the cell to increment.</span> |
| <span class="source-line-no">509</span><span id="line-509"> * @param amount The amount to increment the cell with (or decrement, if the amount is</span> |
| <span class="source-line-no">510</span><span id="line-510"> * negative).</span> |
| <span class="source-line-no">511</span><span id="line-511"> * @param durability The persistence guarantee for this increment.</span> |
| <span class="source-line-no">512</span><span id="line-512"> * @return The new value, post increment.</span> |
| <span class="source-line-no">513</span><span id="line-513"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">514</span><span id="line-514"> */</span> |
| <span class="source-line-no">515</span><span id="line-515"> default long incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount,</span> |
| <span class="source-line-no">516</span><span id="line-516"> Durability durability) throws IOException {</span> |
| <span class="source-line-no">517</span><span id="line-517"> Increment increment =</span> |
| <span class="source-line-no">518</span><span id="line-518"> new Increment(row).addColumn(family, qualifier, amount).setDurability(durability);</span> |
| <span class="source-line-no">519</span><span id="line-519"> Cell cell = increment(increment).getColumnLatestCell(family, qualifier);</span> |
| <span class="source-line-no">520</span><span id="line-520"> return Bytes.toLong(cell.getValueArray(), cell.getValueOffset(), cell.getValueLength());</span> |
| <span class="source-line-no">521</span><span id="line-521"> }</span> |
| <span class="source-line-no">522</span><span id="line-522"></span> |
| <span class="source-line-no">523</span><span id="line-523"> /**</span> |
| <span class="source-line-no">524</span><span id="line-524"> * Releases any resources held or pending changes in internal buffers.</span> |
| <span class="source-line-no">525</span><span id="line-525"> * @throws IOException if a remote or network exception occurs.</span> |
| <span class="source-line-no">526</span><span id="line-526"> */</span> |
| <span class="source-line-no">527</span><span id="line-527"> @Override</span> |
| <span class="source-line-no">528</span><span id="line-528"> default void close() throws IOException {</span> |
| <span class="source-line-no">529</span><span id="line-529"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">530</span><span id="line-530"> }</span> |
| <span class="source-line-no">531</span><span id="line-531"></span> |
| <span class="source-line-no">532</span><span id="line-532"> /**</span> |
| <span class="source-line-no">533</span><span id="line-533"> * Creates and returns a {@link org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel}</span> |
| <span class="source-line-no">534</span><span id="line-534"> * instance connected to the table region containing the specified row. The row given does not</span> |
| <span class="source-line-no">535</span><span id="line-535"> * actually have to exist. Whichever region would contain the row based on start and end keys will</span> |
| <span class="source-line-no">536</span><span id="line-536"> * be used. Note that the {@code row} parameter is also not passed to the coprocessor handler</span> |
| <span class="source-line-no">537</span><span id="line-537"> * registered for this protocol, unless the {@code row} is separately passed as an argument in the</span> |
| <span class="source-line-no">538</span><span id="line-538"> * service request. The parameter here is only used to locate the region used to handle the call.</span> |
| <span class="source-line-no">539</span><span id="line-539"> * <p/></span> |
| <span class="source-line-no">540</span><span id="line-540"> * The obtained {@link org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel} instance can be</span> |
| <span class="source-line-no">541</span><span id="line-541"> * used to access a published coprocessor {@link Service} using standard protobuf service</span> |
| <span class="source-line-no">542</span><span id="line-542"> * invocations:</span> |
| <span class="source-line-no">543</span><span id="line-543"> * <p/></span> |
| <span class="source-line-no">544</span><span id="line-544"> * <div style="background-color: #cccccc; padding: 2px"> <blockquote></span> |
| <span class="source-line-no">545</span><span id="line-545"> *</span> |
| <span class="source-line-no">546</span><span id="line-546"> * <pre></span> |
| <span class="source-line-no">547</span><span id="line-547"> * CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey);</span> |
| <span class="source-line-no">548</span><span id="line-548"> * MyService.BlockingInterface service = MyService.newBlockingStub(channel);</span> |
| <span class="source-line-no">549</span><span id="line-549"> * MyCallRequest request = MyCallRequest.newBuilder()</span> |
| <span class="source-line-no">550</span><span id="line-550"> * ...</span> |
| <span class="source-line-no">551</span><span id="line-551"> * .build();</span> |
| <span class="source-line-no">552</span><span id="line-552"> * MyCallResponse response = service.myCall(null, request);</span> |
| <span class="source-line-no">553</span><span id="line-553"> * </pre></span> |
| <span class="source-line-no">554</span><span id="line-554"> *</span> |
| <span class="source-line-no">555</span><span id="line-555"> * </blockquote> </div></span> |
| <span class="source-line-no">556</span><span id="line-556"> * @param row The row key used to identify the remote region location</span> |
| <span class="source-line-no">557</span><span id="line-557"> * @return A CoprocessorRpcChannel instance</span> |
| <span class="source-line-no">558</span><span id="line-558"> * @deprecated since 3.0.0, will removed in 4.0.0. This is too low level, please stop using it any</span> |
| <span class="source-line-no">559</span><span id="line-559"> * more. Use the coprocessorService methods in {@link AsyncTable} instead.</span> |
| <span class="source-line-no">560</span><span id="line-560"> * @see Connection#toAsyncConnection()</span> |
| <span class="source-line-no">561</span><span id="line-561"> */</span> |
| <span class="source-line-no">562</span><span id="line-562"> @Deprecated</span> |
| <span class="source-line-no">563</span><span id="line-563"> default CoprocessorRpcChannel coprocessorService(byte[] row) {</span> |
| <span class="source-line-no">564</span><span id="line-564"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">565</span><span id="line-565"> }</span> |
| <span class="source-line-no">566</span><span id="line-566"></span> |
| <span class="source-line-no">567</span><span id="line-567"> /**</span> |
| <span class="source-line-no">568</span><span id="line-568"> * Creates an instance of the given {@link Service} subclass for each table region spanning the</span> |
| <span class="source-line-no">569</span><span id="line-569"> * range from the {@code startKey} row to {@code endKey} row (inclusive), and invokes the passed</span> |
| <span class="source-line-no">570</span><span id="line-570"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method with each</span> |
| <span class="source-line-no">571</span><span id="line-571"> * {@link Service} instance.</span> |
| <span class="source-line-no">572</span><span id="line-572"> * @param service the protocol buffer {@code Service} implementation to call</span> |
| <span class="source-line-no">573</span><span id="line-573"> * @param startKey start region selection with region containing this row. If {@code null}, the</span> |
| <span class="source-line-no">574</span><span id="line-574"> * selection will start with the first table region.</span> |
| <span class="source-line-no">575</span><span id="line-575"> * @param endKey select regions up to and including the region containing this row. If</span> |
| <span class="source-line-no">576</span><span id="line-576"> * {@code null}, selection will continue through the last table region.</span> |
| <span class="source-line-no">577</span><span id="line-577"> * @param callable this instance's</span> |
| <span class="source-line-no">578</span><span id="line-578"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method will</span> |
| <span class="source-line-no">579</span><span id="line-579"> * be invoked once per table region, using the {@link Service} instance connected</span> |
| <span class="source-line-no">580</span><span id="line-580"> * to that region.</span> |
| <span class="source-line-no">581</span><span id="line-581"> * @param <T> the {@link Service} subclass to connect to</span> |
| <span class="source-line-no">582</span><span id="line-582"> * @param <R> Return type for the {@code callable} parameter's</span> |
| <span class="source-line-no">583</span><span id="line-583"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method</span> |
| <span class="source-line-no">584</span><span id="line-584"> * @return a map of result values keyed by region name</span> |
| <span class="source-line-no">585</span><span id="line-585"> * @deprecated since 3.0.0, will removed in 4.0.0. The batch call here references the blocking</span> |
| <span class="source-line-no">586</span><span id="line-586"> * interface for of a protobuf stub, so it is not possible to do it in an asynchronous</span> |
| <span class="source-line-no">587</span><span id="line-587"> * way, even if now we are building the {@link Table} implementation based on the</span> |
| <span class="source-line-no">588</span><span id="line-588"> * {@link AsyncTable}, which is not good. Use the coprocessorService methods in</span> |
| <span class="source-line-no">589</span><span id="line-589"> * {@link AsyncTable} directly instead.</span> |
| <span class="source-line-no">590</span><span id="line-590"> * @see Connection#toAsyncConnection()</span> |
| <span class="source-line-no">591</span><span id="line-591"> */</span> |
| <span class="source-line-no">592</span><span id="line-592"> @Deprecated</span> |
| <span class="source-line-no">593</span><span id="line-593"> default <T extends Service, R> Map<byte[], R> coprocessorService(final Class<T> service,</span> |
| <span class="source-line-no">594</span><span id="line-594"> byte[] startKey, byte[] endKey, final Batch.Call<T, R> callable)</span> |
| <span class="source-line-no">595</span><span id="line-595"> throws ServiceException, Throwable {</span> |
| <span class="source-line-no">596</span><span id="line-596"> Map<byte[], R> results =</span> |
| <span class="source-line-no">597</span><span id="line-597"> Collections.synchronizedMap(new TreeMap<byte[], R>(Bytes.BYTES_COMPARATOR));</span> |
| <span class="source-line-no">598</span><span id="line-598"> coprocessorService(service, startKey, endKey, callable, new Batch.Callback<R>() {</span> |
| <span class="source-line-no">599</span><span id="line-599"> @Override</span> |
| <span class="source-line-no">600</span><span id="line-600"> public void update(byte[] region, byte[] row, R value) {</span> |
| <span class="source-line-no">601</span><span id="line-601"> if (region != null) {</span> |
| <span class="source-line-no">602</span><span id="line-602"> results.put(region, value);</span> |
| <span class="source-line-no">603</span><span id="line-603"> }</span> |
| <span class="source-line-no">604</span><span id="line-604"> }</span> |
| <span class="source-line-no">605</span><span id="line-605"> });</span> |
| <span class="source-line-no">606</span><span id="line-606"> return results;</span> |
| <span class="source-line-no">607</span><span id="line-607"> }</span> |
| <span class="source-line-no">608</span><span id="line-608"></span> |
| <span class="source-line-no">609</span><span id="line-609"> /**</span> |
| <span class="source-line-no">610</span><span id="line-610"> * Creates an instance of the given {@link Service} subclass for each table region spanning the</span> |
| <span class="source-line-no">611</span><span id="line-611"> * range from the {@code startKey} row to {@code endKey} row (inclusive), and invokes the passed</span> |
| <span class="source-line-no">612</span><span id="line-612"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method with each</span> |
| <span class="source-line-no">613</span><span id="line-613"> * {@link Service} instance.</span> |
| <span class="source-line-no">614</span><span id="line-614"> * <p/></span> |
| <span class="source-line-no">615</span><span id="line-615"> * The given</span> |
| <span class="source-line-no">616</span><span id="line-616"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}</span> |
| <span class="source-line-no">617</span><span id="line-617"> * method will be called with the return value from each region's</span> |
| <span class="source-line-no">618</span><span id="line-618"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} invocation.</span> |
| <span class="source-line-no">619</span><span id="line-619"> * @param service the protocol buffer {@code Service} implementation to call</span> |
| <span class="source-line-no">620</span><span id="line-620"> * @param startKey start region selection with region containing this row. If {@code null}, the</span> |
| <span class="source-line-no">621</span><span id="line-621"> * selection will start with the first table region.</span> |
| <span class="source-line-no">622</span><span id="line-622"> * @param endKey select regions up to and including the region containing this row. If</span> |
| <span class="source-line-no">623</span><span id="line-623"> * {@code null}, selection will continue through the last table region.</span> |
| <span class="source-line-no">624</span><span id="line-624"> * @param callable this instance's</span> |
| <span class="source-line-no">625</span><span id="line-625"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method will</span> |
| <span class="source-line-no">626</span><span id="line-626"> * be invoked once per table region, using the {@link Service} instance connected</span> |
| <span class="source-line-no">627</span><span id="line-627"> * to that region.</span> |
| <span class="source-line-no">628</span><span id="line-628"> * @param <T> the {@link Service} subclass to connect to</span> |
| <span class="source-line-no">629</span><span id="line-629"> * @param <R> Return type for the {@code callable} parameter's</span> |
| <span class="source-line-no">630</span><span id="line-630"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Call#call} method</span> |
| <span class="source-line-no">631</span><span id="line-631"> * @deprecated since 3.0.0, will removed in 4.0.0. The batch call here references the blocking</span> |
| <span class="source-line-no">632</span><span id="line-632"> * interface for of a protobuf stub, so it is not possible to do it in an asynchronous</span> |
| <span class="source-line-no">633</span><span id="line-633"> * way, even if now we are building the {@link Table} implementation based on the</span> |
| <span class="source-line-no">634</span><span id="line-634"> * {@link AsyncTable}, which is not good. Use the coprocessorService methods in</span> |
| <span class="source-line-no">635</span><span id="line-635"> * {@link AsyncTable} directly instead.</span> |
| <span class="source-line-no">636</span><span id="line-636"> * @see Connection#toAsyncConnection()</span> |
| <span class="source-line-no">637</span><span id="line-637"> */</span> |
| <span class="source-line-no">638</span><span id="line-638"> @Deprecated</span> |
| <span class="source-line-no">639</span><span id="line-639"> default <T extends Service, R> void coprocessorService(final Class<T> service, byte[] startKey,</span> |
| <span class="source-line-no">640</span><span id="line-640"> byte[] endKey, final Batch.Call<T, R> callable, final Batch.Callback<R> callback)</span> |
| <span class="source-line-no">641</span><span id="line-641"> throws ServiceException, Throwable {</span> |
| <span class="source-line-no">642</span><span id="line-642"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">643</span><span id="line-643"> }</span> |
| <span class="source-line-no">644</span><span id="line-644"></span> |
| <span class="source-line-no">645</span><span id="line-645"> /**</span> |
| <span class="source-line-no">646</span><span id="line-646"> * Creates an instance of the given {@link Service} subclass for each table region spanning the</span> |
| <span class="source-line-no">647</span><span id="line-647"> * range from the {@code startKey} row to {@code endKey} row (inclusive), all the invocations to</span> |
| <span class="source-line-no">648</span><span id="line-648"> * the same region server will be batched into one call. The coprocessor service is invoked</span> |
| <span class="source-line-no">649</span><span id="line-649"> * according to the service instance, method name and parameters.</span> |
| <span class="source-line-no">650</span><span id="line-650"> * @param methodDescriptor the descriptor for the protobuf service method to call.</span> |
| <span class="source-line-no">651</span><span id="line-651"> * @param request the method call parameters</span> |
| <span class="source-line-no">652</span><span id="line-652"> * @param startKey start region selection with region containing this row. If</span> |
| <span class="source-line-no">653</span><span id="line-653"> * {@code null}, the selection will start with the first table region.</span> |
| <span class="source-line-no">654</span><span id="line-654"> * @param endKey select regions up to and including the region containing this row. If</span> |
| <span class="source-line-no">655</span><span id="line-655"> * {@code null}, selection will continue through the last table region.</span> |
| <span class="source-line-no">656</span><span id="line-656"> * @param responsePrototype the proto type of the response of the method in Service.</span> |
| <span class="source-line-no">657</span><span id="line-657"> * @param <R> the response type for the coprocessor Service method</span> |
| <span class="source-line-no">658</span><span id="line-658"> * @return a map of result values keyed by region name</span> |
| <span class="source-line-no">659</span><span id="line-659"> * @deprecated since 3.0.0, will removed in 4.0.0. The batch call here references the blocking</span> |
| <span class="source-line-no">660</span><span id="line-660"> * interface for of a protobuf stub, so it is not possible to do it in an asynchronous</span> |
| <span class="source-line-no">661</span><span id="line-661"> * way, even if now we are building the {@link Table} implementation based on the</span> |
| <span class="source-line-no">662</span><span id="line-662"> * {@link AsyncTable}, which is not good. Use the coprocessorService methods in</span> |
| <span class="source-line-no">663</span><span id="line-663"> * {@link AsyncTable} directly instead.</span> |
| <span class="source-line-no">664</span><span id="line-664"> * @see Connection#toAsyncConnection()</span> |
| <span class="source-line-no">665</span><span id="line-665"> */</span> |
| <span class="source-line-no">666</span><span id="line-666"> @Deprecated</span> |
| <span class="source-line-no">667</span><span id="line-667"> default <R extends Message> Map<byte[], R> batchCoprocessorService(</span> |
| <span class="source-line-no">668</span><span id="line-668"> Descriptors.MethodDescriptor methodDescriptor, Message request, byte[] startKey, byte[] endKey,</span> |
| <span class="source-line-no">669</span><span id="line-669"> R responsePrototype) throws ServiceException, Throwable {</span> |
| <span class="source-line-no">670</span><span id="line-670"> final Map<byte[], R> results =</span> |
| <span class="source-line-no">671</span><span id="line-671"> Collections.synchronizedMap(new TreeMap<byte[], R>(Bytes.BYTES_COMPARATOR));</span> |
| <span class="source-line-no">672</span><span id="line-672"> batchCoprocessorService(methodDescriptor, request, startKey, endKey, responsePrototype,</span> |
| <span class="source-line-no">673</span><span id="line-673"> new Batch.Callback<R>() {</span> |
| <span class="source-line-no">674</span><span id="line-674"> @Override</span> |
| <span class="source-line-no">675</span><span id="line-675"> public void update(byte[] region, byte[] row, R result) {</span> |
| <span class="source-line-no">676</span><span id="line-676"> if (region != null) {</span> |
| <span class="source-line-no">677</span><span id="line-677"> results.put(region, result);</span> |
| <span class="source-line-no">678</span><span id="line-678"> }</span> |
| <span class="source-line-no">679</span><span id="line-679"> }</span> |
| <span class="source-line-no">680</span><span id="line-680"> });</span> |
| <span class="source-line-no">681</span><span id="line-681"> return results;</span> |
| <span class="source-line-no">682</span><span id="line-682"> }</span> |
| <span class="source-line-no">683</span><span id="line-683"></span> |
| <span class="source-line-no">684</span><span id="line-684"> /**</span> |
| <span class="source-line-no">685</span><span id="line-685"> * Creates an instance of the given {@link Service} subclass for each table region spanning the</span> |
| <span class="source-line-no">686</span><span id="line-686"> * range from the {@code startKey} row to {@code endKey} row (inclusive), all the invocations to</span> |
| <span class="source-line-no">687</span><span id="line-687"> * the same region server will be batched into one call. The coprocessor service is invoked</span> |
| <span class="source-line-no">688</span><span id="line-688"> * according to the service instance, method name and parameters.</span> |
| <span class="source-line-no">689</span><span id="line-689"> * <p/></span> |
| <span class="source-line-no">690</span><span id="line-690"> * The given</span> |
| <span class="source-line-no">691</span><span id="line-691"> * {@link org.apache.hadoop.hbase.client.coprocessor.Batch.Callback#update(byte[],byte[],Object)}</span> |
| <span class="source-line-no">692</span><span id="line-692"> * method will be called with the return value from each region's invocation.</span> |
| <span class="source-line-no">693</span><span id="line-693"> * @param methodDescriptor the descriptor for the protobuf service method to call.</span> |
| <span class="source-line-no">694</span><span id="line-694"> * @param request the method call parameters</span> |
| <span class="source-line-no">695</span><span id="line-695"> * @param startKey start region selection with region containing this row. If</span> |
| <span class="source-line-no">696</span><span id="line-696"> * {@code null}, the selection will start with the first table region.</span> |
| <span class="source-line-no">697</span><span id="line-697"> * @param endKey select regions up to and including the region containing this row. If</span> |
| <span class="source-line-no">698</span><span id="line-698"> * {@code null}, selection will continue through the last table region.</span> |
| <span class="source-line-no">699</span><span id="line-699"> * @param responsePrototype the proto type of the response of the method in Service.</span> |
| <span class="source-line-no">700</span><span id="line-700"> * @param callback callback to invoke with the response for each region</span> |
| <span class="source-line-no">701</span><span id="line-701"> * @param <R> the response type for the coprocessor Service method</span> |
| <span class="source-line-no">702</span><span id="line-702"> * @deprecated since 3.0.0, will removed in 4.0.0. The batch call here references the blocking</span> |
| <span class="source-line-no">703</span><span id="line-703"> * interface for of a protobuf stub, so it is not possible to do it in an asynchronous</span> |
| <span class="source-line-no">704</span><span id="line-704"> * way, even if now we are building the {@link Table} implementation based on the</span> |
| <span class="source-line-no">705</span><span id="line-705"> * {@link AsyncTable}, which is not good. Use the coprocessorService methods in</span> |
| <span class="source-line-no">706</span><span id="line-706"> * {@link AsyncTable} directly instead.</span> |
| <span class="source-line-no">707</span><span id="line-707"> * @see Connection#toAsyncConnection()</span> |
| <span class="source-line-no">708</span><span id="line-708"> */</span> |
| <span class="source-line-no">709</span><span id="line-709"> @Deprecated</span> |
| <span class="source-line-no">710</span><span id="line-710"> default <R extends Message> void batchCoprocessorService(</span> |
| <span class="source-line-no">711</span><span id="line-711"> Descriptors.MethodDescriptor methodDescriptor, Message request, byte[] startKey, byte[] endKey,</span> |
| <span class="source-line-no">712</span><span id="line-712"> R responsePrototype, Batch.Callback<R> callback) throws ServiceException, Throwable {</span> |
| <span class="source-line-no">713</span><span id="line-713"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">714</span><span id="line-714"> }</span> |
| <span class="source-line-no">715</span><span id="line-715"></span> |
| <span class="source-line-no">716</span><span id="line-716"> /**</span> |
| <span class="source-line-no">717</span><span id="line-717"> * Get timeout of each rpc request in this Table instance. It will be overridden by a more</span> |
| <span class="source-line-no">718</span><span id="line-718"> * specific rpc timeout config such as readRpcTimeout or writeRpcTimeout.</span> |
| <span class="source-line-no">719</span><span id="line-719"> * @see #getReadRpcTimeout(TimeUnit)</span> |
| <span class="source-line-no">720</span><span id="line-720"> * @see #getWriteRpcTimeout(TimeUnit)</span> |
| <span class="source-line-no">721</span><span id="line-721"> * @param unit the unit of time the timeout to be represented in</span> |
| <span class="source-line-no">722</span><span id="line-722"> * @return rpc timeout in the specified time unit</span> |
| <span class="source-line-no">723</span><span id="line-723"> */</span> |
| <span class="source-line-no">724</span><span id="line-724"> default long getRpcTimeout(TimeUnit unit) {</span> |
| <span class="source-line-no">725</span><span id="line-725"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">726</span><span id="line-726"> }</span> |
| <span class="source-line-no">727</span><span id="line-727"></span> |
| <span class="source-line-no">728</span><span id="line-728"> /**</span> |
| <span class="source-line-no">729</span><span id="line-729"> * Get timeout of each rpc read request in this Table instance.</span> |
| <span class="source-line-no">730</span><span id="line-730"> * @param unit the unit of time the timeout to be represented in</span> |
| <span class="source-line-no">731</span><span id="line-731"> * @return read rpc timeout in the specified time unit</span> |
| <span class="source-line-no">732</span><span id="line-732"> */</span> |
| <span class="source-line-no">733</span><span id="line-733"> default long getReadRpcTimeout(TimeUnit unit) {</span> |
| <span class="source-line-no">734</span><span id="line-734"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">735</span><span id="line-735"> }</span> |
| <span class="source-line-no">736</span><span id="line-736"></span> |
| <span class="source-line-no">737</span><span id="line-737"> /**</span> |
| <span class="source-line-no">738</span><span id="line-738"> * Get timeout of each rpc write request in this Table instance.</span> |
| <span class="source-line-no">739</span><span id="line-739"> * @param unit the unit of time the timeout to be represented in</span> |
| <span class="source-line-no">740</span><span id="line-740"> * @return write rpc timeout in the specified time unit</span> |
| <span class="source-line-no">741</span><span id="line-741"> */</span> |
| <span class="source-line-no">742</span><span id="line-742"> default long getWriteRpcTimeout(TimeUnit unit) {</span> |
| <span class="source-line-no">743</span><span id="line-743"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">744</span><span id="line-744"> }</span> |
| <span class="source-line-no">745</span><span id="line-745"></span> |
| <span class="source-line-no">746</span><span id="line-746"> /**</span> |
| <span class="source-line-no">747</span><span id="line-747"> * Get timeout of each operation in Table instance.</span> |
| <span class="source-line-no">748</span><span id="line-748"> * @param unit the unit of time the timeout to be represented in</span> |
| <span class="source-line-no">749</span><span id="line-749"> * @return operation rpc timeout in the specified time unit</span> |
| <span class="source-line-no">750</span><span id="line-750"> */</span> |
| <span class="source-line-no">751</span><span id="line-751"> default long getOperationTimeout(TimeUnit unit) {</span> |
| <span class="source-line-no">752</span><span id="line-752"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">753</span><span id="line-753"> }</span> |
| <span class="source-line-no">754</span><span id="line-754"></span> |
| <span class="source-line-no">755</span><span id="line-755"> /**</span> |
| <span class="source-line-no">756</span><span id="line-756"> * Get the attributes to be submitted with requests</span> |
| <span class="source-line-no">757</span><span id="line-757"> * @return map of request attributes</span> |
| <span class="source-line-no">758</span><span id="line-758"> */</span> |
| <span class="source-line-no">759</span><span id="line-759"> default Map<String, byte[]> getRequestAttributes() {</span> |
| <span class="source-line-no">760</span><span id="line-760"> throw new NotImplementedException("Add an implementation!");</span> |
| <span class="source-line-no">761</span><span id="line-761"> }</span> |
| <span class="source-line-no">762</span><span id="line-762">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
