blob: 2c7e4a2b6e62090ff855ab05c93870cd8b5ffe0d [file] [log] [blame]
<!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, class: ClientMetaTableAccessor, interface: CloseableVisitor">
<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;</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 static org.apache.hadoop.hbase.client.RegionLocator.LOCATOR_META_REPLICAS_MODE;</span>
<span class="source-line-no">021</span><span id="line-21">import static org.apache.hadoop.hbase.util.FutureUtils.addListener;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">import java.io.Closeable;</span>
<span class="source-line-no">024</span><span id="line-24">import java.io.IOException;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.ArrayList;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Collections;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.List;</span>
<span class="source-line-no">028</span><span id="line-28">import java.util.Optional;</span>
<span class="source-line-no">029</span><span id="line-29">import java.util.concurrent.CompletableFuture;</span>
<span class="source-line-no">030</span><span id="line-30">import java.util.concurrent.ThreadLocalRandom;</span>
<span class="source-line-no">031</span><span id="line-31">import java.util.stream.Collectors;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.client.AdvancedScanResultConsumer;</span>
<span class="source-line-no">033</span><span id="line-33">import org.apache.hadoop.hbase.client.AsyncTable;</span>
<span class="source-line-no">034</span><span id="line-34">import org.apache.hadoop.hbase.client.Consistency;</span>
<span class="source-line-no">035</span><span id="line-35">import org.apache.hadoop.hbase.client.Get;</span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hadoop.hbase.client.RegionInfo;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hadoop.hbase.client.Result;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hadoop.hbase.client.Scan;</span>
<span class="source-line-no">039</span><span id="line-39">import org.apache.hadoop.hbase.client.Scan.ReadType;</span>
<span class="source-line-no">040</span><span id="line-40">import org.apache.hadoop.hbase.client.TableState;</span>
<span class="source-line-no">041</span><span id="line-41">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">042</span><span id="line-42">import org.apache.hadoop.hbase.util.Pair;</span>
<span class="source-line-no">043</span><span id="line-43">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">044</span><span id="line-44">import org.slf4j.Logger;</span>
<span class="source-line-no">045</span><span id="line-45">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47">/**</span>
<span class="source-line-no">048</span><span id="line-48"> * The (asynchronous) meta table accessor used at client side. Used to read/write region and</span>
<span class="source-line-no">049</span><span id="line-49"> * assignment information store in &lt;code&gt;hbase:meta&lt;/code&gt;.</span>
<span class="source-line-no">050</span><span id="line-50"> * @since 2.0.0</span>
<span class="source-line-no">051</span><span id="line-51"> * @see CatalogFamilyFormat</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Private</span>
<span class="source-line-no">054</span><span id="line-54">public final class ClientMetaTableAccessor {</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> private static final Logger LOG = LoggerFactory.getLogger(ClientMetaTableAccessor.class);</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> private ClientMetaTableAccessor() {</span>
<span class="source-line-no">059</span><span id="line-59"> }</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> @InterfaceAudience.Private</span>
<span class="source-line-no">062</span><span id="line-62"> @SuppressWarnings("ImmutableEnumChecker")</span>
<span class="source-line-no">063</span><span id="line-63"> public enum QueryType {</span>
<span class="source-line-no">064</span><span id="line-64"> ALL(HConstants.TABLE_FAMILY, HConstants.CATALOG_FAMILY),</span>
<span class="source-line-no">065</span><span id="line-65"> REGION(HConstants.CATALOG_FAMILY),</span>
<span class="source-line-no">066</span><span id="line-66"> TABLE(HConstants.TABLE_FAMILY),</span>
<span class="source-line-no">067</span><span id="line-67"> REPLICATION(HConstants.REPLICATION_BARRIER_FAMILY);</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> private final byte[][] families;</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> QueryType(byte[]... families) {</span>
<span class="source-line-no">072</span><span id="line-72"> this.families = families;</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> byte[][] getFamilies() {</span>
<span class="source-line-no">076</span><span id="line-76"> return this.families;</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> public static CompletableFuture&lt;Boolean&gt; tableExists(AsyncTable&lt;?&gt; metaTable,</span>
<span class="source-line-no">081</span><span id="line-81"> TableName tableName) {</span>
<span class="source-line-no">082</span><span id="line-82"> return getTableState(metaTable, tableName).thenApply(Optional::isPresent);</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> public static CompletableFuture&lt;Optional&lt;TableState&gt;&gt; getTableState(AsyncTable&lt;?&gt; metaTable,</span>
<span class="source-line-no">086</span><span id="line-86"> TableName tableName) {</span>
<span class="source-line-no">087</span><span id="line-87"> CompletableFuture&lt;Optional&lt;TableState&gt;&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">088</span><span id="line-88"> Get get = new Get(tableName.getName()).addColumn(HConstants.TABLE_FAMILY,</span>
<span class="source-line-no">089</span><span id="line-89"> HConstants.TABLE_STATE_QUALIFIER);</span>
<span class="source-line-no">090</span><span id="line-90"> addListener(metaTable.get(get), (result, error) -&gt; {</span>
<span class="source-line-no">091</span><span id="line-91"> if (error != null) {</span>
<span class="source-line-no">092</span><span id="line-92"> future.completeExceptionally(error);</span>
<span class="source-line-no">093</span><span id="line-93"> return;</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"> try {</span>
<span class="source-line-no">096</span><span id="line-96"> future.complete(getTableState(result));</span>
<span class="source-line-no">097</span><span id="line-97"> } catch (IOException e) {</span>
<span class="source-line-no">098</span><span id="line-98"> future.completeExceptionally(e);</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"> });</span>
<span class="source-line-no">101</span><span id="line-101"> return future;</span>
<span class="source-line-no">102</span><span id="line-102"> }</span>
<span class="source-line-no">103</span><span id="line-103"></span>
<span class="source-line-no">104</span><span id="line-104"> /** Returns the HRegionLocation from meta for the given region */</span>
<span class="source-line-no">105</span><span id="line-105"> public static CompletableFuture&lt;Optional&lt;HRegionLocation&gt;&gt;</span>
<span class="source-line-no">106</span><span id="line-106"> getRegionLocation(AsyncTable&lt;?&gt; metaTable, byte[] regionName) {</span>
<span class="source-line-no">107</span><span id="line-107"> CompletableFuture&lt;Optional&lt;HRegionLocation&gt;&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">108</span><span id="line-108"> try {</span>
<span class="source-line-no">109</span><span id="line-109"> RegionInfo parsedRegionInfo = CatalogFamilyFormat.parseRegionInfoFromRegionName(regionName);</span>
<span class="source-line-no">110</span><span id="line-110"> addListener(metaTable.get(new Get(CatalogFamilyFormat.getMetaKeyForRegion(parsedRegionInfo))</span>
<span class="source-line-no">111</span><span id="line-111"> .addFamily(HConstants.CATALOG_FAMILY)), (r, err) -&gt; {</span>
<span class="source-line-no">112</span><span id="line-112"> if (err != null) {</span>
<span class="source-line-no">113</span><span id="line-113"> future.completeExceptionally(err);</span>
<span class="source-line-no">114</span><span id="line-114"> return;</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"> future.complete(getRegionLocations(r)</span>
<span class="source-line-no">117</span><span id="line-117"> .map(locations -&gt; locations.getRegionLocation(parsedRegionInfo.getReplicaId())));</span>
<span class="source-line-no">118</span><span id="line-118"> });</span>
<span class="source-line-no">119</span><span id="line-119"> } catch (IOException parseEx) {</span>
<span class="source-line-no">120</span><span id="line-120"> LOG.warn("Failed to parse the passed region name: " + Bytes.toStringBinary(regionName));</span>
<span class="source-line-no">121</span><span id="line-121"> future.completeExceptionally(parseEx);</span>
<span class="source-line-no">122</span><span id="line-122"> }</span>
<span class="source-line-no">123</span><span id="line-123"> return future;</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"> /** Returns the HRegionLocation from meta for the given encoded region name */</span>
<span class="source-line-no">127</span><span id="line-127"> public static CompletableFuture&lt;Optional&lt;HRegionLocation&gt;&gt;</span>
<span class="source-line-no">128</span><span id="line-128"> getRegionLocationWithEncodedName(AsyncTable&lt;?&gt; metaTable, byte[] encodedRegionName) {</span>
<span class="source-line-no">129</span><span id="line-129"> CompletableFuture&lt;Optional&lt;HRegionLocation&gt;&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">130</span><span id="line-130"> addListener(</span>
<span class="source-line-no">131</span><span id="line-131"> metaTable</span>
<span class="source-line-no">132</span><span id="line-132"> .scanAll(new Scan().setReadType(ReadType.PREAD).addFamily(HConstants.CATALOG_FAMILY)),</span>
<span class="source-line-no">133</span><span id="line-133"> (results, err) -&gt; {</span>
<span class="source-line-no">134</span><span id="line-134"> if (err != null) {</span>
<span class="source-line-no">135</span><span id="line-135"> future.completeExceptionally(err);</span>
<span class="source-line-no">136</span><span id="line-136"> return;</span>
<span class="source-line-no">137</span><span id="line-137"> }</span>
<span class="source-line-no">138</span><span id="line-138"> String encodedRegionNameStr = Bytes.toString(encodedRegionName);</span>
<span class="source-line-no">139</span><span id="line-139"> results.stream().filter(result -&gt; !result.isEmpty())</span>
<span class="source-line-no">140</span><span id="line-140"> .filter(result -&gt; CatalogFamilyFormat.getRegionInfo(result) != null).forEach(result -&gt; {</span>
<span class="source-line-no">141</span><span id="line-141"> getRegionLocations(result).ifPresent(locations -&gt; {</span>
<span class="source-line-no">142</span><span id="line-142"> for (HRegionLocation location : locations.getRegionLocations()) {</span>
<span class="source-line-no">143</span><span id="line-143"> if (</span>
<span class="source-line-no">144</span><span id="line-144"> location != null</span>
<span class="source-line-no">145</span><span id="line-145"> &amp;&amp; encodedRegionNameStr.equals(location.getRegion().getEncodedName())</span>
<span class="source-line-no">146</span><span id="line-146"> ) {</span>
<span class="source-line-no">147</span><span id="line-147"> future.complete(Optional.of(location));</span>
<span class="source-line-no">148</span><span id="line-148"> return;</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"> });</span>
<span class="source-line-no">152</span><span id="line-152"> });</span>
<span class="source-line-no">153</span><span id="line-153"> future.complete(Optional.empty());</span>
<span class="source-line-no">154</span><span id="line-154"> });</span>
<span class="source-line-no">155</span><span id="line-155"> return future;</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"></span>
<span class="source-line-no">158</span><span id="line-158"> private static Optional&lt;TableState&gt; getTableState(Result r) throws IOException {</span>
<span class="source-line-no">159</span><span id="line-159"> return Optional.ofNullable(CatalogFamilyFormat.getTableState(r));</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> /**</span>
<span class="source-line-no">163</span><span id="line-163"> * Used to get all region locations for the specific table</span>
<span class="source-line-no">164</span><span id="line-164"> * @param metaTable scanner over meta table</span>
<span class="source-line-no">165</span><span id="line-165"> * @param tableName table we're looking for, can be null for getting all regions</span>
<span class="source-line-no">166</span><span id="line-166"> * @return the list of region locations. The return value will be wrapped by a</span>
<span class="source-line-no">167</span><span id="line-167"> * {@link CompletableFuture}.</span>
<span class="source-line-no">168</span><span id="line-168"> */</span>
<span class="source-line-no">169</span><span id="line-169"> public static CompletableFuture&lt;List&lt;HRegionLocation&gt;&gt; getTableHRegionLocations(</span>
<span class="source-line-no">170</span><span id="line-170"> AsyncTable&lt;AdvancedScanResultConsumer&gt; metaTable, TableName tableName) {</span>
<span class="source-line-no">171</span><span id="line-171"> CompletableFuture&lt;List&lt;HRegionLocation&gt;&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">172</span><span id="line-172"> addListener(getTableRegionsAndLocations(metaTable, tableName, true), (locations, err) -&gt; {</span>
<span class="source-line-no">173</span><span id="line-173"> if (err != null) {</span>
<span class="source-line-no">174</span><span id="line-174"> future.completeExceptionally(err);</span>
<span class="source-line-no">175</span><span id="line-175"> } else if (locations == null || locations.isEmpty()) {</span>
<span class="source-line-no">176</span><span id="line-176"> future.complete(Collections.emptyList());</span>
<span class="source-line-no">177</span><span id="line-177"> } else {</span>
<span class="source-line-no">178</span><span id="line-178"> List&lt;HRegionLocation&gt; regionLocations =</span>
<span class="source-line-no">179</span><span id="line-179"> locations.stream().map(loc -&gt; new HRegionLocation(loc.getFirst(), loc.getSecond()))</span>
<span class="source-line-no">180</span><span id="line-180"> .collect(Collectors.toList());</span>
<span class="source-line-no">181</span><span id="line-181"> future.complete(regionLocations);</span>
<span class="source-line-no">182</span><span id="line-182"> }</span>
<span class="source-line-no">183</span><span id="line-183"> });</span>
<span class="source-line-no">184</span><span id="line-184"> return future;</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"> * Used to get table regions' info and server.</span>
<span class="source-line-no">189</span><span id="line-189"> * @param metaTable scanner over meta table</span>
<span class="source-line-no">190</span><span id="line-190"> * @param tableName table we're looking for, can be null for getting all regions</span>
<span class="source-line-no">191</span><span id="line-191"> * @param excludeOfflinedSplitParents don't return split parents</span>
<span class="source-line-no">192</span><span id="line-192"> * @return the list of regioninfos and server. The return value will be wrapped by a</span>
<span class="source-line-no">193</span><span id="line-193"> * {@link CompletableFuture}.</span>
<span class="source-line-no">194</span><span id="line-194"> */</span>
<span class="source-line-no">195</span><span id="line-195"> private static CompletableFuture&lt;List&lt;Pair&lt;RegionInfo, ServerName&gt;&gt;&gt; getTableRegionsAndLocations(</span>
<span class="source-line-no">196</span><span id="line-196"> final AsyncTable&lt;AdvancedScanResultConsumer&gt; metaTable, final TableName tableName,</span>
<span class="source-line-no">197</span><span id="line-197"> final boolean excludeOfflinedSplitParents) {</span>
<span class="source-line-no">198</span><span id="line-198"> CompletableFuture&lt;List&lt;Pair&lt;RegionInfo, ServerName&gt;&gt;&gt; future = new CompletableFuture&lt;&gt;();</span>
<span class="source-line-no">199</span><span id="line-199"> if (TableName.META_TABLE_NAME.equals(tableName)) {</span>
<span class="source-line-no">200</span><span id="line-200"> future.completeExceptionally(new IOException(</span>
<span class="source-line-no">201</span><span id="line-201"> "This method can't be used to locate meta regions;" + " use MetaTableLocator instead"));</span>
<span class="source-line-no">202</span><span id="line-202"> }</span>
<span class="source-line-no">203</span><span id="line-203"></span>
<span class="source-line-no">204</span><span id="line-204"> // Make a version of CollectingVisitor that collects RegionInfo and ServerAddress</span>
<span class="source-line-no">205</span><span id="line-205"> CollectRegionLocationsVisitor visitor =</span>
<span class="source-line-no">206</span><span id="line-206"> new CollectRegionLocationsVisitor(excludeOfflinedSplitParents);</span>
<span class="source-line-no">207</span><span id="line-207"></span>
<span class="source-line-no">208</span><span id="line-208"> addListener(scanMeta(metaTable, tableName, QueryType.REGION, visitor), (v, error) -&gt; {</span>
<span class="source-line-no">209</span><span id="line-209"> if (error != null) {</span>
<span class="source-line-no">210</span><span id="line-210"> future.completeExceptionally(error);</span>
<span class="source-line-no">211</span><span id="line-211"> return;</span>
<span class="source-line-no">212</span><span id="line-212"> }</span>
<span class="source-line-no">213</span><span id="line-213"> future.complete(visitor.getResults());</span>
<span class="source-line-no">214</span><span id="line-214"> });</span>
<span class="source-line-no">215</span><span id="line-215"> return future;</span>
<span class="source-line-no">216</span><span id="line-216"> }</span>
<span class="source-line-no">217</span><span id="line-217"></span>
<span class="source-line-no">218</span><span id="line-218"> /**</span>
<span class="source-line-no">219</span><span id="line-219"> * Performs a scan of META table for given table.</span>
<span class="source-line-no">220</span><span id="line-220"> * @param metaTable scanner over meta table</span>
<span class="source-line-no">221</span><span id="line-221"> * @param tableName table within we scan</span>
<span class="source-line-no">222</span><span id="line-222"> * @param type scanned part of meta</span>
<span class="source-line-no">223</span><span id="line-223"> * @param visitor Visitor invoked against each row</span>
<span class="source-line-no">224</span><span id="line-224"> */</span>
<span class="source-line-no">225</span><span id="line-225"> private static CompletableFuture&lt;Void&gt; scanMeta(AsyncTable&lt;AdvancedScanResultConsumer&gt; metaTable,</span>
<span class="source-line-no">226</span><span id="line-226"> TableName tableName, QueryType type, final Visitor visitor) {</span>
<span class="source-line-no">227</span><span id="line-227"> return scanMeta(metaTable, getTableStartRowForMeta(tableName, type),</span>
<span class="source-line-no">228</span><span id="line-228"> getTableStopRowForMeta(tableName, type), type, Integer.MAX_VALUE, visitor);</span>
<span class="source-line-no">229</span><span id="line-229"> }</span>
<span class="source-line-no">230</span><span id="line-230"></span>
<span class="source-line-no">231</span><span id="line-231"> /**</span>
<span class="source-line-no">232</span><span id="line-232"> * Performs a scan of META table for given table.</span>
<span class="source-line-no">233</span><span id="line-233"> * @param metaTable scanner over meta table</span>
<span class="source-line-no">234</span><span id="line-234"> * @param startRow Where to start the scan</span>
<span class="source-line-no">235</span><span id="line-235"> * @param stopRow Where to stop the scan</span>
<span class="source-line-no">236</span><span id="line-236"> * @param type scanned part of meta</span>
<span class="source-line-no">237</span><span id="line-237"> * @param maxRows maximum rows to return</span>
<span class="source-line-no">238</span><span id="line-238"> * @param visitor Visitor invoked against each row</span>
<span class="source-line-no">239</span><span id="line-239"> */</span>
<span class="source-line-no">240</span><span id="line-240"> private static CompletableFuture&lt;Void&gt; scanMeta(AsyncTable&lt;AdvancedScanResultConsumer&gt; metaTable,</span>
<span class="source-line-no">241</span><span id="line-241"> byte[] startRow, byte[] stopRow, QueryType type, int maxRows, final Visitor visitor) {</span>
<span class="source-line-no">242</span><span id="line-242"> int rowUpperLimit = maxRows &gt; 0 ? maxRows : Integer.MAX_VALUE;</span>
<span class="source-line-no">243</span><span id="line-243"> Scan scan = getMetaScan(metaTable, rowUpperLimit);</span>
<span class="source-line-no">244</span><span id="line-244"> for (byte[] family : type.getFamilies()) {</span>
<span class="source-line-no">245</span><span id="line-245"> scan.addFamily(family);</span>
<span class="source-line-no">246</span><span id="line-246"> }</span>
<span class="source-line-no">247</span><span id="line-247"> if (startRow != null) {</span>
<span class="source-line-no">248</span><span id="line-248"> scan.withStartRow(startRow);</span>
<span class="source-line-no">249</span><span id="line-249"> }</span>
<span class="source-line-no">250</span><span id="line-250"> if (stopRow != null) {</span>
<span class="source-line-no">251</span><span id="line-251"> scan.withStopRow(stopRow);</span>
<span class="source-line-no">252</span><span id="line-252"> }</span>
<span class="source-line-no">253</span><span id="line-253"></span>
<span class="source-line-no">254</span><span id="line-254"> if (LOG.isDebugEnabled()) {</span>
<span class="source-line-no">255</span><span id="line-255"> LOG.debug("Scanning META" + " starting at row=" + Bytes.toStringBinary(scan.getStartRow())</span>
<span class="source-line-no">256</span><span id="line-256"> + " stopping at row=" + Bytes.toStringBinary(scan.getStopRow()) + " for max="</span>
<span class="source-line-no">257</span><span id="line-257"> + rowUpperLimit + " with caching=" + scan.getCaching());</span>
<span class="source-line-no">258</span><span id="line-258"> }</span>
<span class="source-line-no">259</span><span id="line-259"></span>
<span class="source-line-no">260</span><span id="line-260"> CompletableFuture&lt;Void&gt; future = new CompletableFuture&lt;Void&gt;();</span>
<span class="source-line-no">261</span><span id="line-261"> // Get the region locator's meta replica mode.</span>
<span class="source-line-no">262</span><span id="line-262"> CatalogReplicaMode metaReplicaMode = CatalogReplicaMode.fromString(metaTable.getConfiguration()</span>
<span class="source-line-no">263</span><span id="line-263"> .get(LOCATOR_META_REPLICAS_MODE, CatalogReplicaMode.NONE.toString()));</span>
<span class="source-line-no">264</span><span id="line-264"></span>
<span class="source-line-no">265</span><span id="line-265"> if (metaReplicaMode == CatalogReplicaMode.LOAD_BALANCE) {</span>
<span class="source-line-no">266</span><span id="line-266"> addListener(metaTable.getDescriptor(), (desc, error) -&gt; {</span>
<span class="source-line-no">267</span><span id="line-267"> if (error != null) {</span>
<span class="source-line-no">268</span><span id="line-268"> LOG.error("Failed to get meta table descriptor, error: ", error);</span>
<span class="source-line-no">269</span><span id="line-269"> future.completeExceptionally(error);</span>
<span class="source-line-no">270</span><span id="line-270"> return;</span>
<span class="source-line-no">271</span><span id="line-271"> }</span>
<span class="source-line-no">272</span><span id="line-272"></span>
<span class="source-line-no">273</span><span id="line-273"> int numOfReplicas = desc.getRegionReplication();</span>
<span class="source-line-no">274</span><span id="line-274"> if (numOfReplicas &gt; 1) {</span>
<span class="source-line-no">275</span><span id="line-275"> int replicaId = ThreadLocalRandom.current().nextInt(numOfReplicas);</span>
<span class="source-line-no">276</span><span id="line-276"></span>
<span class="source-line-no">277</span><span id="line-277"> // When the replicaId is 0, do not set to Consistency.TIMELINE</span>
<span class="source-line-no">278</span><span id="line-278"> if (replicaId &gt; 0) {</span>
<span class="source-line-no">279</span><span id="line-279"> scan.setReplicaId(replicaId);</span>
<span class="source-line-no">280</span><span id="line-280"> scan.setConsistency(Consistency.TIMELINE);</span>
<span class="source-line-no">281</span><span id="line-281"> }</span>
<span class="source-line-no">282</span><span id="line-282"> }</span>
<span class="source-line-no">283</span><span id="line-283"> metaTable.scan(scan, new MetaTableScanResultConsumer(rowUpperLimit, visitor, future));</span>
<span class="source-line-no">284</span><span id="line-284"> });</span>
<span class="source-line-no">285</span><span id="line-285"> } else {</span>
<span class="source-line-no">286</span><span id="line-286"> if (metaReplicaMode == CatalogReplicaMode.HEDGED_READ) {</span>
<span class="source-line-no">287</span><span id="line-287"> scan.setConsistency(Consistency.TIMELINE);</span>
<span class="source-line-no">288</span><span id="line-288"> }</span>
<span class="source-line-no">289</span><span id="line-289"> metaTable.scan(scan, new MetaTableScanResultConsumer(rowUpperLimit, visitor, future));</span>
<span class="source-line-no">290</span><span id="line-290"> }</span>
<span class="source-line-no">291</span><span id="line-291"></span>
<span class="source-line-no">292</span><span id="line-292"> return future;</span>
<span class="source-line-no">293</span><span id="line-293"> }</span>
<span class="source-line-no">294</span><span id="line-294"></span>
<span class="source-line-no">295</span><span id="line-295"> private static final class MetaTableScanResultConsumer implements AdvancedScanResultConsumer {</span>
<span class="source-line-no">296</span><span id="line-296"></span>
<span class="source-line-no">297</span><span id="line-297"> private int currentRowCount;</span>
<span class="source-line-no">298</span><span id="line-298"></span>
<span class="source-line-no">299</span><span id="line-299"> private final int rowUpperLimit;</span>
<span class="source-line-no">300</span><span id="line-300"></span>
<span class="source-line-no">301</span><span id="line-301"> private final Visitor visitor;</span>
<span class="source-line-no">302</span><span id="line-302"></span>
<span class="source-line-no">303</span><span id="line-303"> private final CompletableFuture&lt;Void&gt; future;</span>
<span class="source-line-no">304</span><span id="line-304"></span>
<span class="source-line-no">305</span><span id="line-305"> MetaTableScanResultConsumer(int rowUpperLimit, Visitor visitor,</span>
<span class="source-line-no">306</span><span id="line-306"> CompletableFuture&lt;Void&gt; future) {</span>
<span class="source-line-no">307</span><span id="line-307"> this.rowUpperLimit = rowUpperLimit;</span>
<span class="source-line-no">308</span><span id="line-308"> this.visitor = visitor;</span>
<span class="source-line-no">309</span><span id="line-309"> this.future = future;</span>
<span class="source-line-no">310</span><span id="line-310"> this.currentRowCount = 0;</span>
<span class="source-line-no">311</span><span id="line-311"> }</span>
<span class="source-line-no">312</span><span id="line-312"></span>
<span class="source-line-no">313</span><span id="line-313"> @Override</span>
<span class="source-line-no">314</span><span id="line-314"> public void onError(Throwable error) {</span>
<span class="source-line-no">315</span><span id="line-315"> future.completeExceptionally(error);</span>
<span class="source-line-no">316</span><span id="line-316"> }</span>
<span class="source-line-no">317</span><span id="line-317"></span>
<span class="source-line-no">318</span><span id="line-318"> @Override</span>
<span class="source-line-no">319</span><span id="line-319"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "NP_NONNULL_PARAM_VIOLATION",</span>
<span class="source-line-no">320</span><span id="line-320"> justification = "https://github.com/findbugsproject/findbugs/issues/79")</span>
<span class="source-line-no">321</span><span id="line-321"> public void onComplete() {</span>
<span class="source-line-no">322</span><span id="line-322"> future.complete(null);</span>
<span class="source-line-no">323</span><span id="line-323"> }</span>
<span class="source-line-no">324</span><span id="line-324"></span>
<span class="source-line-no">325</span><span id="line-325"> @Override</span>
<span class="source-line-no">326</span><span id="line-326"> public void onNext(Result[] results, ScanController controller) {</span>
<span class="source-line-no">327</span><span id="line-327"> boolean terminateScan = false;</span>
<span class="source-line-no">328</span><span id="line-328"> for (Result result : results) {</span>
<span class="source-line-no">329</span><span id="line-329"> try {</span>
<span class="source-line-no">330</span><span id="line-330"> if (!visitor.visit(result)) {</span>
<span class="source-line-no">331</span><span id="line-331"> terminateScan = true;</span>
<span class="source-line-no">332</span><span id="line-332"> break;</span>
<span class="source-line-no">333</span><span id="line-333"> }</span>
<span class="source-line-no">334</span><span id="line-334"> } catch (Exception e) {</span>
<span class="source-line-no">335</span><span id="line-335"> future.completeExceptionally(e);</span>
<span class="source-line-no">336</span><span id="line-336"> terminateScan = true;</span>
<span class="source-line-no">337</span><span id="line-337"> break;</span>
<span class="source-line-no">338</span><span id="line-338"> }</span>
<span class="source-line-no">339</span><span id="line-339"> if (++currentRowCount &gt;= rowUpperLimit) {</span>
<span class="source-line-no">340</span><span id="line-340"> terminateScan = true;</span>
<span class="source-line-no">341</span><span id="line-341"> break;</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"> if (terminateScan) {</span>
<span class="source-line-no">345</span><span id="line-345"> controller.terminate();</span>
<span class="source-line-no">346</span><span id="line-346"> }</span>
<span class="source-line-no">347</span><span id="line-347"> }</span>
<span class="source-line-no">348</span><span id="line-348"> }</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"> * Implementations 'visit' a catalog table row.</span>
<span class="source-line-no">352</span><span id="line-352"> */</span>
<span class="source-line-no">353</span><span id="line-353"> public interface Visitor {</span>
<span class="source-line-no">354</span><span id="line-354"> /**</span>
<span class="source-line-no">355</span><span id="line-355"> * Visit the catalog table row.</span>
<span class="source-line-no">356</span><span id="line-356"> * @param r A row from catalog table</span>
<span class="source-line-no">357</span><span id="line-357"> * @return True if we are to proceed scanning the table, else false if we are to stop now.</span>
<span class="source-line-no">358</span><span id="line-358"> */</span>
<span class="source-line-no">359</span><span id="line-359"> boolean visit(final Result r) throws IOException;</span>
<span class="source-line-no">360</span><span id="line-360"> }</span>
<span class="source-line-no">361</span><span id="line-361"></span>
<span class="source-line-no">362</span><span id="line-362"> /**</span>
<span class="source-line-no">363</span><span id="line-363"> * Implementations 'visit' a catalog table row but with close() at the end.</span>
<span class="source-line-no">364</span><span id="line-364"> */</span>
<span class="source-line-no">365</span><span id="line-365"> public interface CloseableVisitor extends Visitor, Closeable {</span>
<span class="source-line-no">366</span><span id="line-366"> }</span>
<span class="source-line-no">367</span><span id="line-367"></span>
<span class="source-line-no">368</span><span id="line-368"> /**</span>
<span class="source-line-no">369</span><span id="line-369"> * A {@link Visitor} that collects content out of passed {@link Result}.</span>
<span class="source-line-no">370</span><span id="line-370"> */</span>
<span class="source-line-no">371</span><span id="line-371"> private static abstract class CollectingVisitor&lt;T&gt; implements Visitor {</span>
<span class="source-line-no">372</span><span id="line-372"> final List&lt;T&gt; results = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">373</span><span id="line-373"></span>
<span class="source-line-no">374</span><span id="line-374"> @Override</span>
<span class="source-line-no">375</span><span id="line-375"> public boolean visit(Result r) throws IOException {</span>
<span class="source-line-no">376</span><span id="line-376"> if (r != null &amp;&amp; !r.isEmpty()) {</span>
<span class="source-line-no">377</span><span id="line-377"> add(r);</span>
<span class="source-line-no">378</span><span id="line-378"> }</span>
<span class="source-line-no">379</span><span id="line-379"> return true;</span>
<span class="source-line-no">380</span><span id="line-380"> }</span>
<span class="source-line-no">381</span><span id="line-381"></span>
<span class="source-line-no">382</span><span id="line-382"> abstract void add(Result r);</span>
<span class="source-line-no">383</span><span id="line-383"></span>
<span class="source-line-no">384</span><span id="line-384"> /** Returns Collected results; wait till visits complete to collect all possible results */</span>
<span class="source-line-no">385</span><span id="line-385"> List&lt;T&gt; getResults() {</span>
<span class="source-line-no">386</span><span id="line-386"> return this.results;</span>
<span class="source-line-no">387</span><span id="line-387"> }</span>
<span class="source-line-no">388</span><span id="line-388"> }</span>
<span class="source-line-no">389</span><span id="line-389"></span>
<span class="source-line-no">390</span><span id="line-390"> static class CollectRegionLocationsVisitor</span>
<span class="source-line-no">391</span><span id="line-391"> extends CollectingVisitor&lt;Pair&lt;RegionInfo, ServerName&gt;&gt; {</span>
<span class="source-line-no">392</span><span id="line-392"></span>
<span class="source-line-no">393</span><span id="line-393"> private final boolean excludeOfflinedSplitParents;</span>
<span class="source-line-no">394</span><span id="line-394"></span>
<span class="source-line-no">395</span><span id="line-395"> private RegionLocations current = null;</span>
<span class="source-line-no">396</span><span id="line-396"></span>
<span class="source-line-no">397</span><span id="line-397"> CollectRegionLocationsVisitor(boolean excludeOfflinedSplitParents) {</span>
<span class="source-line-no">398</span><span id="line-398"> this.excludeOfflinedSplitParents = excludeOfflinedSplitParents;</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"> @Override</span>
<span class="source-line-no">402</span><span id="line-402"> public boolean visit(Result r) throws IOException {</span>
<span class="source-line-no">403</span><span id="line-403"> Optional&lt;RegionLocations&gt; currentRegionLocations = getRegionLocations(r);</span>
<span class="source-line-no">404</span><span id="line-404"> current = currentRegionLocations.orElse(null);</span>
<span class="source-line-no">405</span><span id="line-405"> if (current == null || current.getRegionLocation().getRegion() == null) {</span>
<span class="source-line-no">406</span><span id="line-406"> LOG.warn("No serialized RegionInfo in " + r);</span>
<span class="source-line-no">407</span><span id="line-407"> return true;</span>
<span class="source-line-no">408</span><span id="line-408"> }</span>
<span class="source-line-no">409</span><span id="line-409"> RegionInfo hri = current.getRegionLocation().getRegion();</span>
<span class="source-line-no">410</span><span id="line-410"> if (excludeOfflinedSplitParents &amp;&amp; hri.isSplitParent()) {</span>
<span class="source-line-no">411</span><span id="line-411"> return true;</span>
<span class="source-line-no">412</span><span id="line-412"> }</span>
<span class="source-line-no">413</span><span id="line-413"> // Else call super and add this Result to the collection.</span>
<span class="source-line-no">414</span><span id="line-414"> return super.visit(r);</span>
<span class="source-line-no">415</span><span id="line-415"> }</span>
<span class="source-line-no">416</span><span id="line-416"></span>
<span class="source-line-no">417</span><span id="line-417"> @Override</span>
<span class="source-line-no">418</span><span id="line-418"> void add(Result r) {</span>
<span class="source-line-no">419</span><span id="line-419"> if (current == null) {</span>
<span class="source-line-no">420</span><span id="line-420"> return;</span>
<span class="source-line-no">421</span><span id="line-421"> }</span>
<span class="source-line-no">422</span><span id="line-422"> for (HRegionLocation loc : current.getRegionLocations()) {</span>
<span class="source-line-no">423</span><span id="line-423"> if (loc != null) {</span>
<span class="source-line-no">424</span><span id="line-424"> this.results.add(new Pair&lt;RegionInfo, ServerName&gt;(loc.getRegion(), loc.getServerName()));</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"> }</span>
<span class="source-line-no">428</span><span id="line-428"> }</span>
<span class="source-line-no">429</span><span id="line-429"></span>
<span class="source-line-no">430</span><span id="line-430"> /**</span>
<span class="source-line-no">431</span><span id="line-431"> * Collects all returned.</span>
<span class="source-line-no">432</span><span id="line-432"> */</span>
<span class="source-line-no">433</span><span id="line-433"> static class CollectAllVisitor extends CollectingVisitor&lt;Result&gt; {</span>
<span class="source-line-no">434</span><span id="line-434"> @Override</span>
<span class="source-line-no">435</span><span id="line-435"> void add(Result r) {</span>
<span class="source-line-no">436</span><span id="line-436"> this.results.add(r);</span>
<span class="source-line-no">437</span><span id="line-437"> }</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"> private static Scan getMetaScan(AsyncTable&lt;?&gt; metaTable, int rowUpperLimit) {</span>
<span class="source-line-no">441</span><span id="line-441"> Scan scan = new Scan();</span>
<span class="source-line-no">442</span><span id="line-442"> int scannerCaching = metaTable.getConfiguration().getInt(HConstants.HBASE_META_SCANNER_CACHING,</span>
<span class="source-line-no">443</span><span id="line-443"> HConstants.DEFAULT_HBASE_META_SCANNER_CACHING);</span>
<span class="source-line-no">444</span><span id="line-444"> if (</span>
<span class="source-line-no">445</span><span id="line-445"> metaTable.getConfiguration().getBoolean(HConstants.USE_META_REPLICAS,</span>
<span class="source-line-no">446</span><span id="line-446"> HConstants.DEFAULT_USE_META_REPLICAS)</span>
<span class="source-line-no">447</span><span id="line-447"> ) {</span>
<span class="source-line-no">448</span><span id="line-448"> scan.setConsistency(Consistency.TIMELINE);</span>
<span class="source-line-no">449</span><span id="line-449"> }</span>
<span class="source-line-no">450</span><span id="line-450"> if (rowUpperLimit &lt;= scannerCaching) {</span>
<span class="source-line-no">451</span><span id="line-451"> scan.setLimit(rowUpperLimit);</span>
<span class="source-line-no">452</span><span id="line-452"> }</span>
<span class="source-line-no">453</span><span id="line-453"> int rows = Math.min(rowUpperLimit, scannerCaching);</span>
<span class="source-line-no">454</span><span id="line-454"> scan.setCaching(rows);</span>
<span class="source-line-no">455</span><span id="line-455"> return scan;</span>
<span class="source-line-no">456</span><span id="line-456"> }</span>
<span class="source-line-no">457</span><span id="line-457"></span>
<span class="source-line-no">458</span><span id="line-458"> /** Returns an HRegionLocationList extracted from the result. */</span>
<span class="source-line-no">459</span><span id="line-459"> private static Optional&lt;RegionLocations&gt; getRegionLocations(Result r) {</span>
<span class="source-line-no">460</span><span id="line-460"> return Optional.ofNullable(CatalogFamilyFormat.getRegionLocations(r));</span>
<span class="source-line-no">461</span><span id="line-461"> }</span>
<span class="source-line-no">462</span><span id="line-462"></span>
<span class="source-line-no">463</span><span id="line-463"> /** Returns start row for scanning META according to query type */</span>
<span class="source-line-no">464</span><span id="line-464"> public static byte[] getTableStartRowForMeta(TableName tableName, QueryType type) {</span>
<span class="source-line-no">465</span><span id="line-465"> if (tableName == null) {</span>
<span class="source-line-no">466</span><span id="line-466"> return null;</span>
<span class="source-line-no">467</span><span id="line-467"> }</span>
<span class="source-line-no">468</span><span id="line-468"> switch (type) {</span>
<span class="source-line-no">469</span><span id="line-469"> case REGION:</span>
<span class="source-line-no">470</span><span id="line-470"> case REPLICATION: {</span>
<span class="source-line-no">471</span><span id="line-471"> byte[] startRow = new byte[tableName.getName().length + 2];</span>
<span class="source-line-no">472</span><span id="line-472"> System.arraycopy(tableName.getName(), 0, startRow, 0, tableName.getName().length);</span>
<span class="source-line-no">473</span><span id="line-473"> startRow[startRow.length - 2] = HConstants.DELIMITER;</span>
<span class="source-line-no">474</span><span id="line-474"> startRow[startRow.length - 1] = HConstants.DELIMITER;</span>
<span class="source-line-no">475</span><span id="line-475"> return startRow;</span>
<span class="source-line-no">476</span><span id="line-476"> }</span>
<span class="source-line-no">477</span><span id="line-477"> case ALL:</span>
<span class="source-line-no">478</span><span id="line-478"> case TABLE:</span>
<span class="source-line-no">479</span><span id="line-479"> default: {</span>
<span class="source-line-no">480</span><span id="line-480"> return tableName.getName();</span>
<span class="source-line-no">481</span><span id="line-481"> }</span>
<span class="source-line-no">482</span><span id="line-482"> }</span>
<span class="source-line-no">483</span><span id="line-483"> }</span>
<span class="source-line-no">484</span><span id="line-484"></span>
<span class="source-line-no">485</span><span id="line-485"> /** Returns stop row for scanning META according to query type */</span>
<span class="source-line-no">486</span><span id="line-486"> public static byte[] getTableStopRowForMeta(TableName tableName, QueryType type) {</span>
<span class="source-line-no">487</span><span id="line-487"> if (tableName == null) {</span>
<span class="source-line-no">488</span><span id="line-488"> return null;</span>
<span class="source-line-no">489</span><span id="line-489"> }</span>
<span class="source-line-no">490</span><span id="line-490"> final byte[] stopRow;</span>
<span class="source-line-no">491</span><span id="line-491"> switch (type) {</span>
<span class="source-line-no">492</span><span id="line-492"> case REGION:</span>
<span class="source-line-no">493</span><span id="line-493"> case REPLICATION: {</span>
<span class="source-line-no">494</span><span id="line-494"> stopRow = new byte[tableName.getName().length + 3];</span>
<span class="source-line-no">495</span><span id="line-495"> System.arraycopy(tableName.getName(), 0, stopRow, 0, tableName.getName().length);</span>
<span class="source-line-no">496</span><span id="line-496"> stopRow[stopRow.length - 3] = ' ';</span>
<span class="source-line-no">497</span><span id="line-497"> stopRow[stopRow.length - 2] = HConstants.DELIMITER;</span>
<span class="source-line-no">498</span><span id="line-498"> stopRow[stopRow.length - 1] = HConstants.DELIMITER;</span>
<span class="source-line-no">499</span><span id="line-499"> break;</span>
<span class="source-line-no">500</span><span id="line-500"> }</span>
<span class="source-line-no">501</span><span id="line-501"> case ALL:</span>
<span class="source-line-no">502</span><span id="line-502"> case TABLE:</span>
<span class="source-line-no">503</span><span id="line-503"> default: {</span>
<span class="source-line-no">504</span><span id="line-504"> stopRow = new byte[tableName.getName().length + 1];</span>
<span class="source-line-no">505</span><span id="line-505"> System.arraycopy(tableName.getName(), 0, stopRow, 0, tableName.getName().length);</span>
<span class="source-line-no">506</span><span id="line-506"> stopRow[stopRow.length - 1] = ' ';</span>
<span class="source-line-no">507</span><span id="line-507"> break;</span>
<span class="source-line-no">508</span><span id="line-508"> }</span>
<span class="source-line-no">509</span><span id="line-509"> }</span>
<span class="source-line-no">510</span><span id="line-510"> return stopRow;</span>
<span class="source-line-no">511</span><span id="line-511"> }</span>
<span class="source-line-no">512</span><span id="line-512">}</span>
</pre>
</div>
</main>
</body>
</html>