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