Field Detail

• HBASE_SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLIS

  public static final String HBASE_SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLIS

  Wait time before removing a finished sentinel from the in-progress map NOTE: This is used as a safety auto cleanup. The snapshot and restore handlers map entries are removed when a user asks if a snapshot or restore is completed. This operation is part of the HBaseAdmin snapshot/restore API flow. In case something fails on the client side and the snapshot/restore state is not reclaimed after a default timeout, the entry is removed from the in-progress map. At this point, if the user asks for the snapshot/restore status, the result will be snapshot done if exists or failed if it doesn't exists.

  See Also:

  Constant Field Values

• SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLS_DEFAULT

  public static final long SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLS_DEFAULT

  See Also:

  Constant Field Values

• HBASE_SNAPSHOT_ENABLED

  public static final String HBASE_SNAPSHOT_ENABLED

  Enable or disable snapshot support

  See Also:

  Constant Field Values

• ONLINE_SNAPSHOT_CONTROLLER_DESCRIPTION

  public static final String ONLINE_SNAPSHOT_CONTROLLER_DESCRIPTION

  Name of the operation to use in the controller

  See Also:

  Constant Field Values

• SNAPSHOT_POOL_THREADS_KEY

  public static final String SNAPSHOT_POOL_THREADS_KEY

  Conf key for # of threads used by the SnapshotManager thread pool

  See Also:

  Constant Field Values

• SNAPSHOT_POOL_THREADS_DEFAULT

  public static final int SNAPSHOT_POOL_THREADS_DEFAULT

  number of current operations running on the master

  See Also:

  Constant Field Values

Constructor Detail

• SnapshotManager

  public SnapshotManager()

Method Detail

• getCompletedSnapshots

  public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> getCompletedSnapshots()
                                                                                                         throws IOException

  Gets the list of all completed snapshots.

  Returns:

  list of SnapshotDescriptions

  Throws:

  IOException - File system exception

• deleteSnapshot

  public void deleteSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                      throws IOException

  Delete the specified snapshot

  Parameters:

  snapshot -

  Throws:

  SnapshotDoesNotExistException - If the specified snapshot does not exist.

  IOException - For filesystem IOExceptions

• isSnapshotDone

  public boolean isSnapshotDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription expected)
                         throws IOException

  Check if the specified snapshot is done

  Parameters:

  expected -

  Returns:

  true if snapshot is ready to be restored, false if it is still being taken.

  Throws:

  IOException - IOException if error from HDFS or RPC

  UnknownSnapshotException - if snapshot is invalid or does not exist.

• takeSnapshot

  public void takeSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                    throws IOException

  Take a snapshot based on the enabled/disabled state of the table.

  Parameters:

  snapshot -

  Throws:

  HBaseSnapshotException - when a snapshot specific exception occurs.

  IOException - when some sort of generic IO exception occurs.

• getTakingSnapshotLock

  public ReadWriteLock getTakingSnapshotLock()

• isTakingAnySnapshot

  public boolean isTakingAnySnapshot()

  The snapshot operation processing as following:
  1. Create a Snapshot Handler, and do some initialization;
  2. Put the handler into snapshotHandlers
  So when we consider if any snapshot is taking, we should consider both the takingSnapshotLock and snapshotHandlers;

  Returns:

  true to indicate that there're some running snapshots.

• setSnapshotHandlerForTesting

  public void setSnapshotHandlerForTesting(TableName tableName,
                                  SnapshotSentinel handler)

  Set the handler for the current snapshot

  Exposed for TESTING

  Parameters:

  tableName -

  handler - handler the master should use TODO get rid of this if possible, repackaging, modify tests.

• restoreSnapshot

  @Deprecated
  public void restoreSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription reqSnapshot)
                       throws IOException

  Deprecated. 
  Restore the specified snapshot

  Parameters:

  reqSnapshot - the snapshot to restore

  Throws:

  IOException

• restoreSnapshot

  public void restoreSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription reqSnapshot,
                     boolean restoreAcl)
                       throws IOException

  Restore the specified snapshot

  Parameters:

  reqSnapshot - the snapshot to restore

  restoreAcl - whether or not to restore ACLs on the snapshot

  Throws:

  IOException

• isRestoreDone

  public boolean isRestoreDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                        throws IOException

  Returns the status of a restore operation. If the in-progress restore is failed throws the exception that caused the failure.

  Parameters:

  snapshot -

  Returns:

  false if in progress, true if restore is completed or not requested.

  Throws:

  IOException - if there was a failure during the restore

• stop

  public void stop(String why)

  Description copied from interface: Stoppable
  Stop this service. Implementers should favor logging errors over throwing RuntimeExceptions.

  Specified by:

  stop in interface Stoppable

  Parameters:

  why - Why we're stopping.

• isStopped

  public boolean isStopped()

  Specified by:

  isStopped in interface Stoppable

  Returns:

  True if Stoppable.stop(String) has been closed.

• checkSnapshotSupport

  public void checkSnapshotSupport()
                            throws UnsupportedOperationException

  Throws an exception if snapshot operations (take a snapshot, restore, clone) are not supported. Called at the beginning of snapshot() and restoreSnapshot() methods.

  Throws:

  UnsupportedOperationException - if snapshot are not supported

• initialize

  public void initialize(MasterServices master,
                MetricsMaster metricsMaster)
                  throws org.apache.zookeeper.KeeperException,
                         IOException,
                         UnsupportedOperationException

  Description copied from class: MasterProcedureManager
  Initialize a globally barriered procedure for master.

  Specified by:

  initialize in class MasterProcedureManager

  Parameters:

  master - Master service interface

  Throws:

  org.apache.zookeeper.KeeperException

  IOException

  UnsupportedOperationException

• getProcedureSignature

  public String getProcedureSignature()

  Description copied from class: ProcedureManager
  Return the unique signature of the procedure. This signature uniquely identifies the procedure. By default, this signature is the string used in the procedure controller (i.e., the root ZK node name for the procedure)

  Specified by:

  getProcedureSignature in class ProcedureManager

• execProcedure

  public void execProcedure(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ProcedureDescription desc)
                     throws IOException

  Description copied from class: MasterProcedureManager
  Execute a distributed procedure on cluster

  Overrides:

  execProcedure in class MasterProcedureManager

  Parameters:

  desc - Procedure description

  Throws:

  IOException

• isProcedureDone

  public boolean isProcedureDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ProcedureDescription desc)
                          throws IOException

  Description copied from class: MasterProcedureManager
  Check if the procedure is finished successfully

  Specified by:

  isProcedureDone in class MasterProcedureManager

  Parameters:

  desc - Procedure description

  Returns:

  true if the specified procedure is finished successfully

  Throws:

  IOException