| <!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: AsyncTableRegionLocator"> |
| <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.util.List;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.CompletableFuture;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.stream.Collectors;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.HRegionLocation;</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.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">/**</span> |
| <span class="source-line-no">029</span><span id="line-29"> * The asynchronous version of RegionLocator.</span> |
| <span class="source-line-no">030</span><span id="line-30"> * <p></span> |
| <span class="source-line-no">031</span><span id="line-31"> * Usually the implementations will not throw any exception directly, you need to get the exception</span> |
| <span class="source-line-no">032</span><span id="line-32"> * from the returned {@link CompletableFuture}.</span> |
| <span class="source-line-no">033</span><span id="line-33"> * @since 2.0.0</span> |
| <span class="source-line-no">034</span><span id="line-34"> */</span> |
| <span class="source-line-no">035</span><span id="line-35">@InterfaceAudience.Public</span> |
| <span class="source-line-no">036</span><span id="line-36">public interface AsyncTableRegionLocator {</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /**</span> |
| <span class="source-line-no">039</span><span id="line-39"> * Gets the fully qualified table name instance of the table whose region we want to locate.</span> |
| <span class="source-line-no">040</span><span id="line-40"> */</span> |
| <span class="source-line-no">041</span><span id="line-41"> TableName getName();</span> |
| <span class="source-line-no">042</span><span id="line-42"></span> |
| <span class="source-line-no">043</span><span id="line-43"> /**</span> |
| <span class="source-line-no">044</span><span id="line-44"> * Finds the region on which the given row is being served. Does not reload the cache.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * <p/></span> |
| <span class="source-line-no">046</span><span id="line-46"> * Returns the location of the region to which the row belongs.</span> |
| <span class="source-line-no">047</span><span id="line-47"> * @param row Row to find.</span> |
| <span class="source-line-no">048</span><span id="line-48"> */</span> |
| <span class="source-line-no">049</span><span id="line-49"> default CompletableFuture<HRegionLocation> getRegionLocation(byte[] row) {</span> |
| <span class="source-line-no">050</span><span id="line-50"> return getRegionLocation(row, false);</span> |
| <span class="source-line-no">051</span><span id="line-51"> }</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Finds the region on which the given row is being served.</span> |
| <span class="source-line-no">055</span><span id="line-55"> * <p/></span> |
| <span class="source-line-no">056</span><span id="line-56"> * Returns the location of the region to which the row belongs.</span> |
| <span class="source-line-no">057</span><span id="line-57"> * @param row Row to find.</span> |
| <span class="source-line-no">058</span><span id="line-58"> * @param reload true to reload information or false to use cached information</span> |
| <span class="source-line-no">059</span><span id="line-59"> */</span> |
| <span class="source-line-no">060</span><span id="line-60"> default CompletableFuture<HRegionLocation> getRegionLocation(byte[] row, boolean reload) {</span> |
| <span class="source-line-no">061</span><span id="line-61"> return getRegionLocation(row, RegionInfo.DEFAULT_REPLICA_ID, reload);</span> |
| <span class="source-line-no">062</span><span id="line-62"> }</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /**</span> |
| <span class="source-line-no">065</span><span id="line-65"> * Finds the region with the given <code>replicaId</code> on which the given row is being served.</span> |
| <span class="source-line-no">066</span><span id="line-66"> * <p/></span> |
| <span class="source-line-no">067</span><span id="line-67"> * Returns the location of the region with the given <code>replicaId</code> to which the row</span> |
| <span class="source-line-no">068</span><span id="line-68"> * belongs.</span> |
| <span class="source-line-no">069</span><span id="line-69"> * @param row Row to find.</span> |
| <span class="source-line-no">070</span><span id="line-70"> * @param replicaId the replica id of the region</span> |
| <span class="source-line-no">071</span><span id="line-71"> */</span> |
| <span class="source-line-no">072</span><span id="line-72"> default CompletableFuture<HRegionLocation> getRegionLocation(byte[] row, int replicaId) {</span> |
| <span class="source-line-no">073</span><span id="line-73"> return getRegionLocation(row, replicaId, false);</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"> /**</span> |
| <span class="source-line-no">077</span><span id="line-77"> * Finds the region with the given <code>replicaId</code> on which the given row is being served.</span> |
| <span class="source-line-no">078</span><span id="line-78"> * <p/></span> |
| <span class="source-line-no">079</span><span id="line-79"> * Returns the location of the region with the given <code>replicaId</code> to which the row</span> |
| <span class="source-line-no">080</span><span id="line-80"> * belongs.</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @param row Row to find.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @param replicaId the replica id of the region</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @param reload true to reload information or false to use cached information</span> |
| <span class="source-line-no">084</span><span id="line-84"> */</span> |
| <span class="source-line-no">085</span><span id="line-85"> CompletableFuture<HRegionLocation> getRegionLocation(byte[] row, int replicaId, boolean reload);</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Find all the replicas for the region on which the given row is being served.</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @param row Row to find.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @return Locations for all the replicas of the row.</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> default CompletableFuture<List<HRegionLocation>> getRegionLocations(byte[] row) {</span> |
| <span class="source-line-no">093</span><span id="line-93"> return getRegionLocations(row, false);</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"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Find all the replicas for the region on which the given row is being served.</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @param row Row to find.</span> |
| <span class="source-line-no">099</span><span id="line-99"> * @param reload true to reload information or false to use cached information</span> |
| <span class="source-line-no">100</span><span id="line-100"> * @return Locations for all the replicas of the row.</span> |
| <span class="source-line-no">101</span><span id="line-101"> */</span> |
| <span class="source-line-no">102</span><span id="line-102"> CompletableFuture<List<HRegionLocation>> getRegionLocations(byte[] row, boolean reload);</span> |
| <span class="source-line-no">103</span><span id="line-103"></span> |
| <span class="source-line-no">104</span><span id="line-104"> /**</span> |
| <span class="source-line-no">105</span><span id="line-105"> * Retrieves all of the regions associated with this table.</span> |
| <span class="source-line-no">106</span><span id="line-106"> * <p/></span> |
| <span class="source-line-no">107</span><span id="line-107"> * Usually we will go to meta table directly in this method so there is no {@code reload}</span> |
| <span class="source-line-no">108</span><span id="line-108"> * parameter.</span> |
| <span class="source-line-no">109</span><span id="line-109"> * <p/></span> |
| <span class="source-line-no">110</span><span id="line-110"> * Notice that the location for region replicas other than the default replica are also returned.</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @return a {@link List} of all regions associated with this table.</span> |
| <span class="source-line-no">112</span><span id="line-112"> */</span> |
| <span class="source-line-no">113</span><span id="line-113"> CompletableFuture<List<HRegionLocation>> getAllRegionLocations();</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /**</span> |
| <span class="source-line-no">116</span><span id="line-116"> * Gets the starting row key for every region in the currently open table.</span> |
| <span class="source-line-no">117</span><span id="line-117"> * <p></span> |
| <span class="source-line-no">118</span><span id="line-118"> * This is mainly useful for the MapReduce integration.</span> |
| <span class="source-line-no">119</span><span id="line-119"> * @return Array of region starting row keys</span> |
| <span class="source-line-no">120</span><span id="line-120"> */</span> |
| <span class="source-line-no">121</span><span id="line-121"> default CompletableFuture<List<byte[]>> getStartKeys() {</span> |
| <span class="source-line-no">122</span><span id="line-122"> return getStartEndKeys().thenApply(</span> |
| <span class="source-line-no">123</span><span id="line-123"> startEndKeys -> startEndKeys.stream().map(Pair::getFirst).collect(Collectors.toList()));</span> |
| <span class="source-line-no">124</span><span id="line-124"> }</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"> * Gets the ending row key for every region in the currently open table.</span> |
| <span class="source-line-no">128</span><span id="line-128"> * <p></span> |
| <span class="source-line-no">129</span><span id="line-129"> * This is mainly useful for the MapReduce integration.</span> |
| <span class="source-line-no">130</span><span id="line-130"> * @return Array of region ending row keys</span> |
| <span class="source-line-no">131</span><span id="line-131"> */</span> |
| <span class="source-line-no">132</span><span id="line-132"> default CompletableFuture<List<byte[]>> getEndKeys() {</span> |
| <span class="source-line-no">133</span><span id="line-133"> return getStartEndKeys().thenApply(</span> |
| <span class="source-line-no">134</span><span id="line-134"> startEndKeys -> startEndKeys.stream().map(Pair::getSecond).collect(Collectors.toList()));</span> |
| <span class="source-line-no">135</span><span id="line-135"> }</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> /**</span> |
| <span class="source-line-no">138</span><span id="line-138"> * Gets the starting and ending row keys for every region in the currently open table.</span> |
| <span class="source-line-no">139</span><span id="line-139"> * <p></span> |
| <span class="source-line-no">140</span><span id="line-140"> * This is mainly useful for the MapReduce integration.</span> |
| <span class="source-line-no">141</span><span id="line-141"> * @return Pair of arrays of region starting and ending row keys</span> |
| <span class="source-line-no">142</span><span id="line-142"> */</span> |
| <span class="source-line-no">143</span><span id="line-143"> default CompletableFuture<List<Pair<byte[], byte[]>>> getStartEndKeys() {</span> |
| <span class="source-line-no">144</span><span id="line-144"> return getAllRegionLocations().thenApply(</span> |
| <span class="source-line-no">145</span><span id="line-145"> locs -> locs.stream().filter(loc -> RegionReplicaUtil.isDefaultReplica(loc.getRegion()))</span> |
| <span class="source-line-no">146</span><span id="line-146"> .map(HRegionLocation::getRegion).map(r -> Pair.newPair(r.getStartKey(), r.getEndKey()))</span> |
| <span class="source-line-no">147</span><span id="line-147"> .collect(Collectors.toList()));</span> |
| <span class="source-line-no">148</span><span id="line-148"> }</span> |
| <span class="source-line-no">149</span><span id="line-149"></span> |
| <span class="source-line-no">150</span><span id="line-150"> /**</span> |
| <span class="source-line-no">151</span><span id="line-151"> * Clear all the entries in the region location cache.</span> |
| <span class="source-line-no">152</span><span id="line-152"> * <p/></span> |
| <span class="source-line-no">153</span><span id="line-153"> * This may cause performance issue so use it with caution.</span> |
| <span class="source-line-no">154</span><span id="line-154"> */</span> |
| <span class="source-line-no">155</span><span id="line-155"> void clearRegionLocationCache();</span> |
| <span class="source-line-no">156</span><span id="line-156">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
