| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.client, interface: AsyncClusterConnection"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.util.List;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.concurrent.CompletableFuture;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.RegionLocations;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ServerName;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.ipc.RpcClient;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.Pair;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.wal.WAL.Entry;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.zookeeper.MasterAddressTracker;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.security.token.Token;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.FlushRegionResponse;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * The asynchronous connection for internal usage.</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.Private</span> |
| <span class="source-line-no">038</span><span id="line-38">public interface AsyncClusterConnection extends AsyncConnection {</span> |
| <span class="source-line-no">039</span><span id="line-39"></span> |
| <span class="source-line-no">040</span><span id="line-40"> /**</span> |
| <span class="source-line-no">041</span><span id="line-41"> * Get the admin service for the given region server.</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43"> AsyncRegionServerAdmin getRegionServerAdmin(ServerName serverName);</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> /**</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Get the nonce generator for this connection.</span> |
| <span class="source-line-no">047</span><span id="line-47"> */</span> |
| <span class="source-line-no">048</span><span id="line-48"> NonceGenerator getNonceGenerator();</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> /**</span> |
| <span class="source-line-no">051</span><span id="line-51"> * Get the rpc client we used to communicate with other servers.</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53"> RpcClient getRpcClient();</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /**</span> |
| <span class="source-line-no">056</span><span id="line-56"> * Flush a region and get the response.</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> CompletableFuture<FlushRegionResponse> flush(byte[] regionName, boolean writeFlushWALMarker);</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"> * Return all the replicas for a region. Used for region replica replication.</span> |
| <span class="source-line-no">062</span><span id="line-62"> */</span> |
| <span class="source-line-no">063</span><span id="line-63"> CompletableFuture<RegionLocations> getRegionLocations(TableName tableName, byte[] row,</span> |
| <span class="source-line-no">064</span><span id="line-64"> boolean reload);</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /**</span> |
| <span class="source-line-no">067</span><span id="line-67"> * Return the token for this bulk load.</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> CompletableFuture<String> prepareBulkLoad(TableName tableName);</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> /**</span> |
| <span class="source-line-no">072</span><span id="line-72"> * Securely bulk load a list of HFiles, passing additional list of clusters ids tracking clusters</span> |
| <span class="source-line-no">073</span><span id="line-73"> * where the given bulk load has already been processed (important for bulk loading replication).</span> |
| <span class="source-line-no">074</span><span id="line-74"> * <p/></span> |
| <span class="source-line-no">075</span><span id="line-75"> * Defined as default here to avoid breaking callers who rely on the bulkLoad version that does</span> |
| <span class="source-line-no">076</span><span id="line-76"> * not expect additional clusterIds param.</span> |
| <span class="source-line-no">077</span><span id="line-77"> * @param tableName the target table</span> |
| <span class="source-line-no">078</span><span id="line-78"> * @param familyPaths hdfs path for the the table family dirs containg files to be loaded.</span> |
| <span class="source-line-no">079</span><span id="line-79"> * @param row row key.</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @param assignSeqNum seq num for the event on WAL.</span> |
| <span class="source-line-no">081</span><span id="line-81"> * @param userToken user token.</span> |
| <span class="source-line-no">082</span><span id="line-82"> * @param bulkToken bulk load token.</span> |
| <span class="source-line-no">083</span><span id="line-83"> * @param copyFiles flag for copying the loaded hfiles.</span> |
| <span class="source-line-no">084</span><span id="line-84"> * @param clusterIds list of cluster ids where the given bulk load has already been processed.</span> |
| <span class="source-line-no">085</span><span id="line-85"> * @param replicate flags if the bulkload is targeted for replication.</span> |
| <span class="source-line-no">086</span><span id="line-86"> */</span> |
| <span class="source-line-no">087</span><span id="line-87"> CompletableFuture<Boolean> bulkLoad(TableName tableName, List<Pair<byte[], String>> familyPaths,</span> |
| <span class="source-line-no">088</span><span id="line-88"> byte[] row, boolean assignSeqNum, Token<?> userToken, String bulkToken, boolean copyFiles,</span> |
| <span class="source-line-no">089</span><span id="line-89"> List<String> clusterIds, boolean replicate);</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /**</span> |
| <span class="source-line-no">092</span><span id="line-92"> * Clean up after finishing bulk load, no matter success or not.</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> CompletableFuture<Void> cleanupBulkLoad(TableName tableName, String bulkToken);</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * Get live region servers from masters.</span> |
| <span class="source-line-no">098</span><span id="line-98"> */</span> |
| <span class="source-line-no">099</span><span id="line-99"> CompletableFuture<List<ServerName>> getLiveRegionServers(MasterAddressTracker masterAddrTracker,</span> |
| <span class="source-line-no">100</span><span id="line-100"> int count);</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * Get the bootstrap node list of another region server.</span> |
| <span class="source-line-no">104</span><span id="line-104"> */</span> |
| <span class="source-line-no">105</span><span id="line-105"> CompletableFuture<List<ServerName>> getAllBootstrapNodes(ServerName regionServer);</span> |
| <span class="source-line-no">106</span><span id="line-106"></span> |
| <span class="source-line-no">107</span><span id="line-107"> /**</span> |
| <span class="source-line-no">108</span><span id="line-108"> * Replicate wal edits to a secondary replica.</span> |
| <span class="source-line-no">109</span><span id="line-109"> */</span> |
| <span class="source-line-no">110</span><span id="line-110"> CompletableFuture<Void> replicate(RegionInfo replica, List<Entry> entries, int numRetries,</span> |
| <span class="source-line-no">111</span><span id="line-111"> long rpcTimeoutNs, long operationTimeoutNs);</span> |
| <span class="source-line-no">112</span><span id="line-112">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
