http://git-wip-us.apache.org/repos/asf/hbase-site/blob/37cf49a6/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html index 77bb7f2..0019de7 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncAdmin.html @@ -885,414 +885,417 @@ <span class="sourceLineNo">877</span> Map<String, String> props);<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> * abort a procedure<a name="line.880"></a> -<span class="sourceLineNo">881</span> * @param procId ID of the procedure to abort<a name="line.881"></a> -<span class="sourceLineNo">882</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.882"></a> -<span class="sourceLineNo">883</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.883"></a> -<span class="sourceLineNo">884</span> * wrapped by {@link CompletableFuture}<a name="line.884"></a> -<span class="sourceLineNo">885</span> */<a name="line.885"></a> -<span class="sourceLineNo">886</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.886"></a> -<span class="sourceLineNo">887</span><a name="line.887"></a> -<span class="sourceLineNo">888</span> /**<a name="line.888"></a> -<span class="sourceLineNo">889</span> * List procedures<a name="line.889"></a> -<span class="sourceLineNo">890</span> * @return procedure list JSON wrapped by {@link CompletableFuture}<a name="line.890"></a> -<span class="sourceLineNo">891</span> */<a name="line.891"></a> -<span class="sourceLineNo">892</span> CompletableFuture<String> getProcedures();<a name="line.892"></a> -<span class="sourceLineNo">893</span><a name="line.893"></a> -<span class="sourceLineNo">894</span> /**<a name="line.894"></a> -<span class="sourceLineNo">895</span> * List locks.<a name="line.895"></a> -<span class="sourceLineNo">896</span> * @return lock list JSON wrapped by {@link CompletableFuture}<a name="line.896"></a> -<span class="sourceLineNo">897</span> */<a name="line.897"></a> -<span class="sourceLineNo">898</span> CompletableFuture<String> getLocks();<a name="line.898"></a> -<span class="sourceLineNo">899</span><a name="line.899"></a> -<span class="sourceLineNo">900</span> /**<a name="line.900"></a> -<span class="sourceLineNo">901</span> * Mark region server(s) as decommissioned to prevent additional regions from getting<a name="line.901"></a> -<span class="sourceLineNo">902</span> * assigned to them. Optionally unload the regions on the servers. If there are multiple servers<a name="line.902"></a> -<span class="sourceLineNo">903</span> * to be decommissioned, decommissioning them at the same time can prevent wasteful region<a name="line.903"></a> -<span class="sourceLineNo">904</span> * movements. Region unloading is asynchronous.<a name="line.904"></a> -<span class="sourceLineNo">905</span> * @param servers The list of servers to decommission.<a name="line.905"></a> -<span class="sourceLineNo">906</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.906"></a> -<span class="sourceLineNo">907</span> */<a name="line.907"></a> -<span class="sourceLineNo">908</span> CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers, boolean offload);<a name="line.908"></a> -<span class="sourceLineNo">909</span><a name="line.909"></a> -<span class="sourceLineNo">910</span> /**<a name="line.910"></a> -<span class="sourceLineNo">911</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.911"></a> -<span class="sourceLineNo">912</span> * @return List of decommissioned region servers wrapped by {@link CompletableFuture}<a name="line.912"></a> -<span class="sourceLineNo">913</span> */<a name="line.913"></a> -<span class="sourceLineNo">914</span> CompletableFuture<List<ServerName>> listDecommissionedRegionServers();<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> * Remove decommission marker from a region server to allow regions assignments. Load regions onto<a name="line.917"></a> -<span class="sourceLineNo">918</span> * the server if a list of regions is given. Region loading is asynchronous.<a name="line.918"></a> -<span class="sourceLineNo">919</span> * @param server The server to recommission.<a name="line.919"></a> -<span class="sourceLineNo">920</span> * @param encodedRegionNames Regions to load onto the server.<a name="line.920"></a> -<span class="sourceLineNo">921</span> */<a name="line.921"></a> -<span class="sourceLineNo">922</span> CompletableFuture<Void> recommissionRegionServer(ServerName server,<a name="line.922"></a> -<span class="sourceLineNo">923</span> List<byte[]> encodedRegionNames);<a name="line.923"></a> -<span class="sourceLineNo">924</span><a name="line.924"></a> -<span class="sourceLineNo">925</span> /**<a name="line.925"></a> -<span class="sourceLineNo">926</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.926"></a> -<span class="sourceLineNo">927</span> */<a name="line.927"></a> -<span class="sourceLineNo">928</span> CompletableFuture<ClusterMetrics> getClusterMetrics();<a name="line.928"></a> -<span class="sourceLineNo">929</span><a name="line.929"></a> -<span class="sourceLineNo">930</span> /**<a name="line.930"></a> -<span class="sourceLineNo">931</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.931"></a> -<span class="sourceLineNo">932</span> */<a name="line.932"></a> -<span class="sourceLineNo">933</span> CompletableFuture<ClusterMetrics> getClusterMetrics(EnumSet<Option> options);<a name="line.933"></a> -<span class="sourceLineNo">934</span><a name="line.934"></a> -<span class="sourceLineNo">935</span> /**<a name="line.935"></a> -<span class="sourceLineNo">936</span> * @return current master server name wrapped by {@link CompletableFuture}<a name="line.936"></a> -<span class="sourceLineNo">937</span> */<a name="line.937"></a> -<span class="sourceLineNo">938</span> default CompletableFuture<ServerName> getMaster() {<a name="line.938"></a> -<span class="sourceLineNo">939</span> return getClusterMetrics(EnumSet.of(Option.MASTER)).thenApply(ClusterMetrics::getMasterName);<a name="line.939"></a> -<span class="sourceLineNo">940</span> }<a name="line.940"></a> -<span class="sourceLineNo">941</span><a name="line.941"></a> -<span class="sourceLineNo">942</span> /**<a name="line.942"></a> -<span class="sourceLineNo">943</span> * @return current backup master list wrapped by {@link CompletableFuture}<a name="line.943"></a> -<span class="sourceLineNo">944</span> */<a name="line.944"></a> -<span class="sourceLineNo">945</span> default CompletableFuture<Collection<ServerName>> getBackupMasters() {<a name="line.945"></a> -<span class="sourceLineNo">946</span> return getClusterMetrics(EnumSet.of(Option.BACKUP_MASTERS))<a name="line.946"></a> -<span class="sourceLineNo">947</span> .thenApply(ClusterMetrics::getBackupMasterNames);<a name="line.947"></a> -<span class="sourceLineNo">948</span> }<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> * @return current live region servers list wrapped by {@link CompletableFuture}<a name="line.951"></a> -<span class="sourceLineNo">952</span> */<a name="line.952"></a> -<span class="sourceLineNo">953</span> default CompletableFuture<Collection<ServerName>> getRegionServers() {<a name="line.953"></a> -<span class="sourceLineNo">954</span> return getClusterMetrics(EnumSet.of(Option.LIVE_SERVERS))<a name="line.954"></a> -<span class="sourceLineNo">955</span> .thenApply(cm -> cm.getLiveServerMetrics().keySet());<a name="line.955"></a> -<span class="sourceLineNo">956</span> }<a name="line.956"></a> -<span class="sourceLineNo">957</span><a name="line.957"></a> -<span class="sourceLineNo">958</span> /**<a name="line.958"></a> -<span class="sourceLineNo">959</span> * @return a list of master coprocessors wrapped by {@link CompletableFuture}<a name="line.959"></a> -<span class="sourceLineNo">960</span> */<a name="line.960"></a> -<span class="sourceLineNo">961</span> default CompletableFuture<List<String>> getMasterCoprocessorNames() {<a name="line.961"></a> -<span class="sourceLineNo">962</span> return getClusterMetrics(EnumSet.of(Option.MASTER_COPROCESSORS))<a name="line.962"></a> -<span class="sourceLineNo">963</span> .thenApply(ClusterMetrics::getMasterCoprocessorNames);<a name="line.963"></a> -<span class="sourceLineNo">964</span> }<a name="line.964"></a> -<span class="sourceLineNo">965</span><a name="line.965"></a> -<span class="sourceLineNo">966</span> /**<a name="line.966"></a> -<span class="sourceLineNo">967</span> * Get the info port of the current master if one is available.<a name="line.967"></a> -<span class="sourceLineNo">968</span> * @return master info port<a name="line.968"></a> -<span class="sourceLineNo">969</span> */<a name="line.969"></a> -<span class="sourceLineNo">970</span> default CompletableFuture<Integer> getMasterInfoPort() {<a name="line.970"></a> -<span class="sourceLineNo">971</span> return getClusterMetrics(EnumSet.of(Option.MASTER_INFO_PORT)).thenApply(<a name="line.971"></a> -<span class="sourceLineNo">972</span> ClusterMetrics::getMasterInfoPort);<a name="line.972"></a> -<span class="sourceLineNo">973</span> }<a name="line.973"></a> -<span class="sourceLineNo">974</span><a name="line.974"></a> -<span class="sourceLineNo">975</span> /**<a name="line.975"></a> -<span class="sourceLineNo">976</span> * Shuts down the HBase cluster.<a name="line.976"></a> -<span class="sourceLineNo">977</span> */<a name="line.977"></a> -<span class="sourceLineNo">978</span> CompletableFuture<Void> shutdown();<a name="line.978"></a> -<span class="sourceLineNo">979</span><a name="line.979"></a> -<span class="sourceLineNo">980</span> /**<a name="line.980"></a> -<span class="sourceLineNo">981</span> * Shuts down the current HBase master only.<a name="line.981"></a> -<span class="sourceLineNo">982</span> */<a name="line.982"></a> -<span class="sourceLineNo">983</span> CompletableFuture<Void> stopMaster();<a name="line.983"></a> -<span class="sourceLineNo">984</span><a name="line.984"></a> -<span class="sourceLineNo">985</span> /**<a name="line.985"></a> -<span class="sourceLineNo">986</span> * Stop the designated regionserver.<a name="line.986"></a> -<span class="sourceLineNo">987</span> * @param serverName<a name="line.987"></a> -<span class="sourceLineNo">988</span> */<a name="line.988"></a> -<span class="sourceLineNo">989</span> CompletableFuture<Void> stopRegionServer(ServerName serverName);<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> * Update the configuration and trigger an online config change on the regionserver.<a name="line.992"></a> -<span class="sourceLineNo">993</span> * @param serverName : The server whose config needs to be updated.<a name="line.993"></a> -<span class="sourceLineNo">994</span> */<a name="line.994"></a> -<span class="sourceLineNo">995</span> CompletableFuture<Void> updateConfiguration(ServerName serverName);<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> * Update the configuration and trigger an online config change on all the masters and<a name="line.998"></a> -<span class="sourceLineNo">999</span> * regionservers.<a name="line.999"></a> -<span class="sourceLineNo">1000</span> */<a name="line.1000"></a> -<span class="sourceLineNo">1001</span> CompletableFuture<Void> updateConfiguration();<a name="line.1001"></a> -<span class="sourceLineNo">1002</span><a name="line.1002"></a> -<span class="sourceLineNo">1003</span> /**<a name="line.1003"></a> -<span class="sourceLineNo">1004</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.1004"></a> -<span class="sourceLineNo">1005</span> * <p><a name="line.1005"></a> -<span class="sourceLineNo">1006</span> * When the returned CompletableFuture is done, it only means the rollWALWriter request was sent<a name="line.1006"></a> -<span class="sourceLineNo">1007</span> * to the region server and may need some time to finish the rollWALWriter operation. As a side<a name="line.1007"></a> -<span class="sourceLineNo">1008</span> * effect of this call, the named region server may schedule store flushes at the request of the<a name="line.1008"></a> -<span class="sourceLineNo">1009</span> * wal.<a name="line.1009"></a> -<span class="sourceLineNo">1010</span> * @param serverName The servername of the region server.<a name="line.1010"></a> -<span class="sourceLineNo">1011</span> */<a name="line.1011"></a> -<span class="sourceLineNo">1012</span> CompletableFuture<Void> rollWALWriter(ServerName serverName);<a name="line.1012"></a> -<span class="sourceLineNo">1013</span><a name="line.1013"></a> -<span class="sourceLineNo">1014</span> /**<a name="line.1014"></a> -<span class="sourceLineNo">1015</span> * Clear compacting queues on a region server.<a name="line.1015"></a> -<span class="sourceLineNo">1016</span> * @param serverName<a name="line.1016"></a> -<span class="sourceLineNo">1017</span> * @param queues the set of queue name<a name="line.1017"></a> -<span class="sourceLineNo">1018</span> */<a name="line.1018"></a> -<span class="sourceLineNo">1019</span> CompletableFuture<Void> clearCompactionQueues(ServerName serverName, Set<String> queues);<a name="line.1019"></a> -<span class="sourceLineNo">1020</span><a name="line.1020"></a> -<span class="sourceLineNo">1021</span> /**<a name="line.1021"></a> -<span class="sourceLineNo">1022</span> * Get a list of {@link RegionMetrics} of all regions hosted on a region seerver.<a name="line.1022"></a> -<span class="sourceLineNo">1023</span> * @param serverName<a name="line.1023"></a> -<span class="sourceLineNo">1024</span> * @return a list of {@link RegionMetrics} wrapped by {@link CompletableFuture}<a name="line.1024"></a> -<span class="sourceLineNo">1025</span> */<a name="line.1025"></a> -<span class="sourceLineNo">1026</span> CompletableFuture<List<RegionMetrics>> getRegionMetrics(ServerName serverName);<a name="line.1026"></a> -<span class="sourceLineNo">1027</span><a name="line.1027"></a> -<span class="sourceLineNo">1028</span> /**<a name="line.1028"></a> -<span class="sourceLineNo">1029</span> * Get a list of {@link RegionMetrics} of all regions hosted on a region seerver for a table.<a name="line.1029"></a> -<span class="sourceLineNo">1030</span> * @param serverName<a name="line.1030"></a> -<span class="sourceLineNo">1031</span> * @param tableName<a name="line.1031"></a> -<span class="sourceLineNo">1032</span> * @return a list of {@link RegionMetrics} wrapped by {@link CompletableFuture}<a name="line.1032"></a> -<span class="sourceLineNo">1033</span> */<a name="line.1033"></a> -<span class="sourceLineNo">1034</span> CompletableFuture<List<RegionMetrics>> getRegionMetrics(ServerName serverName,<a name="line.1034"></a> -<span class="sourceLineNo">1035</span> TableName tableName);<a name="line.1035"></a> -<span class="sourceLineNo">1036</span><a name="line.1036"></a> -<span class="sourceLineNo">1037</span> /**<a name="line.1037"></a> -<span class="sourceLineNo">1038</span> * Check whether master is in maintenance mode<a name="line.1038"></a> -<span class="sourceLineNo">1039</span> * @return true if master is in maintenance mode, false otherwise. The return value will be<a name="line.1039"></a> -<span class="sourceLineNo">1040</span> * wrapped by a {@link CompletableFuture}<a name="line.1040"></a> -<span class="sourceLineNo">1041</span> */<a name="line.1041"></a> -<span class="sourceLineNo">1042</span> CompletableFuture<Boolean> isMasterInMaintenanceMode();<a name="line.1042"></a> -<span class="sourceLineNo">1043</span><a name="line.1043"></a> -<span class="sourceLineNo">1044</span> /**<a name="line.1044"></a> -<span class="sourceLineNo">1045</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1045"></a> -<span class="sourceLineNo">1046</span> * compaction, both, or none.<a name="line.1046"></a> -<span class="sourceLineNo">1047</span> * @param tableName table to examine<a name="line.1047"></a> -<span class="sourceLineNo">1048</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1048"></a> -<span class="sourceLineNo">1049</span> */<a name="line.1049"></a> -<span class="sourceLineNo">1050</span> default CompletableFuture<CompactionState> getCompactionState(TableName tableName) {<a name="line.1050"></a> -<span class="sourceLineNo">1051</span> return getCompactionState(tableName, CompactType.NORMAL);<a name="line.1051"></a> -<span class="sourceLineNo">1052</span> }<a name="line.1052"></a> -<span class="sourceLineNo">1053</span><a name="line.1053"></a> -<span class="sourceLineNo">1054</span> /**<a name="line.1054"></a> -<span class="sourceLineNo">1055</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1055"></a> -<span class="sourceLineNo">1056</span> * compaction, both, or none.<a name="line.1056"></a> -<span class="sourceLineNo">1057</span> * @param tableName table to examine<a name="line.1057"></a> -<span class="sourceLineNo">1058</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.1058"></a> -<span class="sourceLineNo">1059</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1059"></a> -<span class="sourceLineNo">1060</span> */<a name="line.1060"></a> -<span class="sourceLineNo">1061</span> CompletableFuture<CompactionState> getCompactionState(TableName tableName,<a name="line.1061"></a> -<span class="sourceLineNo">1062</span> CompactType compactType);<a name="line.1062"></a> -<span class="sourceLineNo">1063</span><a name="line.1063"></a> -<span class="sourceLineNo">1064</span> /**<a name="line.1064"></a> -<span class="sourceLineNo">1065</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.1065"></a> -<span class="sourceLineNo">1066</span> * compaction, both, or none.<a name="line.1066"></a> -<span class="sourceLineNo">1067</span> * @param regionName region to examine<a name="line.1067"></a> -<span class="sourceLineNo">1068</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1068"></a> -<span class="sourceLineNo">1069</span> */<a name="line.1069"></a> -<span class="sourceLineNo">1070</span> CompletableFuture<CompactionState> getCompactionStateForRegion(byte[] regionName);<a name="line.1070"></a> -<span class="sourceLineNo">1071</span><a name="line.1071"></a> -<span class="sourceLineNo">1072</span> /**<a name="line.1072"></a> -<span class="sourceLineNo">1073</span> * Get the timestamp of the last major compaction for the passed table.<a name="line.1073"></a> -<span class="sourceLineNo">1074</span> * <p><a name="line.1074"></a> -<span class="sourceLineNo">1075</span> * The timestamp of the oldest HFile resulting from a major compaction of that table, or not<a name="line.1075"></a> -<span class="sourceLineNo">1076</span> * present if no such HFile could be found.<a name="line.1076"></a> -<span class="sourceLineNo">1077</span> * @param tableName table to examine<a name="line.1077"></a> -<span class="sourceLineNo">1078</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.1078"></a> -<span class="sourceLineNo">1079</span> */<a name="line.1079"></a> -<span class="sourceLineNo">1080</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestamp(TableName tableName);<a name="line.1080"></a> -<span class="sourceLineNo">1081</span><a name="line.1081"></a> -<span class="sourceLineNo">1082</span> /**<a name="line.1082"></a> -<span class="sourceLineNo">1083</span> * Get the timestamp of the last major compaction for the passed region.<a name="line.1083"></a> -<span class="sourceLineNo">1084</span> * <p><a name="line.1084"></a> -<span class="sourceLineNo">1085</span> * The timestamp of the oldest HFile resulting from a major compaction of that region, or not<a name="line.1085"></a> -<span class="sourceLineNo">1086</span> * present if no such HFile could be found.<a name="line.1086"></a> -<span class="sourceLineNo">1087</span> * @param regionName region to examine<a name="line.1087"></a> -<span class="sourceLineNo">1088</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.1088"></a> -<span class="sourceLineNo">1089</span> */<a name="line.1089"></a> -<span class="sourceLineNo">1090</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestampForRegion(byte[] regionName);<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> * @return the list of supported security capabilities. The return value will be wrapped by a<a name="line.1093"></a> -<span class="sourceLineNo">1094</span> * {@link CompletableFuture}.<a name="line.1094"></a> -<span class="sourceLineNo">1095</span> */<a name="line.1095"></a> -<span class="sourceLineNo">1096</span> CompletableFuture<List<SecurityCapability>> getSecurityCapabilities();<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> * Turn the load balancer on or off.<a name="line.1099"></a> -<span class="sourceLineNo">1100</span> * @param on<a name="line.1100"></a> -<span class="sourceLineNo">1101</span> * @return Previous balancer value wrapped by a {@link CompletableFuture}.<a name="line.1101"></a> -<span class="sourceLineNo">1102</span> */<a name="line.1102"></a> -<span class="sourceLineNo">1103</span> CompletableFuture<Boolean> balancerSwitch(boolean on);<a name="line.1103"></a> -<span class="sourceLineNo">1104</span><a name="line.1104"></a> -<span class="sourceLineNo">1105</span> /**<a name="line.1105"></a> -<span class="sourceLineNo">1106</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1106"></a> -<span class="sourceLineNo">1107</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1107"></a> -<span class="sourceLineNo">1108</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.1108"></a> -<span class="sourceLineNo">1109</span> * {@link CompletableFuture}.<a name="line.1109"></a> -<span class="sourceLineNo">1110</span> */<a name="line.1110"></a> -<span class="sourceLineNo">1111</span> default CompletableFuture<Boolean> balance() {<a name="line.1111"></a> -<span class="sourceLineNo">1112</span> return balance(false);<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 go ahead and do the<a name="line.1116"></a> -<span class="sourceLineNo">1117</span> * reassignments. If there is region in transition, force parameter of true would still run<a name="line.1117"></a> -<span class="sourceLineNo">1118</span> * balancer. Can *not* run for other reasons. Check logs.<a name="line.1118"></a> -<span class="sourceLineNo">1119</span> * @param forcible whether we should force balance even if there is region in transition.<a name="line.1119"></a> -<span class="sourceLineNo">1120</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.1120"></a> -<span class="sourceLineNo">1121</span> * {@link CompletableFuture}.<a name="line.1121"></a> -<span class="sourceLineNo">1122</span> */<a name="line.1122"></a> -<span class="sourceLineNo">1123</span> CompletableFuture<Boolean> balance(boolean forcible);<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> * @return true if the balance switch is on, false otherwise. The return value will be wrapped by a<a name="line.1127"></a> -<span class="sourceLineNo">1128</span> * {@link CompletableFuture}.<a name="line.1128"></a> -<span class="sourceLineNo">1129</span> */<a name="line.1129"></a> -<span class="sourceLineNo">1130</span> CompletableFuture<Boolean> isBalancerEnabled();<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> * Set region normalizer on/off.<a name="line.1133"></a> -<span class="sourceLineNo">1134</span> * @param on whether normalizer should be on or off<a name="line.1134"></a> -<span class="sourceLineNo">1135</span> * @return Previous normalizer value wrapped by a {@link CompletableFuture}<a name="line.1135"></a> -<span class="sourceLineNo">1136</span> */<a name="line.1136"></a> -<span class="sourceLineNo">1137</span> CompletableFuture<Boolean> normalizerSwitch(boolean on);<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> * Query the current state of the region normalizer<a name="line.1140"></a> -<span class="sourceLineNo">1141</span> * @return true if region normalizer is on, false otherwise. The return value will be wrapped by a<a name="line.1141"></a> -<span class="sourceLineNo">1142</span> * {@link CompletableFuture}<a name="line.1142"></a> -<span class="sourceLineNo">1143</span> */<a name="line.1143"></a> -<span class="sourceLineNo">1144</span> CompletableFuture<Boolean> isNormalizerEnabled();<a name="line.1144"></a> -<span class="sourceLineNo">1145</span><a name="line.1145"></a> -<span class="sourceLineNo">1146</span> /**<a name="line.1146"></a> -<span class="sourceLineNo">1147</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1147"></a> -<span class="sourceLineNo">1148</span> * @return true if region normalizer ran, false otherwise. The return value will be wrapped by a<a name="line.1148"></a> -<span class="sourceLineNo">1149</span> * {@link CompletableFuture}<a name="line.1149"></a> -<span class="sourceLineNo">1150</span> */<a name="line.1150"></a> -<span class="sourceLineNo">1151</span> CompletableFuture<Boolean> normalize();<a name="line.1151"></a> -<span class="sourceLineNo">1152</span><a name="line.1152"></a> -<span class="sourceLineNo">1153</span> /**<a name="line.1153"></a> -<span class="sourceLineNo">1154</span> * Turn the cleaner chore on/off.<a name="line.1154"></a> -<span class="sourceLineNo">1155</span> * @param on<a name="line.1155"></a> -<span class="sourceLineNo">1156</span> * @return Previous cleaner state wrapped by a {@link CompletableFuture}<a name="line.1156"></a> -<span class="sourceLineNo">1157</span> */<a name="line.1157"></a> -<span class="sourceLineNo">1158</span> CompletableFuture<Boolean> cleanerChoreSwitch(boolean on);<a name="line.1158"></a> -<span class="sourceLineNo">1159</span><a name="line.1159"></a> -<span class="sourceLineNo">1160</span> /**<a name="line.1160"></a> -<span class="sourceLineNo">1161</span> * Query the current state of the cleaner chore.<a name="line.1161"></a> -<span class="sourceLineNo">1162</span> * @return true if cleaner chore is on, false otherwise. The return value will be wrapped by<a name="line.1162"></a> -<span class="sourceLineNo">1163</span> * a {@link CompletableFuture}<a name="line.1163"></a> -<span class="sourceLineNo">1164</span> */<a name="line.1164"></a> -<span class="sourceLineNo">1165</span> CompletableFuture<Boolean> isCleanerChoreEnabled();<a name="line.1165"></a> -<span class="sourceLineNo">1166</span><a name="line.1166"></a> -<span class="sourceLineNo">1167</span> /**<a name="line.1167"></a> -<span class="sourceLineNo">1168</span> * Ask for cleaner chore to run.<a name="line.1168"></a> -<span class="sourceLineNo">1169</span> * @return true if cleaner chore ran, false otherwise. The return value will be wrapped by a<a name="line.1169"></a> -<span class="sourceLineNo">1170</span> * {@link CompletableFuture}<a name="line.1170"></a> -<span class="sourceLineNo">1171</span> */<a name="line.1171"></a> -<span class="sourceLineNo">1172</span> CompletableFuture<Boolean> runCleanerChore();<a name="line.1172"></a> -<span class="sourceLineNo">1173</span><a name="line.1173"></a> -<span class="sourceLineNo">1174</span> /**<a name="line.1174"></a> -<span class="sourceLineNo">1175</span> * Turn the catalog janitor on/off.<a name="line.1175"></a> -<span class="sourceLineNo">1176</span> * @param on<a name="line.1176"></a> -<span class="sourceLineNo">1177</span> * @return the previous state wrapped by a {@link CompletableFuture}<a name="line.1177"></a> -<span class="sourceLineNo">1178</span> */<a name="line.1178"></a> -<span class="sourceLineNo">1179</span> CompletableFuture<Boolean> catalogJanitorSwitch(boolean on);<a name="line.1179"></a> -<span class="sourceLineNo">1180</span><a name="line.1180"></a> -<span class="sourceLineNo">1181</span> /**<a name="line.1181"></a> -<span class="sourceLineNo">1182</span> * Query on the catalog janitor state.<a name="line.1182"></a> -<span class="sourceLineNo">1183</span> * @return true if the catalog janitor is on, false otherwise. The return value will be<a name="line.1183"></a> -<span class="sourceLineNo">1184</span> * wrapped by a {@link CompletableFuture}<a name="line.1184"></a> -<span class="sourceLineNo">1185</span> */<a name="line.1185"></a> -<span class="sourceLineNo">1186</span> CompletableFuture<Boolean> isCatalogJanitorEnabled();<a name="line.1186"></a> -<span class="sourceLineNo">1187</span><a name="line.1187"></a> -<span class="sourceLineNo">1188</span> /**<a name="line.1188"></a> -<span class="sourceLineNo">1189</span> * Ask for a scan of the catalog table.<a name="line.1189"></a> -<span class="sourceLineNo">1190</span> * @return the number of entries cleaned. The return value will be wrapped by a<a name="line.1190"></a> -<span class="sourceLineNo">1191</span> * {@link CompletableFuture}<a name="line.1191"></a> -<span class="sourceLineNo">1192</span> */<a name="line.1192"></a> -<span class="sourceLineNo">1193</span> CompletableFuture<Integer> runCatalogJanitor();<a name="line.1193"></a> -<span class="sourceLineNo">1194</span><a name="line.1194"></a> -<span class="sourceLineNo">1195</span> /**<a name="line.1195"></a> -<span class="sourceLineNo">1196</span> * Execute the given coprocessor call on the master.<a name="line.1196"></a> -<span class="sourceLineNo">1197</span> * <p><a name="line.1197"></a> -<span class="sourceLineNo">1198</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1198"></a> -<span class="sourceLineNo">1199</span> * one line lambda expression, like:<a name="line.1199"></a> -<span class="sourceLineNo">1200</span> *<a name="line.1200"></a> -<span class="sourceLineNo">1201</span> * <pre><a name="line.1201"></a> -<span class="sourceLineNo">1202</span> * <code><a name="line.1202"></a> -<span class="sourceLineNo">1203</span> * channel -> xxxService.newStub(channel)<a name="line.1203"></a> -<span class="sourceLineNo">1204</span> * </code><a name="line.1204"></a> -<span class="sourceLineNo">1205</span> * </pre><a name="line.1205"></a> -<span class="sourceLineNo">1206</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1206"></a> -<span class="sourceLineNo">1207</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1207"></a> -<span class="sourceLineNo">1208</span> * {@link ServiceCaller} for more details.<a name="line.1208"></a> -<span class="sourceLineNo">1209</span> * @param <S> the type of the asynchronous stub<a name="line.1209"></a> -<span class="sourceLineNo">1210</span> * @param <R> the type of the return value<a name="line.1210"></a> -<span class="sourceLineNo">1211</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1211"></a> -<span class="sourceLineNo">1212</span> * @see ServiceCaller<a name="line.1212"></a> -<span class="sourceLineNo">1213</span> */<a name="line.1213"></a> -<span class="sourceLineNo">1214</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1214"></a> -<span class="sourceLineNo">1215</span> ServiceCaller<S, R> callable);<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> * Execute the given coprocessor call on the given region server.<a name="line.1218"></a> -<span class="sourceLineNo">1219</span> * <p><a name="line.1219"></a> -<span class="sourceLineNo">1220</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1220"></a> -<span class="sourceLineNo">1221</span> * one line lambda expression, like:<a name="line.1221"></a> -<span class="sourceLineNo">1222</span> *<a name="line.1222"></a> -<span class="sourceLineNo">1223</span> * <pre><a name="line.1223"></a> -<span class="sourceLineNo">1224</span> * <code><a name="line.1224"></a> -<span class="sourceLineNo">1225</span> * channel -> xxxService.newStub(channel)<a name="line.1225"></a> -<span class="sourceLineNo">1226</span> * </code><a name="line.1226"></a> -<span class="sourceLineNo">1227</span> * </pre><a name="line.1227"></a> -<span class="sourceLineNo">1228</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1228"></a> -<span class="sourceLineNo">1229</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1229"></a> -<span class="sourceLineNo">1230</span> * {@link ServiceCaller} for more details.<a name="line.1230"></a> -<span class="sourceLineNo">1231</span> * @param serverName the given region server<a name="line.1231"></a> -<span class="sourceLineNo">1232</span> * @param <S> the type of the asynchronous stub<a name="line.1232"></a> -<span class="sourceLineNo">1233</span> * @param <R> the type of the return value<a name="line.1233"></a> -<span class="sourceLineNo">1234</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1234"></a> -<span class="sourceLineNo">1235</span> * @see ServiceCaller<a name="line.1235"></a> -<span class="sourceLineNo">1236</span> */<a name="line.1236"></a> -<span class="sourceLineNo">1237</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1237"></a> -<span class="sourceLineNo">1238</span> ServiceCaller<S, R> callable, ServerName serverName);<a name="line.1238"></a> -<span class="sourceLineNo">1239</span><a name="line.1239"></a> -<span class="sourceLineNo">1240</span> /**<a name="line.1240"></a> -<span class="sourceLineNo">1241</span> * List all the dead region servers.<a name="line.1241"></a> -<span class="sourceLineNo">1242</span> */<a name="line.1242"></a> -<span class="sourceLineNo">1243</span> default CompletableFuture<List<ServerName>> listDeadServers() {<a name="line.1243"></a> -<span class="sourceLineNo">1244</span> return this.getClusterMetrics(EnumSet.of(Option.DEAD_SERVERS))<a name="line.1244"></a> -<span class="sourceLineNo">1245</span> .thenApply(ClusterMetrics::getDeadServerNames);<a name="line.1245"></a> -<span class="sourceLineNo">1246</span> }<a name="line.1246"></a> -<span class="sourceLineNo">1247</span><a name="line.1247"></a> -<span class="sourceLineNo">1248</span> /**<a name="line.1248"></a> -<span class="sourceLineNo">1249</span> * Clear dead region servers from master.<a name="line.1249"></a> -<span class="sourceLineNo">1250</span> * @param servers list of dead region servers.<a name="line.1250"></a> -<span class="sourceLineNo">1251</span> * @return - returns a list of servers that not cleared wrapped by a {@link CompletableFuture}.<a name="line.1251"></a> -<span class="sourceLineNo">1252</span> */<a name="line.1252"></a> -<span class="sourceLineNo">1253</span> CompletableFuture<List<ServerName>> clearDeadServers(final List<ServerName> servers);<a name="line.1253"></a> -<span class="sourceLineNo">1254</span><a name="line.1254"></a> -<span class="sourceLineNo">1255</span> /**<a name="line.1255"></a> -<span class="sourceLineNo">1256</span> * Clear all the blocks corresponding to this table from BlockCache. For expert-admins. Calling<a name="line.1256"></a> -<span class="sourceLineNo">1257</span> * this API will drop all the cached blocks specific to a table from BlockCache. This can<a name="line.1257"></a> -<span class="sourceLineNo">1258</span> * significantly impact the query performance as the subsequent queries will have to retrieve the<a name="line.1258"></a> -<span class="sourceLineNo">1259</span> * blocks from underlying filesystem.<a name="line.1259"></a> -<span class="sourceLineNo">1260</span> * @param tableName table to clear block cache<a name="line.1260"></a> -<span class="sourceLineNo">1261</span> * @return CacheEvictionStats related to the eviction wrapped by a {@link CompletableFuture}.<a name="line.1261"></a> -<span class="sourceLineNo">1262</span> */<a name="line.1262"></a> -<span class="sourceLineNo">1263</span> CompletableFuture<CacheEvictionStats> clearBlockCache(final TableName tableName);<a name="line.1263"></a> -<span class="sourceLineNo">1264</span><a name="line.1264"></a> -<span class="sourceLineNo">1265</span> /**<a name="line.1265"></a> -<span class="sourceLineNo">1266</span> * Create a new table by cloning the existent table schema.<a name="line.1266"></a> -<span class="sourceLineNo">1267</span> *<a name="line.1267"></a> -<span class="sourceLineNo">1268</span> * @param tableName name of the table to be cloned<a name="line.1268"></a> -<span class="sourceLineNo">1269</span> * @param newTableName name of the new table where the table will be created<a name="line.1269"></a> -<span class="sourceLineNo">1270</span> * @param preserveSplits True if the splits should be preserved<a name="line.1270"></a> -<span class="sourceLineNo">1271</span> */<a name="line.1271"></a> -<span class="sourceLineNo">1272</span> CompletableFuture<Void> cloneTableSchema(final TableName tableName,<a name="line.1272"></a> -<span class="sourceLineNo">1273</span> final TableName newTableName, final boolean preserveSplits);<a name="line.1273"></a> -<span class="sourceLineNo">1274</span><a name="line.1274"></a> -<span class="sourceLineNo">1275</span> /**<a name="line.1275"></a> -<span class="sourceLineNo">1276</span> * Turn the compaction on or off. Disabling compactions will also interrupt any currently ongoing<a name="line.1276"></a> -<span class="sourceLineNo">1277</span> * compactions. This state is ephemeral. The setting will be lost on restart. Compaction<a name="line.1277"></a> -<span class="sourceLineNo">1278</span> * can also be enabled/disabled by modifying configuration hbase.regionserver.compaction.enabled<a name="line.1278"></a> -<span class="sourceLineNo">1279</span> * in hbase-site.xml.<a name="line.1279"></a> -<span class="sourceLineNo">1280</span> *<a name="line.1280"></a> -<span class="sourceLineNo">1281</span> * @param switchState Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1281"></a> -<span class="sourceLineNo">1282</span> * @param serverNamesList list of region servers.<a name="line.1282"></a> -<span class="sourceLineNo">1283</span> * @return Previous compaction states for region servers<a name="line.1283"></a> -<span class="sourceLineNo">1284</span> */<a name="line.1284"></a> -<span class="sourceLineNo">1285</span> CompletableFuture<Map<ServerName, Boolean>> compactionSwitch(boolean switchState,<a name="line.1285"></a> -<span class="sourceLineNo">1286</span> List<String> serverNamesList);<a name="line.1286"></a> -<span class="sourceLineNo">1287</span>}<a name="line.1287"></a> +<span class="sourceLineNo">880</span> * Abort a procedure<a name="line.880"></a> +<span class="sourceLineNo">881</span> * Do not use. Usually it is ignored but if not, it can do more damage than good. See hbck2.<a name="line.881"></a> +<span class="sourceLineNo">882</span> * @param procId ID of the procedure to abort<a name="line.882"></a> +<span class="sourceLineNo">883</span> * @param mayInterruptIfRunning if the proc completed at least one step, should it be aborted?<a name="line.883"></a> +<span class="sourceLineNo">884</span> * @return true if aborted, false if procedure already completed or does not exist. the value is<a name="line.884"></a> +<span class="sourceLineNo">885</span> * wrapped by {@link CompletableFuture}<a name="line.885"></a> +<span class="sourceLineNo">886</span> * @deprecated Since 2.1.1 -- to be removed.<a name="line.886"></a> +<span class="sourceLineNo">887</span> */<a name="line.887"></a> +<span class="sourceLineNo">888</span> @Deprecated<a name="line.888"></a> +<span class="sourceLineNo">889</span> CompletableFuture<Boolean> abortProcedure(long procId, boolean mayInterruptIfRunning);<a name="line.889"></a> +<span class="sourceLineNo">890</span><a name="line.890"></a> +<span class="sourceLineNo">891</span> /**<a name="line.891"></a> +<span class="sourceLineNo">892</span> * List procedures<a name="line.892"></a> +<span class="sourceLineNo">893</span> * @return procedure list JSON wrapped by {@link CompletableFuture}<a name="line.893"></a> +<span class="sourceLineNo">894</span> */<a name="line.894"></a> +<span class="sourceLineNo">895</span> CompletableFuture<String> getProcedures();<a name="line.895"></a> +<span class="sourceLineNo">896</span><a name="line.896"></a> +<span class="sourceLineNo">897</span> /**<a name="line.897"></a> +<span class="sourceLineNo">898</span> * List locks.<a name="line.898"></a> +<span class="sourceLineNo">899</span> * @return lock list JSON wrapped by {@link CompletableFuture}<a name="line.899"></a> +<span class="sourceLineNo">900</span> */<a name="line.900"></a> +<span class="sourceLineNo">901</span> CompletableFuture<String> getLocks();<a name="line.901"></a> +<span class="sourceLineNo">902</span><a name="line.902"></a> +<span class="sourceLineNo">903</span> /**<a name="line.903"></a> +<span class="sourceLineNo">904</span> * Mark region server(s) as decommissioned to prevent additional regions from getting<a name="line.904"></a> +<span class="sourceLineNo">905</span> * assigned to them. Optionally unload the regions on the servers. If there are multiple servers<a name="line.905"></a> +<span class="sourceLineNo">906</span> * to be decommissioned, decommissioning them at the same time can prevent wasteful region<a name="line.906"></a> +<span class="sourceLineNo">907</span> * movements. Region unloading is asynchronous.<a name="line.907"></a> +<span class="sourceLineNo">908</span> * @param servers The list of servers to decommission.<a name="line.908"></a> +<span class="sourceLineNo">909</span> * @param offload True to offload the regions from the decommissioned servers<a name="line.909"></a> +<span class="sourceLineNo">910</span> */<a name="line.910"></a> +<span class="sourceLineNo">911</span> CompletableFuture<Void> decommissionRegionServers(List<ServerName> servers, boolean offload);<a name="line.911"></a> +<span class="sourceLineNo">912</span><a name="line.912"></a> +<span class="sourceLineNo">913</span> /**<a name="line.913"></a> +<span class="sourceLineNo">914</span> * List region servers marked as decommissioned, which can not be assigned regions.<a name="line.914"></a> +<span class="sourceLineNo">915</span> * @return List of decommissioned region servers wrapped by {@link CompletableFuture}<a name="line.915"></a> +<span class="sourceLineNo">916</span> */<a name="line.916"></a> +<span class="sourceLineNo">917</span> CompletableFuture<List<ServerName>> listDecommissionedRegionServers();<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> * Remove decommission marker from a region server to allow regions assignments. Load regions onto<a name="line.920"></a> +<span class="sourceLineNo">921</span> * the server if a list of regions is given. Region loading is asynchronous.<a name="line.921"></a> +<span class="sourceLineNo">922</span> * @param server The server to recommission.<a name="line.922"></a> +<span class="sourceLineNo">923</span> * @param encodedRegionNames Regions to load onto the server.<a name="line.923"></a> +<span class="sourceLineNo">924</span> */<a name="line.924"></a> +<span class="sourceLineNo">925</span> CompletableFuture<Void> recommissionRegionServer(ServerName server,<a name="line.925"></a> +<span class="sourceLineNo">926</span> List<byte[]> encodedRegionNames);<a name="line.926"></a> +<span class="sourceLineNo">927</span><a name="line.927"></a> +<span class="sourceLineNo">928</span> /**<a name="line.928"></a> +<span class="sourceLineNo">929</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.929"></a> +<span class="sourceLineNo">930</span> */<a name="line.930"></a> +<span class="sourceLineNo">931</span> CompletableFuture<ClusterMetrics> getClusterMetrics();<a name="line.931"></a> +<span class="sourceLineNo">932</span><a name="line.932"></a> +<span class="sourceLineNo">933</span> /**<a name="line.933"></a> +<span class="sourceLineNo">934</span> * @return cluster status wrapped by {@link CompletableFuture}<a name="line.934"></a> +<span class="sourceLineNo">935</span> */<a name="line.935"></a> +<span class="sourceLineNo">936</span> CompletableFuture<ClusterMetrics> getClusterMetrics(EnumSet<Option> options);<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> * @return current master server name wrapped by {@link CompletableFuture}<a name="line.939"></a> +<span class="sourceLineNo">940</span> */<a name="line.940"></a> +<span class="sourceLineNo">941</span> default CompletableFuture<ServerName> getMaster() {<a name="line.941"></a> +<span class="sourceLineNo">942</span> return getClusterMetrics(EnumSet.of(Option.MASTER)).thenApply(ClusterMetrics::getMasterName);<a name="line.942"></a> +<span class="sourceLineNo">943</span> }<a name="line.943"></a> +<span class="sourceLineNo">944</span><a name="line.944"></a> +<span class="sourceLineNo">945</span> /**<a name="line.945"></a> +<span class="sourceLineNo">946</span> * @return current backup master list wrapped by {@link CompletableFuture}<a name="line.946"></a> +<span class="sourceLineNo">947</span> */<a name="line.947"></a> +<span class="sourceLineNo">948</span> default CompletableFuture<Collection<ServerName>> getBackupMasters() {<a name="line.948"></a> +<span class="sourceLineNo">949</span> return getClusterMetrics(EnumSet.of(Option.BACKUP_MASTERS))<a name="line.949"></a> +<span class="sourceLineNo">950</span> .thenApply(ClusterMetrics::getBackupMasterNames);<a name="line.950"></a> +<span class="sourceLineNo">951</span> }<a name="line.951"></a> +<span class="sourceLineNo">952</span><a name="line.952"></a> +<span class="sourceLineNo">953</span> /**<a name="line.953"></a> +<span class="sourceLineNo">954</span> * @return current live region servers list wrapped by {@link CompletableFuture}<a name="line.954"></a> +<span class="sourceLineNo">955</span> */<a name="line.955"></a> +<span class="sourceLineNo">956</span> default CompletableFuture<Collection<ServerName>> getRegionServers() {<a name="line.956"></a> +<span class="sourceLineNo">957</span> return getClusterMetrics(EnumSet.of(Option.LIVE_SERVERS))<a name="line.957"></a> +<span class="sourceLineNo">958</span> .thenApply(cm -> cm.getLiveServerMetrics().keySet());<a name="line.958"></a> +<span class="sourceLineNo">959</span> }<a name="line.959"></a> +<span class="sourceLineNo">960</span><a name="line.960"></a> +<span class="sourceLineNo">961</span> /**<a name="line.961"></a> +<span class="sourceLineNo">962</span> * @return a list of master coprocessors wrapped by {@link CompletableFuture}<a name="line.962"></a> +<span class="sourceLineNo">963</span> */<a name="line.963"></a> +<span class="sourceLineNo">964</span> default CompletableFuture<List<String>> getMasterCoprocessorNames() {<a name="line.964"></a> +<span class="sourceLineNo">965</span> return getClusterMetrics(EnumSet.of(Option.MASTER_COPROCESSORS))<a name="line.965"></a> +<span class="sourceLineNo">966</span> .thenApply(ClusterMetrics::getMasterCoprocessorNames);<a name="line.966"></a> +<span class="sourceLineNo">967</span> }<a name="line.967"></a> +<span class="sourceLineNo">968</span><a name="line.968"></a> +<span class="sourceLineNo">969</span> /**<a name="line.969"></a> +<span class="sourceLineNo">970</span> * Get the info port of the current master if one is available.<a name="line.970"></a> +<span class="sourceLineNo">971</span> * @return master info port<a name="line.971"></a> +<span class="sourceLineNo">972</span> */<a name="line.972"></a> +<span class="sourceLineNo">973</span> default CompletableFuture<Integer> getMasterInfoPort() {<a name="line.973"></a> +<span class="sourceLineNo">974</span> return getClusterMetrics(EnumSet.of(Option.MASTER_INFO_PORT)).thenApply(<a name="line.974"></a> +<span class="sourceLineNo">975</span> ClusterMetrics::getMasterInfoPort);<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> /**<a name="line.978"></a> +<span class="sourceLineNo">979</span> * Shuts down the HBase cluster.<a name="line.979"></a> +<span class="sourceLineNo">980</span> */<a name="line.980"></a> +<span class="sourceLineNo">981</span> CompletableFuture<Void> shutdown();<a name="line.981"></a> +<span class="sourceLineNo">982</span><a name="line.982"></a> +<span class="sourceLineNo">983</span> /**<a name="line.983"></a> +<span class="sourceLineNo">984</span> * Shuts down the current HBase master only.<a name="line.984"></a> +<span class="sourceLineNo">985</span> */<a name="line.985"></a> +<span class="sourceLineNo">986</span> CompletableFuture<Void> stopMaster();<a name="line.986"></a> +<span class="sourceLineNo">987</span><a name="line.987"></a> +<span class="sourceLineNo">988</span> /**<a name="line.988"></a> +<span class="sourceLineNo">989</span> * Stop the designated regionserver.<a name="line.989"></a> +<span class="sourceLineNo">990</span> * @param serverName<a name="line.990"></a> +<span class="sourceLineNo">991</span> */<a name="line.991"></a> +<span class="sourceLineNo">992</span> CompletableFuture<Void> stopRegionServer(ServerName serverName);<a name="line.992"></a> +<span class="sourceLineNo">993</span><a name="line.993"></a> +<span class="sourceLineNo">994</span> /**<a name="line.994"></a> +<span class="sourceLineNo">995</span> * Update the configuration and trigger an online config change on the regionserver.<a name="line.995"></a> +<span class="sourceLineNo">996</span> * @param serverName : The server whose config needs to be updated.<a name="line.996"></a> +<span class="sourceLineNo">997</span> */<a name="line.997"></a> +<span class="sourceLineNo">998</span> CompletableFuture<Void> updateConfiguration(ServerName serverName);<a name="line.998"></a> +<span class="sourceLineNo">999</span><a name="line.999"></a> +<span class="sourceLineNo">1000</span> /**<a name="line.1000"></a> +<span class="sourceLineNo">1001</span> * Update the configuration and trigger an online config change on all the masters and<a name="line.1001"></a> +<span class="sourceLineNo">1002</span> * regionservers.<a name="line.1002"></a> +<span class="sourceLineNo">1003</span> */<a name="line.1003"></a> +<span class="sourceLineNo">1004</span> CompletableFuture<Void> updateConfiguration();<a name="line.1004"></a> +<span class="sourceLineNo">1005</span><a name="line.1005"></a> +<span class="sourceLineNo">1006</span> /**<a name="line.1006"></a> +<span class="sourceLineNo">1007</span> * Roll the log writer. I.e. for filesystem based write ahead logs, start writing to a new file.<a name="line.1007"></a> +<span class="sourceLineNo">1008</span> * <p><a name="line.1008"></a> +<span class="sourceLineNo">1009</span> * When the returned CompletableFuture is done, it only means the rollWALWriter request was sent<a name="line.1009"></a> +<span class="sourceLineNo">1010</span> * to the region server and may need some time to finish the rollWALWriter operation. As a side<a name="line.1010"></a> +<span class="sourceLineNo">1011</span> * effect of this call, the named region server may schedule store flushes at the request of the<a name="line.1011"></a> +<span class="sourceLineNo">1012</span> * wal.<a name="line.1012"></a> +<span class="sourceLineNo">1013</span> * @param serverName The servername of the region server.<a name="line.1013"></a> +<span class="sourceLineNo">1014</span> */<a name="line.1014"></a> +<span class="sourceLineNo">1015</span> CompletableFuture<Void> rollWALWriter(ServerName serverName);<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> * Clear compacting queues on a region server.<a name="line.1018"></a> +<span class="sourceLineNo">1019</span> * @param serverName<a name="line.1019"></a> +<span class="sourceLineNo">1020</span> * @param queues the set of queue name<a name="line.1020"></a> +<span class="sourceLineNo">1021</span> */<a name="line.1021"></a> +<span class="sourceLineNo">1022</span> CompletableFuture<Void> clearCompactionQueues(ServerName serverName, Set<String> queues);<a name="line.1022"></a> +<span class="sourceLineNo">1023</span><a name="line.1023"></a> +<span class="sourceLineNo">1024</span> /**<a name="line.1024"></a> +<span class="sourceLineNo">1025</span> * Get a list of {@link RegionMetrics} of all regions hosted on a region seerver.<a name="line.1025"></a> +<span class="sourceLineNo">1026</span> * @param serverName<a name="line.1026"></a> +<span class="sourceLineNo">1027</span> * @return a list of {@link RegionMetrics} wrapped by {@link CompletableFuture}<a name="line.1027"></a> +<span class="sourceLineNo">1028</span> */<a name="line.1028"></a> +<span class="sourceLineNo">1029</span> CompletableFuture<List<RegionMetrics>> getRegionMetrics(ServerName serverName);<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> * Get a list of {@link RegionMetrics} of all regions hosted on a region seerver for a table.<a name="line.1032"></a> +<span class="sourceLineNo">1033</span> * @param serverName<a name="line.1033"></a> +<span class="sourceLineNo">1034</span> * @param tableName<a name="line.1034"></a> +<span class="sourceLineNo">1035</span> * @return a list of {@link RegionMetrics} wrapped by {@link CompletableFuture}<a name="line.1035"></a> +<span class="sourceLineNo">1036</span> */<a name="line.1036"></a> +<span class="sourceLineNo">1037</span> CompletableFuture<List<RegionMetrics>> getRegionMetrics(ServerName serverName,<a name="line.1037"></a> +<span class="sourceLineNo">1038</span> TableName tableName);<a name="line.1038"></a> +<span class="sourceLineNo">1039</span><a name="line.1039"></a> +<span class="sourceLineNo">1040</span> /**<a name="line.1040"></a> +<span class="sourceLineNo">1041</span> * Check whether master is in maintenance mode<a name="line.1041"></a> +<span class="sourceLineNo">1042</span> * @return true if master is in maintenance mode, false otherwise. The return value will be<a name="line.1042"></a> +<span class="sourceLineNo">1043</span> * wrapped by a {@link CompletableFuture}<a name="line.1043"></a> +<span class="sourceLineNo">1044</span> */<a name="line.1044"></a> +<span class="sourceLineNo">1045</span> CompletableFuture<Boolean> isMasterInMaintenanceMode();<a name="line.1045"></a> +<span class="sourceLineNo">1046</span><a name="line.1046"></a> +<span class="sourceLineNo">1047</span> /**<a name="line.1047"></a> +<span class="sourceLineNo">1048</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1048"></a> +<span class="sourceLineNo">1049</span> * compaction, both, or none.<a name="line.1049"></a> +<span class="sourceLineNo">1050</span> * @param tableName table to examine<a name="line.1050"></a> +<span class="sourceLineNo">1051</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1051"></a> +<span class="sourceLineNo">1052</span> */<a name="line.1052"></a> +<span class="sourceLineNo">1053</span> default CompletableFuture<CompactionState> getCompactionState(TableName tableName) {<a name="line.1053"></a> +<span class="sourceLineNo">1054</span> return getCompactionState(tableName, CompactType.NORMAL);<a name="line.1054"></a> +<span class="sourceLineNo">1055</span> }<a name="line.1055"></a> +<span class="sourceLineNo">1056</span><a name="line.1056"></a> +<span class="sourceLineNo">1057</span> /**<a name="line.1057"></a> +<span class="sourceLineNo">1058</span> * Get the current compaction state of a table. It could be in a major compaction, a minor<a name="line.1058"></a> +<span class="sourceLineNo">1059</span> * compaction, both, or none.<a name="line.1059"></a> +<span class="sourceLineNo">1060</span> * @param tableName table to examine<a name="line.1060"></a> +<span class="sourceLineNo">1061</span> * @param compactType {@link org.apache.hadoop.hbase.client.CompactType}<a name="line.1061"></a> +<span class="sourceLineNo">1062</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1062"></a> +<span class="sourceLineNo">1063</span> */<a name="line.1063"></a> +<span class="sourceLineNo">1064</span> CompletableFuture<CompactionState> getCompactionState(TableName tableName,<a name="line.1064"></a> +<span class="sourceLineNo">1065</span> CompactType compactType);<a name="line.1065"></a> +<span class="sourceLineNo">1066</span><a name="line.1066"></a> +<span class="sourceLineNo">1067</span> /**<a name="line.1067"></a> +<span class="sourceLineNo">1068</span> * Get the current compaction state of region. It could be in a major compaction, a minor<a name="line.1068"></a> +<span class="sourceLineNo">1069</span> * compaction, both, or none.<a name="line.1069"></a> +<span class="sourceLineNo">1070</span> * @param regionName region to examine<a name="line.1070"></a> +<span class="sourceLineNo">1071</span> * @return the current compaction state wrapped by a {@link CompletableFuture}<a name="line.1071"></a> +<span class="sourceLineNo">1072</span> */<a name="line.1072"></a> +<span class="sourceLineNo">1073</span> CompletableFuture<CompactionState> getCompactionStateForRegion(byte[] regionName);<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> * Get the timestamp of the last major compaction for the passed table.<a name="line.1076"></a> +<span class="sourceLineNo">1077</span> * <p><a name="line.1077"></a> +<span class="sourceLineNo">1078</span> * The timestamp of the oldest HFile resulting from a major compaction of that table, or not<a name="line.1078"></a> +<span class="sourceLineNo">1079</span> * present if no such HFile could be found.<a name="line.1079"></a> +<span class="sourceLineNo">1080</span> * @param tableName table to examine<a name="line.1080"></a> +<span class="sourceLineNo">1081</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.1081"></a> +<span class="sourceLineNo">1082</span> */<a name="line.1082"></a> +<span class="sourceLineNo">1083</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestamp(TableName tableName);<a name="line.1083"></a> +<span class="sourceLineNo">1084</span><a name="line.1084"></a> +<span class="sourceLineNo">1085</span> /**<a name="line.1085"></a> +<span class="sourceLineNo">1086</span> * Get the timestamp of the last major compaction for the passed region.<a name="line.1086"></a> +<span class="sourceLineNo">1087</span> * <p><a name="line.1087"></a> +<span class="sourceLineNo">1088</span> * The timestamp of the oldest HFile resulting from a major compaction of that region, or not<a name="line.1088"></a> +<span class="sourceLineNo">1089</span> * present if no such HFile could be found.<a name="line.1089"></a> +<span class="sourceLineNo">1090</span> * @param regionName region to examine<a name="line.1090"></a> +<span class="sourceLineNo">1091</span> * @return the last major compaction timestamp wrapped by a {@link CompletableFuture}<a name="line.1091"></a> +<span class="sourceLineNo">1092</span> */<a name="line.1092"></a> +<span class="sourceLineNo">1093</span> CompletableFuture<Optional<Long>> getLastMajorCompactionTimestampForRegion(byte[] regionName);<a name="line.1093"></a> +<span class="sourceLineNo">1094</span><a name="line.1094"></a> +<span class="sourceLineNo">1095</span> /**<a name="line.1095"></a> +<span class="sourceLineNo">1096</span> * @return the list of supported security capabilities. The return value will be wrapped by a<a name="line.1096"></a> +<span class="sourceLineNo">1097</span> * {@link CompletableFuture}.<a name="line.1097"></a> +<span class="sourceLineNo">1098</span> */<a name="line.1098"></a> +<span class="sourceLineNo">1099</span> CompletableFuture<List<SecurityCapability>> getSecurityCapabilities();<a name="line.1099"></a> +<span class="sourceLineNo">1100</span><a name="line.1100"></a> +<span class="sourceLineNo">1101</span> /**<a name="line.1101"></a> +<span class="sourceLineNo">1102</span> * Turn the load balancer on or off.<a name="line.1102"></a> +<span class="sourceLineNo">1103</span> * @param on<a name="line.1103"></a> +<span class="sourceLineNo">1104</span> * @return Previous balancer value wrapped by a {@link CompletableFuture}.<a name="line.1104"></a> +<span class="sourceLineNo">1105</span> */<a name="line.1105"></a> +<span class="sourceLineNo">1106</span> CompletableFuture<Boolean> balancerSwitch(boolean on);<a name="line.1106"></a> +<span class="sourceLineNo">1107</span><a name="line.1107"></a> +<span class="sourceLineNo">1108</span> /**<a name="line.1108"></a> +<span class="sourceLineNo">1109</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1109"></a> +<span class="sourceLineNo">1110</span> * reassignments. Can NOT run for various reasons. Check logs.<a name="line.1110"></a> +<span class="sourceLineNo">1111</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.1111"></a> +<span class="sourceLineNo">1112</span> * {@link CompletableFuture}.<a name="line.1112"></a> +<span class="sourceLineNo">1113</span> */<a name="line.1113"></a> +<span class="sourceLineNo">1114</span> default CompletableFuture<Boolean> balance() {<a name="line.1114"></a> +<span class="sourceLineNo">1115</span> return balance(false);<a name="line.1115"></a> +<span class="sourceLineNo">1116</span> }<a name="line.1116"></a> +<span class="sourceLineNo">1117</span><a name="line.1117"></a> +<span class="sourceLineNo">1118</span> /**<a name="line.1118"></a> +<span class="sourceLineNo">1119</span> * Invoke the balancer. Will run the balancer and if regions to move, it will go ahead and do the<a name="line.1119"></a> +<span class="sourceLineNo">1120</span> * reassignments. If there is region in transition, force parameter of true would still run<a name="line.1120"></a> +<span class="sourceLineNo">1121</span> * balancer. Can *not* run for other reasons. Check logs.<a name="line.1121"></a> +<span class="sourceLineNo">1122</span> * @param forcible whether we should force balance even if there is region in transition.<a name="line.1122"></a> +<span class="sourceLineNo">1123</span> * @return True if balancer ran, false otherwise. The return value will be wrapped by a<a name="line.1123"></a> +<span class="sourceLineNo">1124</span> * {@link CompletableFuture}.<a name="line.1124"></a> +<span class="sourceLineNo">1125</span> */<a name="line.1125"></a> +<span class="sourceLineNo">1126</span> CompletableFuture<Boolean> balance(boolean forcible);<a name="line.1126"></a> +<span class="sourceLineNo">1127</span><a name="line.1127"></a> +<span class="sourceLineNo">1128</span> /**<a name="line.1128"></a> +<span class="sourceLineNo">1129</span> * Query the current state of the balancer.<a name="line.1129"></a> +<span class="sourceLineNo">1130</span> * @return true if the balance switch is on, false otherwise. The return value will be wrapped by a<a name="line.1130"></a> +<span class="sourceLineNo">1131</span> * {@link CompletableFuture}.<a name="line.1131"></a> +<span class="sourceLineNo">1132</span> */<a name="line.1132"></a> +<span class="sourceLineNo">1133</span> CompletableFuture<Boolean> isBalancerEnabled();<a name="line.1133"></a> +<span class="sourceLineNo">1134</span><a name="line.1134"></a> +<span class="sourceLineNo">1135</span> /**<a name="line.1135"></a> +<span class="sourceLineNo">1136</span> * Set region normalizer on/off.<a name="line.1136"></a> +<span class="sourceLineNo">1137</span> * @param on whether normalizer should be on or off<a name="line.1137"></a> +<span class="sourceLineNo">1138</span> * @return Previous normalizer value wrapped by a {@link CompletableFuture}<a name="line.1138"></a> +<span class="sourceLineNo">1139</span> */<a name="line.1139"></a> +<span class="sourceLineNo">1140</span> CompletableFuture<Boolean> normalizerSwitch(boolean on);<a name="line.1140"></a> +<span class="sourceLineNo">1141</span><a name="line.1141"></a> +<span class="sourceLineNo">1142</span> /**<a name="line.1142"></a> +<span class="sourceLineNo">1143</span> * Query the current state of the region normalizer<a name="line.1143"></a> +<span class="sourceLineNo">1144</span> * @return true if region normalizer is on, false otherwise. The return value will be wrapped by a<a name="line.1144"></a> +<span class="sourceLineNo">1145</span> * {@link CompletableFuture}<a name="line.1145"></a> +<span class="sourceLineNo">1146</span> */<a name="line.1146"></a> +<span class="sourceLineNo">1147</span> CompletableFuture<Boolean> isNormalizerEnabled();<a name="line.1147"></a> +<span class="sourceLineNo">1148</span><a name="line.1148"></a> +<span class="sourceLineNo">1149</span> /**<a name="line.1149"></a> +<span class="sourceLineNo">1150</span> * Invoke region normalizer. Can NOT run for various reasons. Check logs.<a name="line.1150"></a> +<span class="sourceLineNo">1151</span> * @return true if region normalizer ran, false otherwise. The return value will be wrapped by a<a name="line.1151"></a> +<span class="sourceLineNo">1152</span> * {@link CompletableFuture}<a name="line.1152"></a> +<span class="sourceLineNo">1153</span> */<a name="line.1153"></a> +<span class="sourceLineNo">1154</span> CompletableFuture<Boolean> normalize();<a name="line.1154"></a> +<span class="sourceLineNo">1155</span><a name="line.1155"></a> +<span class="sourceLineNo">1156</span> /**<a name="line.1156"></a> +<span class="sourceLineNo">1157</span> * Turn the cleaner chore on/off.<a name="line.1157"></a> +<span class="sourceLineNo">1158</span> * @param on<a name="line.1158"></a> +<span class="sourceLineNo">1159</span> * @return Previous cleaner state wrapped by a {@link CompletableFuture}<a name="line.1159"></a> +<span class="sourceLineNo">1160</span> */<a name="line.1160"></a> +<span class="sourceLineNo">1161</span> CompletableFuture<Boolean> cleanerChoreSwitch(boolean on);<a name="line.1161"></a> +<span class="sourceLineNo">1162</span><a name="line.1162"></a> +<span class="sourceLineNo">1163</span> /**<a name="line.1163"></a> +<span class="sourceLineNo">1164</span> * Query the current state of the cleaner chore.<a name="line.1164"></a> +<span class="sourceLineNo">1165</span> * @return true if cleaner chore is on, false otherwise. The return value will be wrapped by<a name="line.1165"></a> +<span class="sourceLineNo">1166</span> * a {@link CompletableFuture}<a name="line.1166"></a> +<span class="sourceLineNo">1167</span> */<a name="line.1167"></a> +<span class="sourceLineNo">1168</span> CompletableFuture<Boolean> isCleanerChoreEnabled();<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> * Ask for cleaner chore to run.<a name="line.1171"></a> +<span class="sourceLineNo">1172</span> * @return true if cleaner chore ran, false otherwise. The return value will be wrapped by a<a name="line.1172"></a> +<span class="sourceLineNo">1173</span> * {@link CompletableFuture}<a name="line.1173"></a> +<span class="sourceLineNo">1174</span> */<a name="line.1174"></a> +<span class="sourceLineNo">1175</span> CompletableFuture<Boolean> runCleanerChore();<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> * Turn the catalog janitor on/off.<a name="line.1178"></a> +<span class="sourceLineNo">1179</span> * @param on<a name="line.1179"></a> +<span class="sourceLineNo">1180</span> * @return the previous state wrapped by a {@link CompletableFuture}<a name="line.1180"></a> +<span class="sourceLineNo">1181</span> */<a name="line.1181"></a> +<span class="sourceLineNo">1182</span> CompletableFuture<Boolean> catalogJanitorSwitch(boolean on);<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> * Query on the catalog janitor state.<a name="line.1185"></a> +<span class="sourceLineNo">1186</span> * @return true if the catalog janitor is on, false otherwise. The return value will be<a name="line.1186"></a> +<span class="sourceLineNo">1187</span> * wrapped by a {@link CompletableFuture}<a name="line.1187"></a> +<span class="sourceLineNo">1188</span> */<a name="line.1188"></a> +<span class="sourceLineNo">1189</span> CompletableFuture<Boolean> isCatalogJanitorEnabled();<a name="line.1189"></a> +<span class="sourceLineNo">1190</span><a name="line.1190"></a> +<span class="sourceLineNo">1191</span> /**<a name="line.1191"></a> +<span class="sourceLineNo">1192</span> * Ask for a scan of the catalog table.<a name="line.1192"></a> +<span class="sourceLineNo">1193</span> * @return the number of entries cleaned. The return value will be wrapped by a<a name="line.1193"></a> +<span class="sourceLineNo">1194</span> * {@link CompletableFuture}<a name="line.1194"></a> +<span class="sourceLineNo">1195</span> */<a name="line.1195"></a> +<span class="sourceLineNo">1196</span> CompletableFuture<Integer> runCatalogJanitor();<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> * Execute the given coprocessor call on the master.<a name="line.1199"></a> +<span class="sourceLineNo">1200</span> * <p><a name="line.1200"></a> +<span class="sourceLineNo">1201</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1201"></a> +<span class="sourceLineNo">1202</span> * one line lambda expression, like:<a name="line.1202"></a> +<span class="sourceLineNo">1203</span> *<a name="line.1203"></a> +<span class="sourceLineNo">1204</span> * <pre><a name="line.1204"></a> +<span class="sourceLineNo">1205</span> * <code><a name="line.1205"></a> +<span class="sourceLineNo">1206</span> * channel -> xxxService.newStub(channel)<a name="line.1206"></a> +<span class="sourceLineNo">1207</span> * </code><a name="line.1207"></a> +<span class="sourceLineNo">1208</span> * </pre><a name="line.1208"></a> +<span class="sourceLineNo">1209</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1209"></a> +<span class="sourceLineNo">1210</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1210"></a> +<span class="sourceLineNo">1211</span> * {@link ServiceCaller} for more details.<a name="line.1211"></a> +<span class="sourceLineNo">1212</span> * @param <S> the type of the asynchronous stub<a name="line.1212"></a> +<span class="sourceLineNo">1213</span> * @param <R> the type of the return value<a name="line.1213"></a> +<span class="sourceLineNo">1214</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1214"></a> +<span class="sourceLineNo">1215</span> * @see ServiceCaller<a name="line.1215"></a> +<span class="sourceLineNo">1216</span> */<a name="line.1216"></a> +<span class="sourceLineNo">1217</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1217"></a> +<span class="sourceLineNo">1218</span> ServiceCaller<S, R> callable);<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> * Execute the given coprocessor call on the given region server.<a name="line.1221"></a> +<span class="sourceLineNo">1222</span> * <p><a name="line.1222"></a> +<span class="sourceLineNo">1223</span> * The {@code stubMaker} is just a delegation to the {@code newStub} call. Usually it is only a<a name="line.1223"></a> +<span class="sourceLineNo">1224</span> * one line lambda expression, like:<a name="line.1224"></a> +<span class="sourceLineNo">1225</span> *<a name="line.1225"></a> +<span class="sourceLineNo">1226</span> * <pre><a name="line.1226"></a> +<span class="sourceLineNo">1227</span> * <code><a name="line.1227"></a> +<span class="sourceLineNo">1228</span> * channel -> xxxService.newStub(channel)<a name="line.1228"></a> +<span class="sourceLineNo">1229</span> * </code><a name="line.1229"></a> +<span class="sourceLineNo">1230</span> * </pre><a name="line.1230"></a> +<span class="sourceLineNo">1231</span> * @param stubMaker a delegation to the actual {@code newStub} call.<a name="line.1231"></a> +<span class="sourceLineNo">1232</span> * @param callable a delegation to the actual protobuf rpc call. See the comment of<a name="line.1232"></a> +<span class="sourceLineNo">1233</span> * {@link ServiceCaller} for more details.<a name="line.1233"></a> +<span class="sourceLineNo">1234</span> * @param serverName the given region server<a name="line.1234"></a> +<span class="sourceLineNo">1235</span> * @param <S> the type of the asynchronous stub<a name="line.1235"></a> +<span class="sourceLineNo">1236</span> * @param <R> the type of the return value<a name="line.1236"></a> +<span class="sourceLineNo">1237</span> * @return the return value of the protobuf rpc call, wrapped by a {@link CompletableFuture}.<a name="line.1237"></a> +<span class="sourceLineNo">1238</span> * @see ServiceCaller<a name="line.1238"></a> +<span class="sourceLineNo">1239</span> */<a name="line.1239"></a> +<span class="sourceLineNo">1240</span> <S, R> CompletableFuture<R> coprocessorService(Function<RpcChannel, S> stubMaker,<a name="line.1240"></a> +<span class="sourceLineNo">1241</span> ServiceCaller<S, R> callable, ServerName serverName);<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> * List all the dead region servers.<a name="line.1244"></a> +<span class="sourceLineNo">1245</span> */<a name="line.1245"></a> +<span class="sourceLineNo">1246</span> default CompletableFuture<List<ServerName>> listDeadServers() {<a name="line.1246"></a> +<span class="sourceLineNo">1247</span> return this.getClusterMetrics(EnumSet.of(Option.DEAD_SERVERS))<a name="line.1247"></a> +<span class="sourceLineNo">1248</span> .thenApply(ClusterMetrics::getDeadServerNames);<a name="line.1248"></a> +<span class="sourceLineNo">1249</span> }<a name="line.1249"></a> +<span class="sourceLineNo">1250</span><a name="line.1250"></a> +<span class="sourceLineNo">1251</span> /**<a name="line.1251"></a> +<span class="sourceLineNo">1252</span> * Clear dead region servers from master.<a name="line.1252"></a> +<span class="sourceLineNo">1253</span> * @param servers list of dead region servers.<a name="line.1253"></a> +<span class="sourceLineNo">1254</span> * @return - returns a list of servers that not cleared wrapped by a {@link CompletableFuture}.<a name="line.1254"></a> +<span class="sourceLineNo">1255</span> */<a name="line.1255"></a> +<span class="sourceLineNo">1256</span> CompletableFuture<List<ServerName>> clearDeadServers(final List<ServerName> servers);<a name="line.1256"></a> +<span class="sourceLineNo">1257</span><a name="line.1257"></a> +<span class="sourceLineNo">1258</span> /**<a name="line.1258"></a> +<span class="sourceLineNo">1259</span> * Clear all the blocks corresponding to this table from BlockCache. For expert-admins. Calling<a name="line.1259"></a> +<span class="sourceLineNo">1260</span> * this API will drop all the cached blocks specific to a table from BlockCache. This can<a name="line.1260"></a> +<span class="sourceLineNo">1261</span> * significantly impact the query performance as the subsequent queries will have to retrieve the<a name="line.1261"></a> +<span class="sourceLineNo">1262</span> * blocks from underlying filesystem.<a name="line.1262"></a> +<span class="sourceLineNo">1263</span> * @param tableName table to clear block cache<a name="line.1263"></a> +<span class="sourceLineNo">1264</span> * @return CacheEvictionStats related to the eviction wrapped by a {@link CompletableFuture}.<a name="line.1264"></a> +<span class="sourceLineNo">1265</span> */<a name="line.1265"></a> +<span class="sourceLineNo">1266</span> CompletableFuture<CacheEvictionStats> clearBlockCache(final TableName tableName);<a name="line.1266"></a> +<span class="sourceLineNo">1267</span><a name="line.1267"></a> +<span class="sourceLineNo">1268</span> /**<a name="line.1268"></a> +<span class="sourceLineNo">1269</span> * Create a new table by cloning the existent table schema.<a name="line.1269"></a> +<span class="sourceLineNo">1270</span> *<a name="line.1270"></a> +<span class="sourceLineNo">1271</span> * @param tableName name of the table to be cloned<a name="line.1271"></a> +<span class="sourceLineNo">1272</span> * @param newTableName name of the new table where the table will be created<a name="line.1272"></a> +<span class="sourceLineNo">1273</span> * @param preserveSplits True if the splits should be preserved<a name="line.1273"></a> +<span class="sourceLineNo">1274</span> */<a name="line.1274"></a> +<span class="sourceLineNo">1275</span> CompletableFuture<Void> cloneTableSchema(final TableName tableName,<a name="line.1275"></a> +<span class="sourceLineNo">1276</span> final TableName newTableName, final boolean preserveSplits);<a name="line.1276"></a> +<span class="sourceLineNo">1277</span><a name="line.1277"></a> +<span class="sourceLineNo">1278</span> /**<a name="line.1278"></a> +<span class="sourceLineNo">1279</span> * Turn the compaction on or off. Disabling compactions will also interrupt any currently ongoing<a name="line.1279"></a> +<span class="sourceLineNo">1280</span> * compactions. This state is ephemeral. The setting will be lost on restart. Compaction<a name="line.1280"></a> +<span class="sourceLineNo">1281</span> * can also be enabled/disabled by modifying configuration hbase.regionserver.compaction.enabled<a name="line.1281"></a> +<span class="sourceLineNo">1282</span> * in hbase-site.xml.<a name="line.1282"></a> +<span class="sourceLineNo">1283</span> *<a name="line.1283"></a> +<span class="sourceLineNo">1284</span> * @param switchState Set to <code>true</code> to enable, <code>false</code> to disable.<a name="line.1284"></a> +<span class="sourceLineNo">1285</span> * @param serverNamesList list of region servers.<a name="line.1285"></a> +<span class="sourceLineNo">1286</span> * @return Previous compaction states for region servers<a name="line.1286"></a> +<span class="sourceLineNo">1287</span> */<a name="line.1287"></a> +<span class="sourceLineNo">1288</span> CompletableFuture<Map<ServerName, Boolean>> compactionSwitch(boolean switchState,<a name="line.1288"></a> +<span class="sourceLineNo">1289</span> List<String> serverNamesList);<a name="line.1289"></a> +<span class="sourceLineNo">1290</span>}<a name="line.1290"></a>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/37cf49a6/book.html ---------------------------------------------------------------------- diff --git a/book.html b/book.html index 2eb63b5..e6b63e7 100644 --- a/book.html +++ b/book.html @@ -41284,7 +41284,7 @@ org/apache/hadoop/hbase/security/access/AccessControlClient.revoke:(Lorg/apache/ <div id="footer"> <div id="footer-text"> Version 3.0.0-SNAPSHOT<br> -Last updated 2018-09-25 14:36:10 UTC +Last updated 2018-09-26 14:33:45 UTC </div> </div> </body> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/37cf49a6/bulk-loads.html ---------------------------------------------------------------------- diff --git a/bulk-loads.html b/bulk-loads.html index 79a2f7e..980eba9 100644 --- a/bulk-loads.html +++ b/bulk-loads.html @@ -7,7 +7,7 @@ <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta name="Date-Revision-yyyymmdd" content="20180925" /> + <meta name="Date-Revision-yyyymmdd" content="20180926" /> <meta http-equiv="Content-Language" content="en" /> <title>Apache HBase – Bulk Loads in Apache HBase (TM) @@ -306,7 +306,7 @@ under the License. --> <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved. - <li id="publishDate" class="pull-right">Last Published: 2018-09-25</li> + <li id="publishDate" class="pull-right">Last Published: 2018-09-26</li> </p> </div>
