| <!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: Connection"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.Closeable;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.concurrent.ExecutorService;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.conf.Configuration;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.Abortable;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.ServerName;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.FutureUtils;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">/**</span> |
| <span class="source-line-no">032</span><span id="line-32"> * A cluster connection encapsulating lower level individual connections to actual servers and a</span> |
| <span class="source-line-no">033</span><span id="line-33"> * connection to zookeeper. Connections are instantiated through the {@link ConnectionFactory}</span> |
| <span class="source-line-no">034</span><span id="line-34"> * class. The lifecycle of the connection is managed by the caller, who has to {@link #close()} the</span> |
| <span class="source-line-no">035</span><span id="line-35"> * connection to release the resources.</span> |
| <span class="source-line-no">036</span><span id="line-36"> * <p></span> |
| <span class="source-line-no">037</span><span id="line-37"> * The connection object contains logic to find the master, locate regions out on the cluster, keeps</span> |
| <span class="source-line-no">038</span><span id="line-38"> * a cache of locations and then knows how to re-calibrate after they move. The individual</span> |
| <span class="source-line-no">039</span><span id="line-39"> * connections to servers, meta cache, zookeeper connection, etc are all shared by the {@link Table}</span> |
| <span class="source-line-no">040</span><span id="line-40"> * and {@link Admin} instances obtained from this connection.</span> |
| <span class="source-line-no">041</span><span id="line-41"> * <p></span> |
| <span class="source-line-no">042</span><span id="line-42"> * Connection creation is a heavy-weight operation. Connection implementations are thread-safe, so</span> |
| <span class="source-line-no">043</span><span id="line-43"> * that the client can create a connection once, and share it with different threads. {@link Table}</span> |
| <span class="source-line-no">044</span><span id="line-44"> * and {@link Admin} instances, on the other hand, are light-weight and are not thread-safe.</span> |
| <span class="source-line-no">045</span><span id="line-45"> * Typically, a single connection per client application is instantiated and every thread will</span> |
| <span class="source-line-no">046</span><span id="line-46"> * obtain its own Table instance. Caching or pooling of {@link Table} and {@link Admin} is not</span> |
| <span class="source-line-no">047</span><span id="line-47"> * recommended.</span> |
| <span class="source-line-no">048</span><span id="line-48"> * @see ConnectionFactory</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @since 0.99.0</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51">@InterfaceAudience.Public</span> |
| <span class="source-line-no">052</span><span id="line-52">public interface Connection extends Abortable, Closeable {</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /*</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Implementation notes: - Only allow new style of interfaces: -- All table names are passed as</span> |
| <span class="source-line-no">056</span><span id="line-56"> * TableName. No more byte[] and string arguments -- Most of the classes with names H is</span> |
| <span class="source-line-no">057</span><span id="line-57"> * deprecated in favor of non-H versions (Table, Connection, etc) -- Only real client-facing</span> |
| <span class="source-line-no">058</span><span id="line-58"> * public methods are allowed - Connection should contain only getTable(), getAdmin() kind of</span> |
| <span class="source-line-no">059</span><span id="line-59"> * general methods.</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /** Returns Configuration instance being used by this Connection instance. */</span> |
| <span class="source-line-no">063</span><span id="line-63"> Configuration getConfiguration();</span> |
| <span class="source-line-no">064</span><span id="line-64"></span> |
| <span class="source-line-no">065</span><span id="line-65"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Retrieve a Table implementation for accessing a table. The returned Table is not thread safe, a</span> |
| <span class="source-line-no">067</span><span id="line-67"> * new instance should be created for each using thread. This is a lightweight operation, pooling</span> |
| <span class="source-line-no">068</span><span id="line-68"> * or caching of the returned Table is neither required nor desired.</span> |
| <span class="source-line-no">069</span><span id="line-69"> * <p></span> |
| <span class="source-line-no">070</span><span id="line-70"> * The caller is responsible for calling {@link Table#close()} on the returned table instance.</span> |
| <span class="source-line-no">071</span><span id="line-71"> * <p></span> |
| <span class="source-line-no">072</span><span id="line-72"> * Since 0.98.1 this method no longer checks table existence. An exception will be thrown if the</span> |
| <span class="source-line-no">073</span><span id="line-73"> * table does not exist only when the first operation is attempted.</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @param tableName the name of the table</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @return a Table to use for interactions with this table</span> |
| <span class="source-line-no">076</span><span id="line-76"> */</span> |
| <span class="source-line-no">077</span><span id="line-77"> default Table getTable(TableName tableName) throws IOException {</span> |
| <span class="source-line-no">078</span><span id="line-78"> return getTable(tableName, null);</span> |
| <span class="source-line-no">079</span><span id="line-79"> }</span> |
| <span class="source-line-no">080</span><span id="line-80"></span> |
| <span class="source-line-no">081</span><span id="line-81"> /**</span> |
| <span class="source-line-no">082</span><span id="line-82"> * Retrieve a Table implementation for accessing a table. The returned Table is not thread safe, a</span> |
| <span class="source-line-no">083</span><span id="line-83"> * new instance should be created for each using thread. This is a lightweight operation, pooling</span> |
| <span class="source-line-no">084</span><span id="line-84"> * or caching of the returned Table is neither required nor desired.</span> |
| <span class="source-line-no">085</span><span id="line-85"> * <p></span> |
| <span class="source-line-no">086</span><span id="line-86"> * The caller is responsible for calling {@link Table#close()} on the returned table instance.</span> |
| <span class="source-line-no">087</span><span id="line-87"> * <p></span> |
| <span class="source-line-no">088</span><span id="line-88"> * Since 0.98.1 this method no longer checks table existence. An exception will be thrown if the</span> |
| <span class="source-line-no">089</span><span id="line-89"> * table does not exist only when the first operation is attempted.</span> |
| <span class="source-line-no">090</span><span id="line-90"> * @param tableName the name of the table</span> |
| <span class="source-line-no">091</span><span id="line-91"> * @param pool The thread pool to use for batch operations, null to use a default pool.</span> |
| <span class="source-line-no">092</span><span id="line-92"> * @return a Table to use for interactions with this table</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> default Table getTable(TableName tableName, ExecutorService pool) throws IOException {</span> |
| <span class="source-line-no">095</span><span id="line-95"> return getTableBuilder(tableName, pool).build();</span> |
| <span class="source-line-no">096</span><span id="line-96"> }</span> |
| <span class="source-line-no">097</span><span id="line-97"></span> |
| <span class="source-line-no">098</span><span id="line-98"> /**</span> |
| <span class="source-line-no">099</span><span id="line-99"> * <p></span> |
| <span class="source-line-no">100</span><span id="line-100"> * Retrieve a {@link BufferedMutator} for performing client-side buffering of writes. The</span> |
| <span class="source-line-no">101</span><span id="line-101"> * {@link BufferedMutator} returned by this method is thread-safe. This BufferedMutator will use</span> |
| <span class="source-line-no">102</span><span id="line-102"> * the Connection's ExecutorService. This object can be used for long lived operations.</span> |
| <span class="source-line-no">103</span><span id="line-103"> * </p></span> |
| <span class="source-line-no">104</span><span id="line-104"> * <p></span> |
| <span class="source-line-no">105</span><span id="line-105"> * The caller is responsible for calling {@link BufferedMutator#close()} on the returned</span> |
| <span class="source-line-no">106</span><span id="line-106"> * {@link BufferedMutator} instance.</span> |
| <span class="source-line-no">107</span><span id="line-107"> * </p></span> |
| <span class="source-line-no">108</span><span id="line-108"> * <p></span> |
| <span class="source-line-no">109</span><span id="line-109"> * This accessor will use the connection's ExecutorService and will throw an exception in the main</span> |
| <span class="source-line-no">110</span><span id="line-110"> * thread when an asynchronous exception occurs.</span> |
| <span class="source-line-no">111</span><span id="line-111"> * @param tableName the name of the table</span> |
| <span class="source-line-no">112</span><span id="line-112"> * @return a {@link BufferedMutator} for the supplied tableName.</span> |
| <span class="source-line-no">113</span><span id="line-113"> */</span> |
| <span class="source-line-no">114</span><span id="line-114"> default BufferedMutator getBufferedMutator(TableName tableName) throws IOException {</span> |
| <span class="source-line-no">115</span><span id="line-115"> return getBufferedMutator(new BufferedMutatorParams(tableName));</span> |
| <span class="source-line-no">116</span><span id="line-116"> }</span> |
| <span class="source-line-no">117</span><span id="line-117"></span> |
| <span class="source-line-no">118</span><span id="line-118"> /**</span> |
| <span class="source-line-no">119</span><span id="line-119"> * Retrieve a {@link BufferedMutator} for performing client-side buffering of writes. The</span> |
| <span class="source-line-no">120</span><span id="line-120"> * {@link BufferedMutator} returned by this method is thread-safe. This object can be used for</span> |
| <span class="source-line-no">121</span><span id="line-121"> * long lived table operations. The caller is responsible for calling</span> |
| <span class="source-line-no">122</span><span id="line-122"> * {@link BufferedMutator#close()} on the returned {@link BufferedMutator} instance.</span> |
| <span class="source-line-no">123</span><span id="line-123"> * @param params details on how to instantiate the {@code BufferedMutator}.</span> |
| <span class="source-line-no">124</span><span id="line-124"> * @return a {@link BufferedMutator} for the supplied tableName.</span> |
| <span class="source-line-no">125</span><span id="line-125"> */</span> |
| <span class="source-line-no">126</span><span id="line-126"> BufferedMutator getBufferedMutator(BufferedMutatorParams params) throws IOException;</span> |
| <span class="source-line-no">127</span><span id="line-127"></span> |
| <span class="source-line-no">128</span><span id="line-128"> /**</span> |
| <span class="source-line-no">129</span><span id="line-129"> * Retrieve a RegionLocator implementation to inspect region information on a table. The returned</span> |
| <span class="source-line-no">130</span><span id="line-130"> * RegionLocator is not thread-safe, so a new instance should be created for each using thread.</span> |
| <span class="source-line-no">131</span><span id="line-131"> * This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither</span> |
| <span class="source-line-no">132</span><span id="line-132"> * required nor desired. <br></span> |
| <span class="source-line-no">133</span><span id="line-133"> * The caller is responsible for calling {@link RegionLocator#close()} on the returned</span> |
| <span class="source-line-no">134</span><span id="line-134"> * RegionLocator instance. RegionLocator needs to be unmanaged</span> |
| <span class="source-line-no">135</span><span id="line-135"> * @param tableName Name of the table who's region is to be examined</span> |
| <span class="source-line-no">136</span><span id="line-136"> * @return A RegionLocator instance</span> |
| <span class="source-line-no">137</span><span id="line-137"> */</span> |
| <span class="source-line-no">138</span><span id="line-138"> RegionLocator getRegionLocator(TableName tableName) throws IOException;</span> |
| <span class="source-line-no">139</span><span id="line-139"></span> |
| <span class="source-line-no">140</span><span id="line-140"> /**</span> |
| <span class="source-line-no">141</span><span id="line-141"> * Clear all the entries in the region location cache, for all the tables.</span> |
| <span class="source-line-no">142</span><span id="line-142"> * <p/></span> |
| <span class="source-line-no">143</span><span id="line-143"> * If you only want to clear the cache for a specific table, use</span> |
| <span class="source-line-no">144</span><span id="line-144"> * {@link RegionLocator#clearRegionLocationCache()}.</span> |
| <span class="source-line-no">145</span><span id="line-145"> * <p/></span> |
| <span class="source-line-no">146</span><span id="line-146"> * This may cause performance issue so use it with caution.</span> |
| <span class="source-line-no">147</span><span id="line-147"> */</span> |
| <span class="source-line-no">148</span><span id="line-148"> void clearRegionLocationCache();</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"> * Retrieve an Admin implementation to administer an HBase cluster. The returned Admin is not</span> |
| <span class="source-line-no">152</span><span id="line-152"> * guaranteed to be thread-safe. A new instance should be created for each using thread. This is a</span> |
| <span class="source-line-no">153</span><span id="line-153"> * lightweight operation. Pooling or caching of the returned Admin is not recommended. <br></span> |
| <span class="source-line-no">154</span><span id="line-154"> * The caller is responsible for calling {@link Admin#close()} on the returned Admin instance.</span> |
| <span class="source-line-no">155</span><span id="line-155"> * @return an Admin instance for cluster administration</span> |
| <span class="source-line-no">156</span><span id="line-156"> */</span> |
| <span class="source-line-no">157</span><span id="line-157"> Admin getAdmin() throws IOException;</span> |
| <span class="source-line-no">158</span><span id="line-158"></span> |
| <span class="source-line-no">159</span><span id="line-159"> @Override</span> |
| <span class="source-line-no">160</span><span id="line-160"> void close() throws IOException;</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"> * Returns whether the connection is closed or not.</span> |
| <span class="source-line-no">164</span><span id="line-164"> * @return true if this connection is closed</span> |
| <span class="source-line-no">165</span><span id="line-165"> */</span> |
| <span class="source-line-no">166</span><span id="line-166"> boolean isClosed();</span> |
| <span class="source-line-no">167</span><span id="line-167"></span> |
| <span class="source-line-no">168</span><span id="line-168"> /**</span> |
| <span class="source-line-no">169</span><span id="line-169"> * Returns an {@link TableBuilder} for creating {@link Table}.</span> |
| <span class="source-line-no">170</span><span id="line-170"> * @param tableName the name of the table</span> |
| <span class="source-line-no">171</span><span id="line-171"> * @param pool the thread pool to use for requests like batch and scan</span> |
| <span class="source-line-no">172</span><span id="line-172"> */</span> |
| <span class="source-line-no">173</span><span id="line-173"> TableBuilder getTableBuilder(TableName tableName, ExecutorService pool);</span> |
| <span class="source-line-no">174</span><span id="line-174"></span> |
| <span class="source-line-no">175</span><span id="line-175"> /**</span> |
| <span class="source-line-no">176</span><span id="line-176"> * Convert this connection to an {@link AsyncConnection}.</span> |
| <span class="source-line-no">177</span><span id="line-177"> * <p/></span> |
| <span class="source-line-no">178</span><span id="line-178"> * Usually we will return the same instance if you call this method multiple times so you can</span> |
| <span class="source-line-no">179</span><span id="line-179"> * consider this as a light-weighted operation.</span> |
| <span class="source-line-no">180</span><span id="line-180"> */</span> |
| <span class="source-line-no">181</span><span id="line-181"> AsyncConnection toAsyncConnection();</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"> * Returns the cluster ID unique to this HBase cluster. <br></span> |
| <span class="source-line-no">185</span><span id="line-185"> * The default implementation is added to keep client compatibility.</span> |
| <span class="source-line-no">186</span><span id="line-186"> */</span> |
| <span class="source-line-no">187</span><span id="line-187"> default String getClusterId() {</span> |
| <span class="source-line-no">188</span><span id="line-188"> return null;</span> |
| <span class="source-line-no">189</span><span id="line-189"> }</span> |
| <span class="source-line-no">190</span><span id="line-190"></span> |
| <span class="source-line-no">191</span><span id="line-191"> /**</span> |
| <span class="source-line-no">192</span><span id="line-192"> * Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to</span> |
| <span class="source-line-no">193</span><span id="line-193"> * be thread-safe. A new instance should be created by each thread. This is a lightweight</span> |
| <span class="source-line-no">194</span><span id="line-194"> * operation. Pooling or caching of the returned Hbck instance is not recommended. <br></span> |
| <span class="source-line-no">195</span><span id="line-195"> * The caller is responsible for calling {@link Hbck#close()} on the returned Hbck instance. <br></span> |
| <span class="source-line-no">196</span><span id="line-196"> * This will be used mostly by hbck tool.</span> |
| <span class="source-line-no">197</span><span id="line-197"> * @return an Hbck instance for active master. Active master is fetched from the zookeeper.</span> |
| <span class="source-line-no">198</span><span id="line-198"> */</span> |
| <span class="source-line-no">199</span><span id="line-199"> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.HBCK)</span> |
| <span class="source-line-no">200</span><span id="line-200"> default Hbck getHbck() throws IOException {</span> |
| <span class="source-line-no">201</span><span id="line-201"> return FutureUtils.get(toAsyncConnection().getHbck());</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"> /**</span> |
| <span class="source-line-no">205</span><span id="line-205"> * Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to</span> |
| <span class="source-line-no">206</span><span id="line-206"> * be thread-safe. A new instance should be created by each thread. This is a lightweight</span> |
| <span class="source-line-no">207</span><span id="line-207"> * operation. Pooling or caching of the returned Hbck instance is not recommended. <br></span> |
| <span class="source-line-no">208</span><span id="line-208"> * The caller is responsible for calling {@link Hbck#close()} on the returned Hbck instance. <br></span> |
| <span class="source-line-no">209</span><span id="line-209"> * This will be used mostly by hbck tool. This may only be used to by pass getting registered</span> |
| <span class="source-line-no">210</span><span id="line-210"> * master from ZK. In situations where ZK is not available or active master is not registered with</span> |
| <span class="source-line-no">211</span><span id="line-211"> * ZK and user can get master address by other means, master can be explicitly specified.</span> |
| <span class="source-line-no">212</span><span id="line-212"> * @param masterServer explicit {@link ServerName} for master server</span> |
| <span class="source-line-no">213</span><span id="line-213"> * @return an Hbck instance for a specified master server</span> |
| <span class="source-line-no">214</span><span id="line-214"> */</span> |
| <span class="source-line-no">215</span><span id="line-215"> @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.HBCK)</span> |
| <span class="source-line-no">216</span><span id="line-216"> default Hbck getHbck(ServerName masterServer) throws IOException {</span> |
| <span class="source-line-no">217</span><span id="line-217"> return toAsyncConnection().getHbck(masterServer);</span> |
| <span class="source-line-no">218</span><span id="line-218"> }</span> |
| <span class="source-line-no">219</span><span id="line-219">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
