http://git-wip-us.apache.org/repos/asf/hbase-site/blob/8118541f/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html b/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html index 1771444..131c832 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/Admin.html @@ -834,1892 +834,1899 @@ <span class="sourceLineNo">826</span> void flushRegion(byte[] regionName) throws IOException;<a name="line.826"></a> <span class="sourceLineNo">827</span><a name="line.827"></a> <span class="sourceLineNo">828</span> /**<a name="line.828"></a> -<span class="sourceLineNo">829</span> * Compact a table. Asynchronous operation in that this method requests that a<a name="line.829"></a> -<span class="sourceLineNo">830</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.830"></a> -<span class="sourceLineNo">831</span> * (it can take a while).<a name="line.831"></a> -<span class="sourceLineNo">832</span> *<a name="line.832"></a> -<span class="sourceLineNo">833</span> * @param tableName table to compact<a name="line.833"></a> -<span class="sourceLineNo">834</span> * @throws IOException if a remote or network exception occurs<a name="line.834"></a> -<span class="sourceLineNo">835</span> */<a name="line.835"></a> -<span class="sourceLineNo">836</span> void compact(TableName tableName) throws IOException;<a name="line.836"></a> -<span class="sourceLineNo">837</span><a name="line.837"></a> -<span class="sourceLineNo">838</span> /**<a name="line.838"></a> -<span class="sourceLineNo">839</span> * Compact an individual region. Asynchronous operation in that this method requests that a<a name="line.839"></a> -<span class="sourceLineNo">840</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.840"></a> -<span class="sourceLineNo">841</span> * (it can take a while).<a name="line.841"></a> -<span class="sourceLineNo">842</span> *<a name="line.842"></a> -<span class="sourceLineNo">843</span> * @param regionName region to compact<a name="line.843"></a> -<span class="sourceLineNo">844</span> * @throws IOException if a remote or network exception occurs<a name="line.844"></a> -<span class="sourceLineNo">845</span> */<a name="line.845"></a> -<span class="sourceLineNo">846</span> void compactRegion(byte[] regionName) throws IOException;<a name="line.846"></a> -<span class="sourceLineNo">847</span><a name="line.847"></a> -<span class="sourceLineNo">848</span> /**<a name="line.848"></a> -<span class="sourceLineNo">849</span> * Compact a column family within a table. Asynchronous operation in that this method requests<a name="line.849"></a> -<span class="sourceLineNo">850</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.850"></a> -<span class="sourceLineNo">851</span> * (it can take a while).<a name="line.851"></a> -<span class="sourceLineNo">852</span> *<a name="line.852"></a> -<span class="sourceLineNo">853</span> * @param tableName table to compact<a name="line.853"></a> -<span class="sourceLineNo">854</span> * @param columnFamily column family within a table<a name="line.854"></a> -<span class="sourceLineNo">855</span> * @throws IOException if a remote or network exception occurs<a name="line.855"></a> -<span class="sourceLineNo">856</span> */<a name="line.856"></a> -<span class="sourceLineNo">857</span> void compact(TableName tableName, byte[] columnFamily)<a name="line.857"></a> -<span class="sourceLineNo">858</span> throws IOException;<a name="line.858"></a> -<span class="sourceLineNo">859</span><a name="line.859"></a> -<span class="sourceLineNo">860</span> /**<a name="line.860"></a> -<span class="sourceLineNo">861</span> * Compact a column family within a region. Asynchronous operation in that this method requests<a name="line.861"></a> -<span class="sourceLineNo">862</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.862"></a> -<span class="sourceLineNo">863</span> * (it can take a while).<a name="line.863"></a> -<span class="sourceLineNo">864</span> *<a name="line.864"></a> -<span class="sourceLineNo">865</span> * @param regionName region to compact<a name="line.865"></a> -<span class="sourceLineNo">866</span> * @param columnFamily column family within a region<a name="line.866"></a> -<span class="sourceLineNo">867</span> * @throws IOException if a remote or network exception occurs<a name="line.867"></a> -<span class="sourceLineNo">868</span> */<a name="line.868"></a> -<span class="sourceLineNo">869</span> void compactRegion(byte[] regionName, byte[] columnFamily)<a name="line.869"></a> -<span class="sourceLineNo">870</span> throws IOException;<a name="line.870"></a> -<span class="sourceLineNo">871</span><a name="line.871"></a> -<span class="sourceLineNo">872</span> /**<a name="line.872"></a> -<span class="sourceLineNo">873</span> * Compact a table. Asynchronous operation in that this method requests that a<a name="line.873"></a> -<span class="sourceLineNo">874</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.874"></a> -<span class="sourceLineNo">875</span> * (it can take a while).<a name="line.875"></a> -<span class="sourceLineNo">876</span> *<a name="line.876"></a> -<span class="sourceLineNo">877</span> * @param tableName table to compact<a name="line.877"></a> -<span class="sourceLineNo">878</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.878"></a> -<span class="sourceLineNo">879</span> * @throws IOException if a remote or network exception occurs<a name="line.879"></a> -<span class="sourceLineNo">880</span> * @throws InterruptedException<a name="line.880"></a> -<span class="sourceLineNo">881</span> */<a name="line.881"></a> -<span class="sourceLineNo">882</span> void compact(TableName tableName, CompactType compactType)<a name="line.882"></a> -<span class="sourceLineNo">883</span> throws IOException, InterruptedException;<a name="line.883"></a> -<span class="sourceLineNo">884</span><a name="line.884"></a> -<span class="sourceLineNo">885</span> /**<a name="line.885"></a> -<span class="sourceLineNo">886</span> * Compact a column family within a table. Asynchronous operation in that this method<a name="line.886"></a> -<span class="sourceLineNo">887</span> * requests that a Compaction run and then it returns. It does not wait on the<a name="line.887"></a> -<span class="sourceLineNo">888</span> * completion of Compaction (it can take a while).<a name="line.888"></a> -<span class="sourceLineNo">889</span> *<a name="line.889"></a> -<span class="sourceLineNo">890</span> * @param tableName table to compact<a name="line.890"></a> -<span class="sourceLineNo">891</span> * @param columnFamily column family within a table<a name="line.891"></a> -<span class="sourceLineNo">892</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.892"></a> -<span class="sourceLineNo">893</span> * @throws IOException if not a mob column family or if a remote or network exception occurs<a name="line.893"></a> -<span class="sourceLineNo">894</span> * @throws InterruptedException<a name="line.894"></a> -<span class="sourceLineNo">895</span> */<a name="line.895"></a> -<span class="sourceLineNo">896</span> void compact(TableName tableName, byte[] columnFamily, CompactType compactType)<a name="line.896"></a> -<span class="sourceLineNo">897</span> throws IOException, InterruptedException;<a name="line.897"></a> -<span class="sourceLineNo">898</span><a name="line.898"></a> -<span class="sourceLineNo">899</span> /**<a name="line.899"></a> -<span class="sourceLineNo">900</span> * Major compact a table. Asynchronous operation in that this method requests<a name="line.900"></a> -<span class="sourceLineNo">901</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.901"></a> -<span class="sourceLineNo">902</span> * (it can take a while).<a name="line.902"></a> -<span class="sourceLineNo">903</span> *<a name="line.903"></a> -<span class="sourceLineNo">904</span> * @param tableName table to major compact<a name="line.904"></a> -<span class="sourceLineNo">905</span> * @throws IOException if a remote or network exception occurs<a name="line.905"></a> -<span class="sourceLineNo">906</span> */<a name="line.906"></a> -<span class="sourceLineNo">907</span> void majorCompact(TableName tableName) throws IOException;<a name="line.907"></a> -<span class="sourceLineNo">908</span><a name="line.908"></a> -<span class="sourceLineNo">909</span> /**<a name="line.909"></a> -<span class="sourceLineNo">910</span> * Major compact a table or an individual region. Asynchronous operation in that this method requests<a name="line.910"></a> -<span class="sourceLineNo">911</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.911"></a> -<span class="sourceLineNo">912</span> * (it can take a while).<a name="line.912"></a> -<span class="sourceLineNo">913</span> *<a name="line.913"></a> -<span class="sourceLineNo">914</span> * @param regionName region to major compact<a name="line.914"></a> -<span class="sourceLineNo">915</span> * @throws IOException if a remote or network exception occurs<a name="line.915"></a> -<span class="sourceLineNo">916</span> */<a name="line.916"></a> -<span class="sourceLineNo">917</span> void majorCompactRegion(byte[] regionName) throws IOException;<a name="line.917"></a> -<span class="sourceLineNo">918</span><a name="line.918"></a> -<span class="sourceLineNo">919</span> /**<a name="line.919"></a> -<span class="sourceLineNo">920</span> * Major compact a column family within a table. Asynchronous operation in that this method requests<a name="line.920"></a> -<span class="sourceLineNo">921</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.921"></a> -<span class="sourceLineNo">922</span> * (it can take a while).<a name="line.922"></a> -<span class="sourceLineNo">923</span> *<a name="line.923"></a> -<span class="sourceLineNo">924</span> * @param tableName table to major compact<a name="line.924"></a> -<span class="sourceLineNo">925</span> * @param columnFamily column family within a table<a name="line.925"></a> -<span class="sourceLineNo">926</span> * @throws IOException if a remote or network exception occurs<a name="line.926"></a> -<span class="sourceLineNo">927</span> */<a name="line.927"></a> -<span class="sourceLineNo">928</span> void majorCompact(TableName tableName, byte[] columnFamily)<a name="line.928"></a> -<span class="sourceLineNo">929</span> throws IOException;<a name="line.929"></a> -<span class="sourceLineNo">930</span><a name="line.930"></a> -<span class="sourceLineNo">931</span> /**<a name="line.931"></a> -<span class="sourceLineNo">932</span> * Major compact a column family within region. Asynchronous operation in that this method requests<a name="line.932"></a> -<span class="sourceLineNo">933</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.933"></a> -<span class="sourceLineNo">934</span> * (it can take a while).<a name="line.934"></a> -<span class="sourceLineNo">935</span> *<a name="line.935"></a> -<span class="sourceLineNo">936</span> * @param regionName egion to major compact<a name="line.936"></a> -<span class="sourceLineNo">937</span> * @param columnFamily column family within a region<a name="line.937"></a> -<span class="sourceLineNo">938</span> * @throws IOException if a remote or network exception occurs<a name="line.938"></a> -<span class="sourceLineNo">939</span> */<a name="line.939"></a> -<span class="sourceLineNo">940</span> void majorCompactRegion(byte[] regionName, byte[] columnFamily)<a name="line.940"></a> -<span class="sourceLineNo">941</span> throws IOException;<a name="line.941"></a> -<span class="sourceLineNo">942</span><a name="line.942"></a> -<span class="sourceLineNo">943</span> /**<a name="line.943"></a> -<span class="sourceLineNo">944</span> * Major compact a table. Asynchronous operation in that this method requests that a<a name="line.944"></a> -<span class="sourceLineNo">945</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.945"></a> -<span class="sourceLineNo">946</span> * (it can take a while).<a name="line.946"></a> -<span class="sourceLineNo">947</span> *<a name="line.947"></a> -<span class="sourceLineNo">948</span> * @param tableName table to compact<a name="line.948"></a> -<span class="sourceLineNo">949</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.949"></a> -<span class="sourceLineNo">950</span> * @throws IOException if a remote or network exception occurs<a name="line.950"></a> -<span class="sourceLineNo">951</span> * @throws InterruptedException<a name="line.951"></a> -<span class="sourceLineNo">952</span> */<a name="line.952"></a> -<span class="sourceLineNo">953</span> void majorCompact(TableName tableName, CompactType compactType)<a name="line.953"></a> -<span class="sourceLineNo">954</span> throws IOException, InterruptedException;<a name="line.954"></a> -<span class="sourceLineNo">955</span><a name="line.955"></a> -<span class="sourceLineNo">956</span> /**<a name="line.956"></a> -<span class="sourceLineNo">957</span> * Major compact a column family within a table. Asynchronous operation in that this method requests that a<a name="line.957"></a> -<span class="sourceLineNo">958</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.958"></a> -<span class="sourceLineNo">959</span> * (it can take a while).<a name="line.959"></a> -<span class="sourceLineNo">960</span> *<a name="line.960"></a> -<span class="sourceLineNo">961</span> * @param tableName table to compact<a name="line.961"></a> -<span class="sourceLineNo">962</span> * @param columnFamily column family within a table<a name="line.962"></a> -<span class="sourceLineNo">963</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.963"></a> -<span class="sourceLineNo">964</span> * @throws IOException if not a mob column family or if a remote or network exception occurs<a name="line.964"></a> -<span class="sourceLineNo">965</span> * @throws InterruptedException<a name="line.965"></a> -<span class="sourceLineNo">966</span> */<a name="line.966"></a> -<span class="sourceLineNo">967</span> void majorCompact(TableName tableName, byte[] columnFamily, CompactType compactType)<a name="line.967"></a> -<span class="sourceLineNo">968</span> throws IOException, InterruptedException;<a name="line.968"></a> -<span class="sourceLineNo">969</span><a name="line.969"></a> -<span class="sourceLineNo">970</span> /**<a name="line.970"></a> -<span class="sourceLineNo">971</span> * Compact all regions on the region server. Asynchronous operation in that this method requests<a name="line.971"></a> -<span class="sourceLineNo">972</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction (it<a name="line.972"></a> -<span class="sourceLineNo">973</span> * can take a while).<a name="line.973"></a> -<span class="sourceLineNo">974</span> * @param sn the region server name<a name="line.974"></a> -<span class="sourceLineNo">975</span> * @param major if it's major compaction<a name="line.975"></a> -<span class="sourceLineNo">976</span> * @throws IOException if a remote or network exception occurs<a name="line.976"></a> -<span class="sourceLineNo">977</span> * @throws InterruptedException<a name="line.977"></a> -<span class="sourceLineNo">978</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. Use<a name="line.978"></a> -<span class="sourceLineNo">979</span> * {@link #compactRegionServer(ServerName)} or<a name="line.979"></a> -<span class="sourceLineNo">980</span> * {@link #majorCompactRegionServer(ServerName)}.<a name="line.980"></a> -<span class="sourceLineNo">981</span> */<a name="line.981"></a> -<span class="sourceLineNo">982</span> @Deprecated<a name="line.982"></a> -<span class="sourceLineNo">983</span> default void compactRegionServer(ServerName sn, boolean major) throws IOException,<a name="line.983"></a> -<span class="sourceLineNo">984</span> InterruptedException {<a name="line.984"></a> -<span class="sourceLineNo">985</span> if (major) {<a name="line.985"></a> -<span class="sourceLineNo">986</span> majorCompactRegionServer(sn);<a name="line.986"></a> -<span class="sourceLineNo">987</span> } else {<a name="line.987"></a> -<span class="sourceLineNo">988</span> compactRegionServer(sn);<a name="line.988"></a> -<span class="sourceLineNo">989</span> }<a name="line.989"></a> -<span class="sourceLineNo">990</span> }<a name="line.990"></a> -<span class="sourceLineNo">991</span><a name="line.991"></a> -<span class="sourceLineNo">992</span> /**<a name="line.992"></a> -<span class="sourceLineNo">993</span> * Compact all regions on the region server. Asynchronous operation in that this method requests<a name="line.993"></a> -<span class="sourceLineNo">994</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction (it<a name="line.994"></a> -<span class="sourceLineNo">995</span> * can take a while).<a name="line.995"></a> -<span class="sourceLineNo">996</span> * @param serverName the region server name<a name="line.996"></a> -<span class="sourceLineNo">997</span> * @throws IOException if a remote or network exception occurs<a name="line.997"></a> -<span class="sourceLineNo">998</span> */<a name="line.998"></a> -<span class="sourceLineNo">999</span> void compactRegionServer(ServerName serverName) throws IOException;<a name="line.999"></a> -<span class="sourceLineNo">1000</span><a name="line.1000"></a> -<span class="sourceLineNo">1001</span> /**<a name="line.1001"></a> -<span class="sourceLineNo">1002</span> * Major compact all regions on the region server. Asynchronous operation in that this method<a name="line.1002"></a> -<span class="sourceLineNo">1003</span> * requests that a Compaction run and then it returns. It does not wait on the completion of<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> * Compaction (it can take a while).<a name="line.1004"></a> -<span class="sourceLineNo">1005</span> * @param serverName the region server name<a name="line.1005"></a> -<span class="sourceLineNo">1006</span> * @throws IOException if a remote or network exception occurs<a name="line.1006"></a> -<span class="sourceLineNo">1007</span> */<a name="line.1007"></a> -<span class="sourceLineNo">1008</span> void majorCompactRegionServer(ServerName serverName) throws IOException;<a name="line.1008"></a> -<span class="sourceLineNo">1009</span><a name="line.1009"></a> -<span class="sourceLineNo">1010</span> /**<a name="line.1010"></a> -<span class="sourceLineNo">1011</span> * Move the region <code>r</code> to <code>dest</code>.<a name="line.1011"></a> -<span class="sourceLineNo">1012</span> *<a name="line.1012"></a> -<span class="sourceLineNo">1013</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.1013"></a> -<span class="sourceLineNo">1014</span> * suffix: e.g. if regionname is<a name="line.1014"></a> -<span class="sourceLineNo">1015</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.1016"></a> -<span class="sourceLineNo">1017</span> * @param destServerName The servername of the destination regionserver. If passed the empty byte<a name="line.1017"></a> -<span class="sourceLineNo">1018</span> * array we'll assign to a random server. A server name is made of host, port and startcode.<a name="line.1018"></a> -<span class="sourceLineNo">1019</span> * Here is an example: <code> host187.example.com,60020,1289493121758</code><a name="line.1019"></a> -<span class="sourceLineNo">1020</span> * @throws IOException if we can't find a region named<a name="line.1020"></a> -<span class="sourceLineNo">1021</span> * <code>encodedRegionName</code><a name="line.1021"></a> -<span class="sourceLineNo">1022</span> */<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> void move(byte[] encodedRegionName, byte[] destServerName) throws IOException;<a name="line.1023"></a> -<span class="sourceLineNo">1024</span><a name="line.1024"></a> -<span class="sourceLineNo">1025</span> /**<a name="line.1025"></a> -<span class="sourceLineNo">1026</span> * Assign a Region.<a name="line.1026"></a> -<span class="sourceLineNo">1027</span> * @param regionName Region name to assign.<a name="line.1027"></a> -<span class="sourceLineNo">1028</span> */<a name="line.1028"></a> -<span class="sourceLineNo">1029</span> void assign(byte[] regionName) throws IOException;<a name="line.1029"></a> -<span class="sourceLineNo">1030</span><a name="line.1030"></a> -<span class="sourceLineNo">1031</span> /**<a name="line.1031"></a> -<span class="sourceLineNo">1032</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.1032"></a> -<span class="sourceLineNo">1033</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use {@link<a name="line.1033"></a> -<span class="sourceLineNo">1034</span> * #move(byte[], byte[])} if you want to control the region movement.<a name="line.1034"></a> -<span class="sourceLineNo">1035</span> *<a name="line.1035"></a> -<span class="sourceLineNo">1036</span> * @param regionName Region to unassign. Will clear any existing RegionPlan if one found.<a name="line.1036"></a> -<span class="sourceLineNo">1037</span> * @param force If <code>true</code>, force unassign (Will remove region from regions-in-transition too if<a name="line.1037"></a> -<span class="sourceLineNo">1038</span> * present. If results in double assignment use hbck -fix to resolve. To be used by experts).<a name="line.1038"></a> -<span class="sourceLineNo">1039</span> */<a name="line.1039"></a> -<span class="sourceLineNo">1040</span> void unassign(byte[] regionName, boolean force)<a name="line.1040"></a> -<span class="sourceLineNo">1041</span> throws IOException;<a name="line.1041"></a> -<span class="sourceLineNo">1042</span><a name="line.1042"></a> -<span class="sourceLineNo">1043</span> /**<a name="line.1043"></a> -<span class="sourceLineNo">1044</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.1044"></a> -<span class="sourceLineNo">1045</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.1045"></a> -<span class="sourceLineNo">1046</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.1046"></a> -<span class="sourceLineNo">1047</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> * experts or hbck.<a name="line.1048"></a> -<span class="sourceLineNo">1049</span> *<a name="line.1049"></a> -<span class="sourceLineNo">1050</span> * @param regionName Region to offline.<a name="line.1050"></a> -<span class="sourceLineNo">1051</span> * @throws IOException<a name="line.1051"></a> -<span class="sourceLineNo">1052</span> */<a name="line.1052"></a> -<span class="sourceLineNo">1053</span> void offline(byte[] regionName) throws IOException;<a name="line.1053"></a> -<span class="sourceLineNo">1054</span><a name="line.1054"></a> -<span class="sourceLineNo">1055</span> /**<a name="line.1055"></a> -<span class="sourceLineNo">1056</span> * Turn the load balancer on or off.<a name="line.1056"></a> -<span class="sourceLineNo">1057</span> *<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> * @param synchronous If <code>true</code>, it waits until current balance() call, if<a name="line.1058"></a> -<span class="sourceLineNo">1059</span> * outstanding, to return.<a name="line.1059"></a> -<span class="sourceLineNo">1060</span> * @return Previous balancer value<a name="line.1060"></a> -<span class="sourceLineNo">1061</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0.<a name="line.1061"></a> -<span class="sourceLineNo">1062</span> * Use {@link #balancerSwitch(boolean, boolean)} instead.<a name="line.1062"></a> -<span class="sourceLineNo">1063</span> */<a name="line.1063"></a> -<span class="sourceLineNo">1064</span> @Deprecated<a name="line.1064"></a> -<span class="sourceLineNo">1065</span> default boolean setBalancerRunning(boolean on, boolean synchronous) throws IOException {<a name="line.1065"></a> -<span class="sourceLineNo">1066</span> return balancerSwitch(on, synchronous);<a name="line.1066"></a> -<span class="sourceLineNo">1067</span> }<a name="line.1067"></a> -<span class="sourceLineNo">1068</span><a name="line.1068"></a> -<span class="sourceLineNo">1069</span> /**<a name="line.1069"></a> -<span class="sourceLineNo">1070</span> * Turn the load balancer on or off.<a name="line.1070"></a> -<span class="sourceLineNo">1071</span> * @param onOrOff Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1071"></a> -<span class="sourceLineNo">1072</span> * @param synchronous If <code>true</code>, it waits until current balance() call, if<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> * outstanding, to return.<a name="line.1073"></a> -<span class="sourceLineNo">1074</span> * @return Previous balancer value<a name="line.1074"></a> -<span class="sourceLineNo">1075</span> */<a name="line.1075"></a> -<span class="sourceLineNo">1076</span> boolean balancerSwitch(boolean onOrOff, boolean synchronous)<a name="line.1076"></a> -<span class="sourceLineNo">1077</span> throws IOException;<a name="line.1077"></a> -<span class="sourceLineNo">1078</span><a name="line.1078"></a> -<span class="sourceLineNo">1079</span> /**<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1080"></a> -<span class="sourceLineNo">1081</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1081"></a> -<span class="sourceLineNo">1082</span> *<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1083"></a> -<span class="sourceLineNo">1084</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0.<a name="line.1084"></a> -<span class="sourceLineNo">1085</span> * Use {@link #balance()} instead.<a name="line.1085"></a> -<span class="sourceLineNo">1086</span> */<a name="line.1086"></a> -<span class="sourceLineNo">1087</span> @Deprecated<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> default boolean balancer() throws IOException {<a name="line.1088"></a> -<span class="sourceLineNo">1089</span> return balance();<a name="line.1089"></a> -<span class="sourceLineNo">1090</span> }<a name="line.1090"></a> -<span class="sourceLineNo">1091</span><a name="line.1091"></a> -<span class="sourceLineNo">1092</span> /**<a name="line.1092"></a> -<span class="sourceLineNo">1093</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1094"></a> -<span class="sourceLineNo">1095</span> *<a name="line.1095"></a> -<span class="sourceLineNo">1096</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1096"></a> -<span class="sourceLineNo">1097</span> */<a name="line.1097"></a> -<span class="sourceLineNo">1098</span> boolean balance() throws IOException;<a name="line.1098"></a> -<span class="sourceLineNo">1099</span><a name="line.1099"></a> -<span class="sourceLineNo">1100</span> /**<a name="line.1100"></a> -<span class="sourceLineNo">1101</span> * Invoke the balancer. Will run the balancer and if regions to move, it will<a name="line.1101"></a> -<span class="sourceLineNo">1102</span> * go ahead and do the reassignments. If there is region in transition, force parameter of true<a name="line.1102"></a> -<span class="sourceLineNo">1103</span> * would still run balancer. Can *not* run for other reasons. Check<a name="line.1103"></a> -<span class="sourceLineNo">1104</span> * logs.<a name="line.1104"></a> -<span class="sourceLineNo">1105</span> * @param force whether we should force balance even if there is region in transition<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1106"></a> -<span class="sourceLineNo">1107</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0.<a name="line.1107"></a> -<span class="sourceLineNo">1108</span> * Use {@link #balance(boolean)} instead.<a name="line.1108"></a> -<span class="sourceLineNo">1109</span> */<a name="line.1109"></a> -<span class="sourceLineNo">1110</span> @Deprecated<a name="line.1110"></a> -<span class="sourceLineNo">1111</span> default boolean balancer(boolean force) throws IOException {<a name="line.1111"></a> -<span class="sourceLineNo">1112</span> return balance(force);<a name="line.1112"></a> -<span class="sourceLineNo">1113</span> }<a name="line.1113"></a> -<span class="sourceLineNo">1114</span><a name="line.1114"></a> -<span class="sourceLineNo">1115</span> /**<a name="line.1115"></a> -<span class="sourceLineNo">1116</span> * Invoke the balancer. Will run the balancer and if regions to move, it will<a name="line.1116"></a> -<span class="sourceLineNo">1117</span> * go ahead and do the reassignments. If there is region in transition, force parameter of true<a name="line.1117"></a> -<span class="sourceLineNo">1118</span> * would still run balancer. Can *not* run for other reasons. Check<a name="line.1118"></a> -<span class="sourceLineNo">1119</span> * logs.<a name="line.1119"></a> -<span class="sourceLineNo">1120</span> * @param force whether we should force balance even if there is region in transition<a name="line.1120"></a> -<span class="sourceLineNo">1121</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1121"></a> -<span class="sourceLineNo">1122</span> */<a name="line.1122"></a> -<span class="sourceLineNo">1123</span> boolean balance(boolean force) throws IOException;<a name="line.1123"></a> -<span class="sourceLineNo">1124</span><a name="line.1124"></a> -<span class="sourceLineNo">1125</span> /**<a name="line.1125"></a> -<span class="sourceLineNo">1126</span> * Query the current state of the balancer.<a name="line.1126"></a> -<span class="sourceLineNo">1127</span> *<a name="line.1127"></a> -<span class="sourceLineNo">1128</span> * @return <code>true</code> if the balancer is enabled, <code>false</code> otherwise.<a name="line.1128"></a> +<span class="sourceLineNo">829</span> * Flush all regions on the region server. Synchronous operation.<a name="line.829"></a> +<span class="sourceLineNo">830</span> * @param serverName the region server name to flush<a name="line.830"></a> +<span class="sourceLineNo">831</span> * @throws IOException if a remote or network exception occurs<a name="line.831"></a> +<span class="sourceLineNo">832</span> */<a name="line.832"></a> +<span class="sourceLineNo">833</span> void flushRegionServer(ServerName serverName) throws IOException;<a name="line.833"></a> +<span class="sourceLineNo">834</span><a name="line.834"></a> +<span class="sourceLineNo">835</span> /**<a name="line.835"></a> +<span class="sourceLineNo">836</span> * Compact a table. Asynchronous operation in that this method requests that a<a name="line.836"></a> +<span class="sourceLineNo">837</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.837"></a> +<span class="sourceLineNo">838</span> * (it can take a while).<a name="line.838"></a> +<span class="sourceLineNo">839</span> *<a name="line.839"></a> +<span class="sourceLineNo">840</span> * @param tableName table to compact<a name="line.840"></a> +<span class="sourceLineNo">841</span> * @throws IOException if a remote or network exception occurs<a name="line.841"></a> +<span class="sourceLineNo">842</span> */<a name="line.842"></a> +<span class="sourceLineNo">843</span> void compact(TableName tableName) throws IOException;<a name="line.843"></a> +<span class="sourceLineNo">844</span><a name="line.844"></a> +<span class="sourceLineNo">845</span> /**<a name="line.845"></a> +<span class="sourceLineNo">846</span> * Compact an individual region. Asynchronous operation in that this method requests that a<a name="line.846"></a> +<span class="sourceLineNo">847</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.847"></a> +<span class="sourceLineNo">848</span> * (it can take a while).<a name="line.848"></a> +<span class="sourceLineNo">849</span> *<a name="line.849"></a> +<span class="sourceLineNo">850</span> * @param regionName region to compact<a name="line.850"></a> +<span class="sourceLineNo">851</span> * @throws IOException if a remote or network exception occurs<a name="line.851"></a> +<span class="sourceLineNo">852</span> */<a name="line.852"></a> +<span class="sourceLineNo">853</span> void compactRegion(byte[] regionName) throws IOException;<a name="line.853"></a> +<span class="sourceLineNo">854</span><a name="line.854"></a> +<span class="sourceLineNo">855</span> /**<a name="line.855"></a> +<span class="sourceLineNo">856</span> * Compact a column family within a table. Asynchronous operation in that this method requests<a name="line.856"></a> +<span class="sourceLineNo">857</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.857"></a> +<span class="sourceLineNo">858</span> * (it can take a while).<a name="line.858"></a> +<span class="sourceLineNo">859</span> *<a name="line.859"></a> +<span class="sourceLineNo">860</span> * @param tableName table to compact<a name="line.860"></a> +<span class="sourceLineNo">861</span> * @param columnFamily column family within a table<a name="line.861"></a> +<span class="sourceLineNo">862</span> * @throws IOException if a remote or network exception occurs<a name="line.862"></a> +<span class="sourceLineNo">863</span> */<a name="line.863"></a> +<span class="sourceLineNo">864</span> void compact(TableName tableName, byte[] columnFamily)<a name="line.864"></a> +<span class="sourceLineNo">865</span> throws IOException;<a name="line.865"></a> +<span class="sourceLineNo">866</span><a name="line.866"></a> +<span class="sourceLineNo">867</span> /**<a name="line.867"></a> +<span class="sourceLineNo">868</span> * Compact a column family within a region. Asynchronous operation in that this method requests<a name="line.868"></a> +<span class="sourceLineNo">869</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.869"></a> +<span class="sourceLineNo">870</span> * (it can take a while).<a name="line.870"></a> +<span class="sourceLineNo">871</span> *<a name="line.871"></a> +<span class="sourceLineNo">872</span> * @param regionName region to compact<a name="line.872"></a> +<span class="sourceLineNo">873</span> * @param columnFamily column family within a region<a name="line.873"></a> +<span class="sourceLineNo">874</span> * @throws IOException if a remote or network exception occurs<a name="line.874"></a> +<span class="sourceLineNo">875</span> */<a name="line.875"></a> +<span class="sourceLineNo">876</span> void compactRegion(byte[] regionName, byte[] columnFamily)<a name="line.876"></a> +<span class="sourceLineNo">877</span> throws IOException;<a name="line.877"></a> +<span class="sourceLineNo">878</span><a name="line.878"></a> +<span class="sourceLineNo">879</span> /**<a name="line.879"></a> +<span class="sourceLineNo">880</span> * Compact a table. Asynchronous operation in that this method requests that a<a name="line.880"></a> +<span class="sourceLineNo">881</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.881"></a> +<span class="sourceLineNo">882</span> * (it can take a while).<a name="line.882"></a> +<span class="sourceLineNo">883</span> *<a name="line.883"></a> +<span class="sourceLineNo">884</span> * @param tableName table to compact<a name="line.884"></a> +<span class="sourceLineNo">885</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.885"></a> +<span class="sourceLineNo">886</span> * @throws IOException if a remote or network exception occurs<a name="line.886"></a> +<span class="sourceLineNo">887</span> * @throws InterruptedException<a name="line.887"></a> +<span class="sourceLineNo">888</span> */<a name="line.888"></a> +<span class="sourceLineNo">889</span> void compact(TableName tableName, CompactType compactType)<a name="line.889"></a> +<span class="sourceLineNo">890</span> throws IOException, InterruptedException;<a name="line.890"></a> +<span class="sourceLineNo">891</span><a name="line.891"></a> +<span class="sourceLineNo">892</span> /**<a name="line.892"></a> +<span class="sourceLineNo">893</span> * Compact a column family within a table. Asynchronous operation in that this method<a name="line.893"></a> +<span class="sourceLineNo">894</span> * requests that a Compaction run and then it returns. It does not wait on the<a name="line.894"></a> +<span class="sourceLineNo">895</span> * completion of Compaction (it can take a while).<a name="line.895"></a> +<span class="sourceLineNo">896</span> *<a name="line.896"></a> +<span class="sourceLineNo">897</span> * @param tableName table to compact<a name="line.897"></a> +<span class="sourceLineNo">898</span> * @param columnFamily column family within a table<a name="line.898"></a> +<span class="sourceLineNo">899</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.899"></a> +<span class="sourceLineNo">900</span> * @throws IOException if not a mob column family or if a remote or network exception occurs<a name="line.900"></a> +<span class="sourceLineNo">901</span> * @throws InterruptedException<a name="line.901"></a> +<span class="sourceLineNo">902</span> */<a name="line.902"></a> +<span class="sourceLineNo">903</span> void compact(TableName tableName, byte[] columnFamily, CompactType compactType)<a name="line.903"></a> +<span class="sourceLineNo">904</span> throws IOException, InterruptedException;<a name="line.904"></a> +<span class="sourceLineNo">905</span><a name="line.905"></a> +<span class="sourceLineNo">906</span> /**<a name="line.906"></a> +<span class="sourceLineNo">907</span> * Major compact a table. Asynchronous operation in that this method requests<a name="line.907"></a> +<span class="sourceLineNo">908</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.908"></a> +<span class="sourceLineNo">909</span> * (it can take a while).<a name="line.909"></a> +<span class="sourceLineNo">910</span> *<a name="line.910"></a> +<span class="sourceLineNo">911</span> * @param tableName table to major compact<a name="line.911"></a> +<span class="sourceLineNo">912</span> * @throws IOException if a remote or network exception occurs<a name="line.912"></a> +<span class="sourceLineNo">913</span> */<a name="line.913"></a> +<span class="sourceLineNo">914</span> void majorCompact(TableName tableName) throws IOException;<a name="line.914"></a> +<span class="sourceLineNo">915</span><a name="line.915"></a> +<span class="sourceLineNo">916</span> /**<a name="line.916"></a> +<span class="sourceLineNo">917</span> * Major compact a table or an individual region. Asynchronous operation in that this method requests<a name="line.917"></a> +<span class="sourceLineNo">918</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.918"></a> +<span class="sourceLineNo">919</span> * (it can take a while).<a name="line.919"></a> +<span class="sourceLineNo">920</span> *<a name="line.920"></a> +<span class="sourceLineNo">921</span> * @param regionName region to major compact<a name="line.921"></a> +<span class="sourceLineNo">922</span> * @throws IOException if a remote or network exception occurs<a name="line.922"></a> +<span class="sourceLineNo">923</span> */<a name="line.923"></a> +<span class="sourceLineNo">924</span> void majorCompactRegion(byte[] regionName) throws IOException;<a name="line.924"></a> +<span class="sourceLineNo">925</span><a name="line.925"></a> +<span class="sourceLineNo">926</span> /**<a name="line.926"></a> +<span class="sourceLineNo">927</span> * Major compact a column family within a table. Asynchronous operation in that this method requests<a name="line.927"></a> +<span class="sourceLineNo">928</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.928"></a> +<span class="sourceLineNo">929</span> * (it can take a while).<a name="line.929"></a> +<span class="sourceLineNo">930</span> *<a name="line.930"></a> +<span class="sourceLineNo">931</span> * @param tableName table to major compact<a name="line.931"></a> +<span class="sourceLineNo">932</span> * @param columnFamily column family within a table<a name="line.932"></a> +<span class="sourceLineNo">933</span> * @throws IOException if a remote or network exception occurs<a name="line.933"></a> +<span class="sourceLineNo">934</span> */<a name="line.934"></a> +<span class="sourceLineNo">935</span> void majorCompact(TableName tableName, byte[] columnFamily)<a name="line.935"></a> +<span class="sourceLineNo">936</span> throws IOException;<a name="line.936"></a> +<span class="sourceLineNo">937</span><a name="line.937"></a> +<span class="sourceLineNo">938</span> /**<a name="line.938"></a> +<span class="sourceLineNo">939</span> * Major compact a column family within region. Asynchronous operation in that this method requests<a name="line.939"></a> +<span class="sourceLineNo">940</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.940"></a> +<span class="sourceLineNo">941</span> * (it can take a while).<a name="line.941"></a> +<span class="sourceLineNo">942</span> *<a name="line.942"></a> +<span class="sourceLineNo">943</span> * @param regionName egion to major compact<a name="line.943"></a> +<span class="sourceLineNo">944</span> * @param columnFamily column family within a region<a name="line.944"></a> +<span class="sourceLineNo">945</span> * @throws IOException if a remote or network exception occurs<a name="line.945"></a> +<span class="sourceLineNo">946</span> */<a name="line.946"></a> +<span class="sourceLineNo">947</span> void majorCompactRegion(byte[] regionName, byte[] columnFamily)<a name="line.947"></a> +<span class="sourceLineNo">948</span> throws IOException;<a name="line.948"></a> +<span class="sourceLineNo">949</span><a name="line.949"></a> +<span class="sourceLineNo">950</span> /**<a name="line.950"></a> +<span class="sourceLineNo">951</span> * Major compact a table. Asynchronous operation in that this method requests that a<a name="line.951"></a> +<span class="sourceLineNo">952</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.952"></a> +<span class="sourceLineNo">953</span> * (it can take a while).<a name="line.953"></a> +<span class="sourceLineNo">954</span> *<a name="line.954"></a> +<span class="sourceLineNo">955</span> * @param tableName table to compact<a name="line.955"></a> +<span class="sourceLineNo">956</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.956"></a> +<span class="sourceLineNo">957</span> * @throws IOException if a remote or network exception occurs<a name="line.957"></a> +<span class="sourceLineNo">958</span> * @throws InterruptedException<a name="line.958"></a> +<span class="sourceLineNo">959</span> */<a name="line.959"></a> +<span class="sourceLineNo">960</span> void majorCompact(TableName tableName, CompactType compactType)<a name="line.960"></a> +<span class="sourceLineNo">961</span> throws IOException, InterruptedException;<a name="line.961"></a> +<span class="sourceLineNo">962</span><a name="line.962"></a> +<span class="sourceLineNo">963</span> /**<a name="line.963"></a> +<span class="sourceLineNo">964</span> * Major compact a column family within a table. Asynchronous operation in that this method requests that a<a name="line.964"></a> +<span class="sourceLineNo">965</span> * Compaction run and then it returns. It does not wait on the completion of Compaction<a name="line.965"></a> +<span class="sourceLineNo">966</span> * (it can take a while).<a name="line.966"></a> +<span class="sourceLineNo">967</span> *<a name="line.967"></a> +<span class="sourceLineNo">968</span> * @param tableName table to compact<a name="line.968"></a> +<span class="sourceLineNo">969</span> * @param columnFamily column family within a table<a name="line.969"></a> +<span class="sourceLineNo">970</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.970"></a> +<span class="sourceLineNo">971</span> * @throws IOException if not a mob column family or if a remote or network exception occurs<a name="line.971"></a> +<span class="sourceLineNo">972</span> * @throws InterruptedException<a name="line.972"></a> +<span class="sourceLineNo">973</span> */<a name="line.973"></a> +<span class="sourceLineNo">974</span> void majorCompact(TableName tableName, byte[] columnFamily, CompactType compactType)<a name="line.974"></a> +<span class="sourceLineNo">975</span> throws IOException, InterruptedException;<a name="line.975"></a> +<span class="sourceLineNo">976</span><a name="line.976"></a> +<span class="sourceLineNo">977</span> /**<a name="line.977"></a> +<span class="sourceLineNo">978</span> * Compact all regions on the region server. Asynchronous operation in that this method requests<a name="line.978"></a> +<span class="sourceLineNo">979</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction (it<a name="line.979"></a> +<span class="sourceLineNo">980</span> * can take a while).<a name="line.980"></a> +<span class="sourceLineNo">981</span> * @param sn the region server name<a name="line.981"></a> +<span class="sourceLineNo">982</span> * @param major if it's major compaction<a name="line.982"></a> +<span class="sourceLineNo">983</span> * @throws IOException if a remote or network exception occurs<a name="line.983"></a> +<span class="sourceLineNo">984</span> * @throws InterruptedException<a name="line.984"></a> +<span class="sourceLineNo">985</span> * @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0. Use<a name="line.985"></a> +<span class="sourceLineNo">986</span> * {@link #compactRegionServer(ServerName)} or<a name="line.986"></a> +<span class="sourceLineNo">987</span> * {@link #majorCompactRegionServer(ServerName)}.<a name="line.987"></a> +<span class="sourceLineNo">988</span> */<a name="line.988"></a> +<span class="sourceLineNo">989</span> @Deprecated<a name="line.989"></a> +<span class="sourceLineNo">990</span> default void compactRegionServer(ServerName sn, boolean major) throws IOException,<a name="line.990"></a> +<span class="sourceLineNo">991</span> InterruptedException {<a name="line.991"></a> +<span class="sourceLineNo">992</span> if (major) {<a name="line.992"></a> +<span class="sourceLineNo">993</span> majorCompactRegionServer(sn);<a name="line.993"></a> +<span class="sourceLineNo">994</span> } else {<a name="line.994"></a> +<span class="sourceLineNo">995</span> compactRegionServer(sn);<a name="line.995"></a> +<span class="sourceLineNo">996</span> }<a name="line.996"></a> +<span class="sourceLineNo">997</span> }<a name="line.997"></a> +<span class="sourceLineNo">998</span><a name="line.998"></a> +<span class="sourceLineNo">999</span> /**<a name="line.999"></a> +<span class="sourceLineNo">1000</span> * Compact all regions on the region server. Asynchronous operation in that this method requests<a name="line.1000"></a> +<span class="sourceLineNo">1001</span> * that a Compaction run and then it returns. It does not wait on the completion of Compaction (it<a name="line.1001"></a> +<span class="sourceLineNo">1002</span> * can take a while).<a name="line.1002"></a> +<span class="sourceLineNo">1003</span> * @param serverName the region server name<a name="line.1003"></a> +<span class="sourceLineNo">1004</span> * @throws IOException if a remote or network exception occurs<a name="line.1004"></a> +<span class="sourceLineNo">1005</span> */<a name="line.1005"></a> +<span class="sourceLineNo">1006</span> void compactRegionServer(ServerName serverName) throws IOException;<a name="line.1006"></a> +<span class="sourceLineNo">1007</span><a name="line.1007"></a> +<span class="sourceLineNo">1008</span> /**<a name="line.1008"></a> +<span class="sourceLineNo">1009</span> * Major compact all regions on the region server. Asynchronous operation in that this method<a name="line.1009"></a> +<span class="sourceLineNo">1010</span> * requests that a Compaction run and then it returns. It does not wait on the completion of<a name="line.1010"></a> +<span class="sourceLineNo">1011</span> * Compaction (it can take a while).<a name="line.1011"></a> +<span class="sourceLineNo">1012</span> * @param serverName the region server name<a name="line.1012"></a> +<span class="sourceLineNo">1013</span> * @throws IOException if a remote or network exception occurs<a name="line.1013"></a> +<span class="sourceLineNo">1014</span> */<a name="line.1014"></a> +<span class="sourceLineNo">1015</span> void majorCompactRegionServer(ServerName serverName) throws IOException;<a name="line.1015"></a> +<span class="sourceLineNo">1016</span><a name="line.1016"></a> +<span class="sourceLineNo">1017</span> /**<a name="line.1017"></a> +<span class="sourceLineNo">1018</span> * Move the region <code>r</code> to <code>dest</code>.<a name="line.1018"></a> +<span class="sourceLineNo">1019</span> *<a name="line.1019"></a> +<span class="sourceLineNo">1020</span> * @param encodedRegionName The encoded region name; i.e. the hash that makes up the region name<a name="line.1020"></a> +<span class="sourceLineNo">1021</span> * suffix: e.g. if regionname is<a name="line.1021"></a> +<span class="sourceLineNo">1022</span> * <code>TestTable,0094429456,1289497600452.527db22f95c8a9e0116f0cc13c680396.</code>,<a name="line.1022"></a> +<span class="sourceLineNo">1023</span> * then the encoded region name is: <code>527db22f95c8a9e0116f0cc13c680396</code>.<a name="line.1023"></a> +<span class="sourceLineNo">1024</span> * @param destServerName The servername of the destination regionserver. If passed the empty byte<a name="line.1024"></a> +<span class="sourceLineNo">1025</span> * array we'll assign to a random server. A server name is made of host, port and startcode.<a name="line.1025"></a> +<span class="sourceLineNo">1026</span> * Here is an example: <code> host187.example.com,60020,1289493121758</code><a name="line.1026"></a> +<span class="sourceLineNo">1027</span> * @throws IOException if we can't find a region named<a name="line.1027"></a> +<span class="sourceLineNo">1028</span> * <code>encodedRegionName</code><a name="line.1028"></a> +<span class="sourceLineNo">1029</span> */<a name="line.1029"></a> +<span class="sourceLineNo">1030</span> void move(byte[] encodedRegionName, byte[] destServerName) throws IOException;<a name="line.1030"></a> +<span class="sourceLineNo">1031</span><a name="line.1031"></a> +<span class="sourceLineNo">1032</span> /**<a name="line.1032"></a> +<span class="sourceLineNo">1033</span> * Assign a Region.<a name="line.1033"></a> +<span class="sourceLineNo">1034</span> * @param regionName Region name to assign.<a name="line.1034"></a> +<span class="sourceLineNo">1035</span> */<a name="line.1035"></a> +<span class="sourceLineNo">1036</span> void assign(byte[] regionName) throws IOException;<a name="line.1036"></a> +<span class="sourceLineNo">1037</span><a name="line.1037"></a> +<span class="sourceLineNo">1038</span> /**<a name="line.1038"></a> +<span class="sourceLineNo">1039</span> * Unassign a region from current hosting regionserver. Region will then be assigned to a<a name="line.1039"></a> +<span class="sourceLineNo">1040</span> * regionserver chosen at random. Region could be reassigned back to the same server. Use {@link<a name="line.1040"></a> +<span class="sourceLineNo">1041</span> * #move(byte[], byte[])} if you want to control the region movement.<a name="line.1041"></a> +<span class="sourceLineNo">1042</span> *<a name="line.1042"></a> +<span class="sourceLineNo">1043</span> * @param regionName Region to unassign. Will clear any existing RegionPlan if one found.<a name="line.1043"></a> +<span class="sourceLineNo">1044</span> * @param force If <code>true</code>, force unassign (Will remove region from regions-in-transition too if<a name="line.1044"></a> +<span class="sourceLineNo">1045</span> * present. If results in double assignment use hbck -fix to resolve. To be used by experts).<a name="line.1045"></a> +<span class="sourceLineNo">1046</span> */<a name="line.1046"></a> +<span class="sourceLineNo">1047</span> void unassign(byte[] regionName, boolean force)<a name="line.1047"></a> +<span class="sourceLineNo">1048</span> throws IOException;<a name="line.1048"></a> +<span class="sourceLineNo">1049</span><a name="line.1049"></a> +<span class="sourceLineNo">1050</span> /**<a name="line.1050"></a> +<span class="sourceLineNo">1051</span> * Offline specified region from master's in-memory state. It will not attempt to reassign the<a name="line.1051"></a> +<span class="sourceLineNo">1052</span> * region as in unassign. This API can be used when a region not served by any region server and<a name="line.1052"></a> +<span class="sourceLineNo">1053</span> * still online as per Master's in memory state. If this API is incorrectly used on active region<a name="line.1053"></a> +<span class="sourceLineNo">1054</span> * then master will loose track of that region. This is a special method that should be used by<a name="line.1054"></a> +<span class="sourceLineNo">1055</span> * experts or hbck.<a name="line.1055"></a> +<span class="sourceLineNo">1056</span> *<a name="line.1056"></a> +<span class="sourceLineNo">1057</span> * @param regionName Region to offline.<a name="line.1057"></a> +<span class="sourceLineNo">1058</span> * @throws IOException<a name="line.1058"></a> +<span class="sourceLineNo">1059</span> */<a name="line.1059"></a> +<span class="sourceLineNo">1060</span> void offline(byte[] regionName) throws IOException;<a name="line.1060"></a> +<span class="sourceLineNo">1061</span><a name="line.1061"></a> +<span class="sourceLineNo">1062</span> /**<a name="line.1062"></a> +<span class="sourceLineNo">1063</span> * Turn the load balancer on or off.<a name="line.1063"></a> +<span class="sourceLineNo">1064</span> *<a name="line.1064"></a> +<span class="sourceLineNo">1065</span> * @param synchronous If <code>true</code>, it waits until current balance() call, if<a name="line.1065"></a> +<span class="sourceLineNo">1066</span> * outstanding, to return.<a name="line.1066"></a> +<span class="sourceLineNo">1067</span> * @return Previous balancer value<a name="line.1067"></a> +<span class="sourceLineNo">1068</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0.<a name="line.1068"></a> +<span class="sourceLineNo">1069</span> * Use {@link #balancerSwitch(boolean, boolean)} instead.<a name="line.1069"></a> +<span class="sourceLineNo">1070</span> */<a name="line.1070"></a> +<span class="sourceLineNo">1071</span> @Deprecated<a name="line.1071"></a> +<span class="sourceLineNo">1072</span> default boolean setBalancerRunning(boolean on, boolean synchronous) throws IOException {<a name="line.1072"></a> +<span class="sourceLineNo">1073</span> return balancerSwitch(on, synchronous);<a name="line.1073"></a> +<span class="sourceLineNo">1074</span> }<a name="line.1074"></a> +<span class="sourceLineNo">1075</span><a name="line.1075"></a> +<span class="sourceLineNo">1076</span> /**<a name="line.1076"></a> +<span class="sourceLineNo">1077</span> * Turn the load balancer on or off.<a name="line.1077"></a> +<span class="sourceLineNo">1078</span> * @param onOrOff Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1078"></a> +<span class="sourceLineNo">1079</span> * @param synchronous If <code>true</code>, it waits until current balance() call, if<a name="line.1079"></a> +<span class="sourceLineNo">1080</span> * outstanding, to return.<a name="line.1080"></a> +<span class="sourceLineNo">1081</span> * @return Previous balancer value<a name="line.1081"></a> +<span class="sourceLineNo">1082</span> */<a name="line.1082"></a> +<span class="sourceLineNo">1083</span> boolean balancerSwitch(boolean onOrOff, boolean synchronous)<a name="line.1083"></a> +<span class="sourceLineNo">1084</span> throws IOException;<a name="line.1084"></a> +<span class="sourceLineNo">1085</span><a name="line.1085"></a> +<span class="sourceLineNo">1086</span> /**<a name="line.1086"></a> +<span class="sourceLineNo">1087</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1087"></a> +<span class="sourceLineNo">1088</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1088"></a> +<span class="sourceLineNo">1089</span> *<a name="line.1089"></a> +<span class="sourceLineNo">1090</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1090"></a> +<span class="sourceLineNo">1091</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0.<a name="line.1091"></a> +<span class="sourceLineNo">1092</span> * Use {@link #balance()} instead.<a name="line.1092"></a> +<span class="sourceLineNo">1093</span> */<a name="line.1093"></a> +<span class="sourceLineNo">1094</span> @Deprecated<a name="line.1094"></a> +<span class="sourceLineNo">1095</span> default boolean balancer() throws IOException {<a name="line.1095"></a> +<span class="sourceLineNo">1096</span> return balance();<a name="line.1096"></a> +<span class="sourceLineNo">1097</span> }<a name="line.1097"></a> +<span class="sourceLineNo">1098</span><a name="line.1098"></a> +<span class="sourceLineNo">1099</span> /**<a name="line.1099"></a> +<span class="sourceLineNo">1100</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1100"></a> +<span class="sourceLineNo">1101</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1101"></a> +<span class="sourceLineNo">1102</span> *<a name="line.1102"></a> +<span class="sourceLineNo">1103</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1103"></a> +<span class="sourceLineNo">1104</span> */<a name="line.1104"></a> +<span class="sourceLineNo">1105</span> boolean balance() throws IOException;<a name="line.1105"></a> +<span class="sourceLineNo">1106</span><a name="line.1106"></a> +<span class="sourceLineNo">1107</span> /**<a name="line.1107"></a> +<span class="sourceLineNo">1108</span> * Invoke the balancer. Will run the balancer and if regions to move, it will<a name="line.1108"></a> +<span class="sourceLineNo">1109</span> * go ahead and do the reassignments. If there is region in transition, force parameter of true<a name="line.1109"></a> +<span class="sourceLineNo">1110</span> * would still run balancer. Can *not* run for other reasons. Check<a name="line.1110"></a> +<span class="sourceLineNo">1111</span> * logs.<a name="line.1111"></a> +<span class="sourceLineNo">1112</span> * @param force whether we should force balance even if there is region in transition<a name="line.1112"></a> +<span class="sourceLineNo">1113</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1113"></a> +<span class="sourceLineNo">1114</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0.<a name="line.1114"></a> +<span class="sourceLineNo">1115</span> * Use {@link #balance(boolean)} instead.<a name="line.1115"></a> +<span class="sourceLineNo">1116</span> */<a name="line.1116"></a> +<span class="sourceLineNo">1117</span> @Deprecated<a name="line.1117"></a> +<span class="sourceLineNo">1118</span> default boolean balancer(boolean force) throws IOException {<a name="line.1118"></a> +<span class="sourceLineNo">1119</span> return balance(force);<a name="line.1119"></a> +<span class="sourceLineNo">1120</span> }<a name="line.1120"></a> +<span class="sourceLineNo">1121</span><a name="line.1121"></a> +<span class="sourceLineNo">1122</span> /**<a name="line.1122"></a> +<span class="sourceLineNo">1123</span> * Invoke the balancer. Will run the balancer and if regions to move, it will<a name="line.1123"></a> +<span class="sourceLineNo">1124</span> * go ahead and do the reassignments. If there is region in transition, force parameter of true<a name="line.1124"></a> +<span class="sourceLineNo">1125</span> * would still run balancer. Can *not* run for other reasons. Check<a name="line.1125"></a> +<span class="sourceLineNo">1126</span> * logs.<a name="line.1126"></a> +<span class="sourceLineNo">1127</span> * @param force whether we should force balance even if there is region in transition<a name="line.1127"></a> +<span class="sourceLineNo">1128</span> * @return <code>true</code> if balancer ran, <code>false</code> otherwise.<a name="line.1128"></a> <span class="sourceLineNo">1129</span> */<a name="line.1129"></a> -<span class="sourceLineNo">1130</span> boolean isBalancerEnabled() throws IOException;<a name="line.1130"></a> +<span class="sourceLineNo">1130</span> boolean balance(boolean force) throws IOException;<a name="line.1130"></a> <span class="sourceLineNo">1131</span><a name="line.1131"></a> <span class="sourceLineNo">1132</span> /**<a name="line.1132"></a> -<span class="sourceLineNo">1133</span> * Clear all the blocks corresponding to this table from BlockCache. For expert-admins.<a name="line.1133"></a> -<span class="sourceLineNo">1134</span> * Calling this API will drop all the cached blocks specific to a table from BlockCache.<a name="line.1134"></a> -<span class="sourceLineNo">1135</span> * This can significantly impact the query performance as the subsequent queries will<a name="line.1135"></a> -<span class="sourceLineNo">1136</span> * have to retrieve the blocks from underlying filesystem.<a name="line.1136"></a> -<span class="sourceLineNo">1137</span> *<a name="line.1137"></a> -<span class="sourceLineNo">1138</span> * @param tableName table to clear block cache<a name="line.1138"></a> -<span class="sourceLineNo">1139</span> * @return CacheEvictionStats related to the eviction<a name="line.1139"></a> -<span class="sourceLineNo">1140</span> * @throws IOException if a remote or network exception occurs<a name="line.1140"></a> -<span class="sourceLineNo">1141</span> */<a name="line.1141"></a> -<span class="sourceLineNo">1142</span> CacheEvictionStats clearBlockCache(final TableName tableName) throws IOException;<a name="line.1142"></a> -<span class="sourceLineNo">1143</span><a name="line.1143"></a> -<span class="sourceLineNo">1144</span> /**<a name="line.1144"></a> -<span class="sourceLineNo">1145</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1145"></a> -<span class="sourceLineNo">1146</span> *<a name="line.1146"></a> -<span class="sourceLineNo">1147</span> * @return <code>true</code> if region normalizer ran, <code>false</code> otherwise.<a name="line.1147"></a> +<span class="sourceLineNo">1133</span> * Query the current state of the balancer.<a name="line.1133"></a> +<span class="sourceLineNo">1134</span> *<a name="line.1134"></a> +<span class="sourceLineNo">1135</span> * @return <code>true</code> if the balancer is enabled, <code>false</code> otherwise.<a name="line.1135"></a> +<span class="sourceLineNo">1136</span> */<a name="line.1136"></a> +<span class="sourceLineNo">1137</span> boolean isBalancerEnabled() throws IOException;<a name="line.1137"></a> +<span class="sourceLineNo">1138</span><a name="line.1138"></a> +<span class="sourceLineNo">1139</span> /**<a name="line.1139"></a> +<span class="sourceLineNo">1140</span> * Clear all the blocks corresponding to this table from BlockCache. For expert-admins.<a name="line.1140"></a> +<span class="sourceLineNo">1141</span> * Calling this API will drop all the cached blocks specific to a table from BlockCache.<a name="line.1141"></a> +<span class="sourceLineNo">1142</span> * This can significantly impact the query performance as the subsequent queries will<a name="line.1142"></a> +<span class="sourceLineNo">1143</span> * have to retrieve the blocks from underlying filesystem.<a name="line.1143"></a> +<span class="sourceLineNo">1144</span> *<a name="line.1144"></a> +<span class="sourceLineNo">1145</span> * @param tableName table to clear block cache<a name="line.1145"></a> +<span class="sourceLineNo">1146</span> * @return CacheEvictionStats related to the eviction<a name="line.1146"></a> +<span class="sourceLineNo">1147</span> * @throws IOException if a remote or network exception occurs<a name="line.1147"></a> <span class="sourceLineNo">1148</span> */<a name="line.1148"></a> -<span class="sourceLineNo">1149</span> boolean normalize() throws IOException;<a name="line.1149"></a> +<span class="sourceLineNo">1149</span> CacheEvictionStats clearBlockCache(final TableName tableName) throws IOException;<a name="line.1149"></a> <span class="sourceLineNo">1150</span><a name="line.1150"></a> <span class="sourceLineNo">1151</span> /**<a name="line.1151"></a> -<span class="sourceLineNo">1152</span> * Query the current state of the region normalizer.<a name="line.1152"></a> +<span class="sourceLineNo">1152</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1152"></a> <span class="sourceLineNo">1153</span> *<a name="line.1153"></a> -<span class="sourceLineNo">1154</span> * @return <code>true</code> if region normalizer is enabled, <code>false</code> otherwise.<a name="line.1154"></a> +<span class="sourceLineNo">1154</span> * @return <code>true</code> if region normalizer ran, <code>false</code> otherwise.<a name="line.1154"></a> <span class="sourceLineNo">1155</span> */<a name="line.1155"></a> -<span class="sourceLineNo">1156</span> boolean isNormalizerEnabled() throws IOException;<a name="line.1156"></a> +<span class="sourceLineNo">1156</span> boolean normalize() throws IOException;<a name="line.1156"></a> <span class="sourceLineNo">1157</span><a name="line.1157"></a> <span class="sourceLineNo">1158</span> /**<a name="line.1158"></a> -<span class="sourceLineNo">1159</span> * Turn region normalizer on or off.<a name="line.1159"></a> +<span class="sourceLineNo">1159</span> * Query the current state of the region normalizer.<a name="line.1159"></a> <span class="sourceLineNo">1160</span> *<a name="line.1160"></a> -<span class="sourceLineNo">1161</span> * @return Previous normalizer value<a name="line.1161"></a> -<span class="sourceLineNo">1162</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #normalizerSwitch(boolean)}}<a name="line.1162"></a> -<span class="sourceLineNo">1163</span> * instead.<a name="line.1163"></a> -<span class="sourceLineNo">1164</span> */<a name="line.1164"></a> -<span class="sourceLineNo">1165</span> @Deprecated<a name="line.1165"></a> -<span class="sourceLineNo">1166</span> default boolean setNormalizerRunning(boolean on) throws IOException {<a name="line.1166"></a> -<span class="sourceLineNo">1167</span> return normalizerSwitch(on);<a name="line.1167"></a> -<span class="sourceLineNo">1168</span> }<a name="line.1168"></a> -<span class="sourceLineNo">1169</span><a name="line.1169"></a> -<span class="sourceLineNo">1170</span> /**<a name="line.1170"></a> -<span class="sourceLineNo">1171</span> * Turn region normalizer on or off.<a name="line.1171"></a> -<span class="sourceLineNo">1172</span> *<a name="line.1172"></a> -<span class="sourceLineNo">1173</span> * @return Previous normalizer value<a name="line.1173"></a> -<span class="sourceLineNo">1174</span> */<a name="line.1174"></a> -<span class="sourceLineNo">1175</span> boolean normalizerSwitch (boolean on) throws IOException;<a name="line.1175"></a> +<span class="sourceLineNo">1161</span> * @return <code>true</code> if region normalizer is enabled, <code>false</code> otherwise.<a name="line.1161"></a> +<span class="sourceLineNo">1162</span> */<a name="line.1162"></a> +<span class="sourceLineNo">1163</span> boolean isNormalizerEnabled() throws IOException;<a name="line.1163"></a> +<span class="sourceLineNo">1164</span><a name="line.1164"></a> +<span class="sourceLineNo">1165</span> /**<a name="line.1165"></a> +<span class="sourceLineNo">1166</span> * Turn region normalizer on or off.<a name="line.1166"></a> +<span class="sourceLineNo">1167</span> *<a name="line.1167"></a> +<span class="sourceLineNo">1168</span> * @return Previous normalizer value<a name="line.1168"></a> +<span class="sourceLineNo">1169</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #normalizerSwitch(boolean)}}<a name="line.1169"></a> +<span class="sourceLineNo">1170</span> * instead.<a name="line.1170"></a> +<span class="sourceLineNo">1171</span> */<a name="line.1171"></a> +<span class="sourceLineNo">1172</span> @Deprecated<a name="line.1172"></a> +<span class="sourceLineNo">1173</span> default boolean setNormalizerRunning(boolean on) throws IOException {<a name="line.1173"></a> +<span class="sourceLineNo">1174</span> return normalizerSwitch(on);<a name="line.1174"></a> +<span class="sourceLineNo">1175</span> }<a name="line.1175"></a> <span class="sourceLineNo">1176</span><a name="line.1176"></a> <span class="sourceLineNo">1177</span> /**<a name="line.1177"></a> -<span class="sourceLineNo">1178</span> * Enable/Disable the catalog janitor.<a name="line.1178"></a> +<span class="sourceLineNo">1178</span> * Turn region normalizer on or off.<a name="line.1178"></a> <span class="sourceLineNo">1179</span> *<a name="line.1179"></a> -<span class="sourceLineNo">1180</span> * @param enable if <code>true</code> enables the catalog janitor<a name="line.1180"></a> -<span class="sourceLineNo">1181</span> * @return the previous state<a name="line.1181"></a> -<span class="sourceLineNo">1182</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #catalogJanitorSwitch(boolean)}}<a name="line.1182"></a> -<span class="sourceLineNo">1183</span> * instead.<a name="line.1183"></a> -<span class="sourceLineNo">1184</span> */<a name="line.1184"></a> -<span class="sourceLineNo">1185</span> @Deprecated<a name="line.1185"></a> -<span class="sourceLineNo">1186</span> default boolean enableCatalogJanitor(boolean enable) throws IOException {<a name="line.1186"></a> -<span class="sourceLineNo">1187</span> return catalogJanitorSwitch(enable);<a name="line.1187"></a> -<span class="sourceLineNo">1188</span> }<a name="line.1188"></a> -<span class="sourceLineNo">1189</span><a name="line.1189"></a> -<span class="sourceLineNo">1190</span> /**<a name="line.1190"></a> -<span class="sourceLineNo">1191</span> * Enable/Disable the catalog janitor/<a name="line.1191"></a> -<span class="sourceLineNo">1192</span> *<a name="line.1192"></a> -<span class="sourceLineNo">1193</span> * @param onOrOff if <code>true</code> enables the catalog janitor<a name="line.1193"></a> -<span class="sourceLineNo">1194</span> * @return the previous state<a name="line.1194"></a> -<span class="sourceLineNo">1195</span> */<a name="line.1195"></a> -<span class="sourceLineNo">1196</span> boolean catalogJanitorSwitch(boolean onOrOff) throws IOException;<a name="line.1196"></a> -<span class="sourceLineNo">1197</span><a name="line.1197"></a> -<span class="sourceLineNo">1198</span> /**<a name="line.1198"></a> -<span class="sourceLineNo">1199</span> * Ask for a scan of the catalog table.<a name="line.1199"></a> -<span class="sourceLineNo">1200</span> *<a name="line.1200"></a> -<span class="sourceLineNo">1201</span> * @return the number of entries cleaned<a name="line.1201"></a> -<span class="sourceLineNo">1202</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #runCatalogJanitor()}}<a name="line.1202"></a> -<span class="sourceLineNo">1203</span> * instead.<a name="line.1203"></a> -<span class="sourceLineNo">1204</span> */<a name="line.1204"></a> -<span class="sourceLineNo">1205</span> @Deprecated<a name="line.1205"></a> -<span class="sourceLineNo">1206</span> default int runCatalogScan() throws IOException {<a name="line.1206"></a> -<span class="sourceLineNo">1207</span> return runCatalogJanitor();<a name="line.1207"></a> -<span class="sourceLineNo">1208</span> }<a name="line.1208"></a> -<span class="sourceLineNo">1209</span><a name="line.1209"></a> -<span class="sourceLineNo">1210</span> /**<a name="line.1210"></a> -<span class="sourceLineNo">1211</span> * Ask for a scan of the catalog table.<a name="line.1211"></a> -<span class="sourceLineNo">1212</span> *<a name="line.1212"></a> -<span class="sourceLineNo">1213</span> * @return the number of entries cleaned<a name="line.1213"></a> -<span class="sourceLineNo">1214</span> */<a name="line.1214"></a> -<span class="sourceLineNo">1215</span> int runCatalogJanitor() throws IOException;<a name="line.1215"></a> +<span class="sourceLineNo">1180</span> * @return Previous normalizer value<a name="line.1180"></a> +<span class="sourceLineNo">1181</span> */<a name="line.1181"></a> +<span class="sourceLineNo">1182</span> boolean normalizerSwitch (boolean on) throws IOException;<a name="line.1182"></a> +<span class="sourceLineNo">1183</span><a name="line.1183"></a> +<span class="sourceLineNo">1184</span> /**<a name="line.1184"></a> +<span class="sourceLineNo">1185</span> * Enable/Disable the catalog janitor.<a name="line.1185"></a> +<span class="sourceLineNo">1186</span> *<a name="line.1186"></a> +<span class="sourceLineNo">1187</span> * @param enable if <code>true</code> enables the catalog janitor<a name="line.1187"></a> +<span class="sourceLineNo">1188</span> * @return the previous state<a name="line.1188"></a> +<span class="sourceLineNo">1189</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #catalogJanitorSwitch(boolean)}}<a name="line.1189"></a> +<span class="sourceLineNo">1190</span> * instead.<a name="line.1190"></a> +<span class="sourceLineNo">1191</span> */<a name="line.1191"></a> +<span class="sourceLineNo">1192</span> @Deprecated<a name="line.1192"></a> +<span class="sourceLineNo">1193</span> default boolean enableCatalogJanitor(boolean enable) throws IOException {<a name="line.1193"></a> +<span class="sourceLineNo">1194</span> return catalogJanitorSwitch(enable);<a name="line.1194"></a> +<span class="sourceLineNo">1195</span> }<a name="line.1195"></a> +<span class="sourceLineNo">1196</span><a name="line.1196"></a> +<span class="sourceLineNo">1197</span> /**<a name="line.1197"></a> +<span class="sourceLineNo">1198</span> * Enable/Disable the catalog janitor/<a name="line.1198"></a> +<span class="sourceLineNo">1199</span> *<a name="line.1199"></a> +<span class="sourceLineNo">1200</span> * @param onOrOff if <code>true</code> enables the catalog janitor<a name="line.1200"></a> +<span class="sourceLineNo">1201</span> * @return the previous state<a name="line.1201"></a> +<span class="sourceLineNo">1202</span> */<a name="line.1202"></a> +<span class="sourceLineNo">1203</span> boolean catalogJanitorSwitch(boolean onOrOff) throws IOException;<a name="line.1203"></a> +<span class="sourceLineNo">1204</span><a name="line.1204"></a> +<span class="sourceLineNo">1205</span> /**<a name="line.1205"></a> +<span class="sourceLineNo">1206</span> * Ask for a scan of the catalog table.<a name="line.1206"></a> +<span class="sourceLineNo">1207</span> *<a name="line.1207"></a> +<span class="sourceLineNo">1208</span> * @return the number of entries cleaned<a name="line.1208"></a> +<span class="sourceLineNo">1209</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #runCatalogJanitor()}}<a name="line.1209"></a> +<span class="sourceLineNo">1210</span> * instead.<a name="line.1210"></a> +<span class="sourceLineNo">1211</span> */<a name="line.1211"></a> +<span class="sourceLineNo">1212</span> @Deprecated<a name="line.1212"></a> +<span class="sourceLineNo">1213</span> default int runCatalogScan() throws IOException {<a name="line.1213"></a> +<span class="sourceLineNo">1214</span> return runCatalogJanitor();<a name="line.1214"></a> +<span class="sourceLineNo">1215</span> }<a name="line.1215"></a> <span class="sourceLineNo">1216</span><a name="line.1216"></a> <span class="sourceLineNo">1217</span> /**<a name="line.1217"></a> -<span class="sourceLineNo">1218</span> * Query on the catalog janitor state (Enabled/Disabled?).<a name="line.1218"></a> +<span class="sourceLineNo">1218</span> * Ask for a scan of the catalog table.<a name="line.1218"></a> <span class="sourceLineNo">1219</span> *<a name="line.1219"></a> -<span class="sourceLineNo">1220</span> */<a name="line.1220"></a> -<span class="sourceLineNo">1221</span> boolean isCatalogJanitorEnabled() throws IOException;<a name="line.1221"></a> -<span class="sourceLineNo">1222</span><a name="line.1222"></a> -<span class="sourceLineNo">1223</span> /**<a name="line.1223"></a> -<span class="sourceLineNo">1224</span> * Enable/Disable the cleaner chore.<a name="line.1224"></a> -<span class="sourceLineNo">1225</span> *<a name="line.1225"></a> -<span class="sourceLineNo">1226</span> * @param on if <code>true</code> enables the cleaner chore<a name="line.1226"></a> -<span class="sourceLineNo">1227</span> * @return the previous state<a name="line.1227"></a> -<span class="sourceLineNo">1228</span> * @throws IOException<a name="line.1228"></a> -<span class="sourceLineNo">1229</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #cleanerChoreSwitch(boolean)}}<a name="line.1229"></a> -<span class="sourceLineNo">1230</span> * instead.<a name="line.1230"></a> -<span class="sourceLineNo">1231</span> */<a name="line.1231"></a> -<span class="sourceLineNo">1232</span> @Deprecated<a name="line.1232"></a> -<span class="sourceLineNo">1233</span> default boolean setCleanerChoreRunning(boolean on) throws IOException {<a name="line.1233"></a> -<span class="sourceLineNo">1234</span> return cleanerChoreSwitch(on);<a name="line.1234"></a> -<span class="sourceLineNo">1235</span> }<a name="line.1235"></a> -<span class="sourceLineNo">1236</span><a name="line.1236"></a> -<span class="sourceLineNo">1237</span> /**<a name="line.1237"></a> -<span class="sourceLineNo">1238</span> * Enable/Disable the cleaner chore.<a name="line.1238"></a> -<span class="sourceLineNo">1239</span> *<a name="line.1239"></a> -<span class="sourceLineNo">1240</span> * @param onOrOff if <code>true</code> enables the cleaner chore<a name="line.1240"></a> -<span class="sourceLineNo">1241</span> * @return the previous state<a name="line.1241"></a> -<span class="sourceLineNo">1242</span> * @throws IOException<a name="line.1242"></a> -<span class="sourceLineNo">1243</span> */<a name="line.1243"></a> -<span class="sourceLineNo">1244</span> boolean cleanerChoreSwitch(boolean onOrOff) throws IOException;<a name="line.1244"></a> -<span class="sourceLineNo">1245</span><a name="line.1245"></a> -<span class="sourceLineNo">1246</span> /**<a name="line.1246"></a> -<span class="sourceLineNo">1247</span> * Ask for cleaner chore to run.<a name="line.1247"></a> -<span class="sourceLineNo">1248</span> *<a name="line.1248"></a> -<span class="sourceLineNo">1249</span> * @return <code>true</code> if cleaner chore ran, <code>false</code> otherwise<a name="line.1249"></a> -<span class="sourceLineNo">1250</span> * @throws IOException<a name="line.1250"></a> -<span class="sourceLineNo">1251</span> */<a name="line.1251"></a> -<span class="sourceLineNo">1252</span> boolean runCleanerChore() throws IOException;<a name="line.1252"></a> -<span class="sourceLineNo">1253</span><a name="line.1253"></a> -<span class="sourceLineNo">1254</span> /**<a name="line.1254"></a> -<span class="sourceLineNo">1255</span> * Query on the cleaner chore state (Enabled/Disabled?).<a name="line.1255"></a> -<span class="sourceLineNo">1256</span> *<a name="line.1256"></a> +<span class="sourceLineNo">1220</span> * @return the number of entries cleaned<a name="line.1220"></a> +<span class="sourceLineNo">1221</span> */<a name="line.1221"></a> +<span class="sourceLineNo">1222</span> int runCatalogJanitor() throws IOException;<a name="line.1222"></a> +<span class="sourceLineNo">1223</span><a name="line.1223"></a> +<span class="sourceLineNo">1224</span> /**<a name="line.1224"></a> +<span class="sourceLineNo">1225</span> * Query on the catalog janitor state (Enabled/Disabled?).<a name="line.1225"></a> +<span class="sourceLineNo">1226</span> *<a name="line.1226"></a> +<span class="sourceLineNo">1227</span> */<a name="line.1227"></a> +<span class="sourceLineNo">1228</span> boolean isCatalogJanitorEnabled() throws IOException;<a name="line.1228"></a> +<span class="sourceLineNo">1229</span><a name="line.1229"></a> +<span class="sourceLineNo">1230</span> /**<a name="line.1230"></a> +<span class="sourceLineNo">1231</span> * Enable/Disable the cleaner chore.<a name="line.1231"></a> +<span class="sourceLineNo">1232</span> *<a name="line.1232"></a> +<span class="sourceLineNo">1233</span> * @param on if <code>true</code> enables the cleaner chore<a name="line.1233"></a> +<span class="sourceLineNo">1234</span> * @return the previous state<a name="line.1234"></a> +<span class="sourceLineNo">1235</span> * @throws IOException<a name="line.1235"></a> +<span class="sourceLineNo">1236</span> * @deprecated Since 2.0.0. Will be removed in 3.0.0. Use {@link #cleanerChoreSwitch(boolean)}}<a name="line.1236"></a> +<span class="sourceLineNo">1237</span> * instead.<a name="line.1237"></a> +<span class="sourceLineNo">1238</span> */<a name="line.1238"></a> +<span class="sourceLineNo">1239</span> @Deprecated<a name="line.1239"></a> +<span class="sourceLineNo">1240</span> default boolean setCleanerChoreRunning(boolean on) throws IOException {<a name="line.1240"></a> +<span class="sourceLineNo">1241</span> return cleanerChoreSwitch(on);<a name="line.1241"></a> +<span class="sourceLineNo">1242</span> }<a name="line.1242"></a> +<span class="sourceLineNo">1243</span><a name="line.1243"></a> +<span class="sourceLineNo">1244</span> /**<a name="line.1244"></a> +<span class="sourceLineNo">1245</span> * Enable/Disable the cleaner chore.<a name="line.1245"></a> +<span class="sourceLineNo">1246</span> *<a name="line.1246"></a> +<span class="sourceLineNo">1247</span> * @param onOrOff if <code>true</code> enables the cleaner chore<a name="line.1247"></a> +<span class="sourceLineNo">1248</span> * @return the previous state<a name="line.1248"></a> +<span class="sourceLineNo">1249</span> * @throws IOException<a name="line.1249"></a> +<span class="sourceLineNo">1250</span> */<a name="line.1250"></a> +<span class="sourceLineNo">1251</span> boolean cleanerChoreSwitch(boolean onOrOff) throws IOException;<a name="line.1251"></a> +<span class="sourceLineNo">1252</span><a name="line.1252"></a> +<span class="sourceLineNo">1253</span> /**<a name="line.1253"></a> +<span class="sourceLineNo">1254</span> * Ask for cleaner chore to run.<a name="line.1254"></a> +<span class="sourceLineNo">1255</span> *<a name="line.1255"></a> +<span class="sourceLineNo">1256</span> * @return <code>true</code> if cleaner chore ran, <code>false</code> otherwise<a name="line.1256"></a> <span class="sourceLineNo">1257</span> * @throws IOException<a name="line.1257"></a> <span class="sourceLineNo">1258</span> */<a name="line.1258"></a> -<span class="sourceLineNo">1259</span> boolean isCleanerChoreEnabled() throws IOException;<a name="line.1259"></a> +<span class="sourceLineNo">1259</span> boolean runCleanerChore() throws IOException;<a name="line.1259"></a> <span class="sourceLineNo">1260</span><a name="line.1260"></a> <span class="sourceLineNo">1261</span> /**<a name="line.1261"></a> -<span class="sourceLineNo">1262</span> * Merge two regions. Asynchronous operation.<a name="line.1262"></a> +<span class="sourceLineNo">1262</span> * Query on the cleaner chore state (Enabled/Disabled?).<a name="line.1262"></a> <span class="sourceLineNo">1263</span> *<a name="line.1263"></a> -<span class="sourceLineNo">1264</span> * @param nameOfRegionA encoded or full name of region a<a name="line.1264"></a> -<span class="sourceLineNo">1265</span> * @param nameOfRegionB encoded or full name of region b<a name="line.1265"></a> -<span class="sourceLineNo">1266</span> * @param forcible <code>true</code> if do a compulsory merge, otherwise we will only merge two<a name="line.1266"></a> -<span class="sourceLineNo">1267</span> * adjacent regions<a name="line.1267"></a> -<span class="sourceLineNo">1268</span> * @throws IOException<a name="line.1268"></a> -<span class="sourceLineNo">1269</span> * @deprecated Since 2.0. Will be removed in 3.0. Use<a name="line.1269"></a> -<span class="sourceLineNo">1270</span> * {@link #mergeRegionsAsync(byte[], byte[], boolean)} instead.<a name="line.1270"></a> -<span class="sourceLineNo">1271</span> */<a name="line.1271"></a> -<span class="sourceLineNo">1272</span> @Deprecated<a name="line.1272"></a> -<span class="sourceLineNo">1273</span> void mergeRegions(byte[] nameOfRegionA, byte[] nameOfRegionB,<a name="line.1273"></a> -<span class="sourceLineNo">1274</span> boolean forcible) throws IOException;<a name="line.1274"></a> -<span class="sourceLineNo">1275</span><a name="line.1275"></a> -<span class="sourceLineNo">1276</span><a name="line.1276"></a> -<span class="sourceLineNo">1277</span> /**<a name="line.1277"></a> -<span class="sourceLineNo">1278</span> * Merge two regions. Asynchronous operation.<a name="line.1278"></a> -<span class="sourceLineNo">1279</span> *<a name="line.1279"></a> -<span class="sourceLineNo">1280</span> * @param nameOfRegionA encoded or full name of region a<a name="line.1280"></a> -<span class="sourceLineNo">1281</span> * @param nameOfRegionB encoded or full name of region b<a name="line.1281"></a> -<span class="sourceLineNo">1282</span> * @param forcible <code>true<
<TRUNCATED>