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;
023
024import org.apache.hadoop.hbase.Abortable;
025import org.apache.hadoop.hbase.HBaseInterfaceAudience;
026import org.apache.yetus.audience.InterfaceAudience;
027
028import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;
029
030/**
031 * Hbck fixup tool APIs. Obtain an instance from {@link ClusterConnection#getHbck()} and call
032 * {@link #close()} when done.
033 * <p>WARNING: the below methods can damage the cluster. It may leave the cluster in an
034 * indeterminate state, e.g. region not assigned, or some hdfs files left behind. After running
035 * any of the below, operators may have to do some clean up on hdfs or schedule some assign
036 * procedures to get regions back online. DO AT YOUR OWN RISK. For experienced users only.
037 *
038 * @see ConnectionFactory
039 * @see ClusterConnection
040 * @since 2.0.2, 2.1.1
041 */
042@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.HBCK)
043public interface Hbck extends Abortable, Closeable {
044  /**
045   * Update table state in Meta only. No procedures are submitted to open/assign or
046   * close/unassign regions of the table.
047   * @param state table state
048   * @return previous state of the table in Meta
049   */
050  TableState setTableStateInMeta(TableState state) throws IOException;
051
052  /**
053   * Like {@link Admin#assign(byte[])} but 'raw' in that it can do more than one Region at a time
054   * -- good if many Regions to online -- and it will schedule the assigns even in the case where
055   * Master is initializing (as long as the ProcedureExecutor is up). Does NOT call Coprocessor
056   * hooks.
057   * @param override You need to add the override for case where a region has previously been
058   *              bypassed. When a Procedure has been bypassed, a Procedure will have completed
059   *              but no other Procedure will be able to make progress on the target entity
060   *              (intentionally). This override flag will override this fencing mechanism.
061   * @param encodedRegionNames Region encoded names; e.g. 1588230740 is the hard-coded encoding
062   *                           for hbase:meta region and de00010733901a05f5a2a3a382e27dd4 is an
063   *                           example of what a random user-space encoded Region name looks like.
064   */
065  List<Long> assigns(List<String> encodedRegionNames, boolean override) throws IOException;
066
067  default List<Long> assigns(List<String> encodedRegionNames) throws IOException {
068    return assigns(encodedRegionNames, false);
069  }
070
071  /**
072   * Like {@link Admin#unassign(byte[], boolean)} but 'raw' in that it can do more than one Region
073   * at a time -- good if many Regions to offline -- and it will schedule the assigns even in the
074   * case where Master is initializing (as long as the ProcedureExecutor is up). Does NOT call
075   * Coprocessor hooks.
076   * @param override You need to add the override for case where a region has previously been
077   *              bypassed. When a Procedure has been bypassed, a Procedure will have completed
078   *              but no other Procedure will be able to make progress on the target entity
079   *              (intentionally). This override flag will override this fencing mechanism.
080   * @param encodedRegionNames Region encoded names; e.g. 1588230740 is the hard-coded encoding
081   *                           for hbase:meta region and de00010733901a05f5a2a3a382e27dd4 is an
082   *                           example of what a random user-space encoded Region name looks like.
083   */
084  List<Long> unassigns(List<String> encodedRegionNames, boolean override) throws IOException;
085
086  default List<Long> unassigns(List<String> encodedRegionNames) throws IOException {
087    return unassigns(encodedRegionNames, false);
088  }
089
090  /**
091   * Bypass specified procedure and move it to completion. Procedure is marked completed but
092   * no actual work is done from the current state/step onwards. Parents of the procedure are
093   * also marked for bypass.
094   *
095   * @param pids of procedures to complete.
096   * @param waitTime wait time in ms for acquiring lock for a procedure
097   * @param override if override set to true, we will bypass the procedure even if it is executing.
098   *   This is for procedures which can't break out during execution (bugs?).
099   * @param recursive If set, if a parent procedure, we will find and bypass children and then
100   *   the parent procedure (Dangerous but useful in case where child procedure has been 'lost').
101   *   Does not always work. Experimental.
102   * @return true if procedure is marked for bypass successfully, false otherwise
103   */
104  List<Boolean> bypassProcedure(List<Long> pids, long waitTime, boolean override, boolean recursive)
105      throws IOException;
106
107  List<Long> scheduleServerCrashProcedure(List<HBaseProtos.ServerName> serverNames)
108      throws IOException;
109
110  /**
111   * Request HBCK chore to run at master side.
112   *
113   * @return <code>true</code> if HBCK chore ran, <code>false</code> if HBCK chore already running
114   * @throws IOException if a remote or network exception occurs
115   */
116  boolean runHbckChore() throws IOException;
117
118  /**
119   * Fix Meta.
120   */
121  void fixMeta() throws IOException;
122}