001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import java.io.Closeable;
021import java.io.IOException;
022import java.util.List;
023import java.util.Map;
024import java.util.stream.Collectors;
025
026import org.apache.hadoop.hbase.Abortable;
027import org.apache.hadoop.hbase.HBaseInterfaceAudience;
028import org.apache.hadoop.hbase.ServerName;
029import org.apache.yetus.audience.InterfaceAudience;
030
031import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;
032import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;
033
034/**
035 * Hbck fixup tool APIs. Obtain an instance from {@link ClusterConnection#getHbck()} and call
036 * {@link #close()} when done.
037 * <p>WARNING: the below methods can damage the cluster. It may leave the cluster in an
038 * indeterminate state, e.g. region not assigned, or some hdfs files left behind. After running
039 * any of the below, operators may have to do some clean up on hdfs or schedule some assign
040 * procedures to get regions back online. DO AT YOUR OWN RISK. For experienced users only.
041 *
042 * @see ConnectionFactory
043 * @see ClusterConnection
044 * @since 2.0.2, 2.1.1
045 */
046@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.HBCK)
047public interface Hbck extends Abortable, Closeable {
048  /**
049   * Update table state in Meta only. No procedures are submitted to open/assign or
050   * close/unassign regions of the table.
051   * @param state table state
052   * @return previous state of the table in Meta
053   */
054  TableState setTableStateInMeta(TableState state) throws IOException;
055
056  /**
057   * Like {@link Admin#assign(byte[])} but 'raw' in that it can do more than one Region at a time
058   * -- good if many Regions to online -- and it will schedule the assigns even in the case where
059   * Master is initializing (as long as the ProcedureExecutor is up). Does NOT call Coprocessor
060   * hooks.
061   * @param override You need to add the override for case where a region has previously been
062   *              bypassed. When a Procedure has been bypassed, a Procedure will have completed
063   *              but no other Procedure will be able to make progress on the target entity
064   *              (intentionally). This override flag will override this fencing mechanism.
065   * @param encodedRegionNames Region encoded names; e.g. 1588230740 is the hard-coded encoding
066   *                           for hbase:meta region and de00010733901a05f5a2a3a382e27dd4 is an
067   *                           example of what a random user-space encoded Region name looks like.
068   */
069  List<Long> assigns(List<String> encodedRegionNames, boolean override) throws IOException;
070
071  default List<Long> assigns(List<String> encodedRegionNames) throws IOException {
072    return assigns(encodedRegionNames, false);
073  }
074
075  /**
076   * Like {@link Admin#unassign(byte[], boolean)} but 'raw' in that it can do more than one Region
077   * at a time -- good if many Regions to offline -- and it will schedule the assigns even in the
078   * case where Master is initializing (as long as the ProcedureExecutor is up). Does NOT call
079   * Coprocessor hooks.
080   * @param override You need to add the override for case where a region has previously been
081   *              bypassed. When a Procedure has been bypassed, a Procedure will have completed
082   *              but no other Procedure will be able to make progress on the target entity
083   *              (intentionally). This override flag will override this fencing mechanism.
084   * @param encodedRegionNames Region encoded names; e.g. 1588230740 is the hard-coded encoding
085   *                           for hbase:meta region and de00010733901a05f5a2a3a382e27dd4 is an
086   *                           example of what a random user-space encoded Region name looks like.
087   */
088  List<Long> unassigns(List<String> encodedRegionNames, boolean override) throws IOException;
089
090  default List<Long> unassigns(List<String> encodedRegionNames) throws IOException {
091    return unassigns(encodedRegionNames, false);
092  }
093
094  /**
095   * Bypass specified procedure and move it to completion. Procedure is marked completed but
096   * no actual work is done from the current state/step onwards. Parents of the procedure are
097   * also marked for bypass.
098   *
099   * @param pids of procedures to complete.
100   * @param waitTime wait time in ms for acquiring lock for a procedure
101   * @param override if override set to true, we will bypass the procedure even if it is executing.
102   *   This is for procedures which can't break out during execution (bugs?).
103   * @param recursive If set, if a parent procedure, we will find and bypass children and then
104   *   the parent procedure (Dangerous but useful in case where child procedure has been 'lost').
105   *   Does not always work. Experimental.
106   * @return true if procedure is marked for bypass successfully, false otherwise
107   */
108  List<Boolean> bypassProcedure(List<Long> pids, long waitTime, boolean override, boolean recursive)
109      throws IOException;
110
111  /**
112   * Use {@link #scheduleServerCrashProcedures(List)} instead.
113   * @deprecated since 2.2.1. Will removed in 3.0.0.
114   */
115  @Deprecated
116  default List<Long> scheduleServerCrashProcedure(List<HBaseProtos.ServerName> serverNames)
117      throws IOException {
118    return scheduleServerCrashProcedures(
119        serverNames.stream().map(ProtobufUtil::toServerName).collect(Collectors.toList()));
120  }
121
122  List<Long> scheduleServerCrashProcedures(List<ServerName> serverNames) throws IOException;
123
124  /**
125   * Request HBCK chore to run at master side.
126   *
127   * @return <code>true</code> if HBCK chore ran, <code>false</code> if HBCK chore already running
128   * @throws IOException if a remote or network exception occurs
129   */
130  boolean runHbckChore() throws IOException;
131
132  /**
133   * Fix Meta.
134   */
135  void fixMeta() throws IOException;
136}