Field Detail

• LOG

  private static final org.apache.commons.logging.Log LOG

• regionsMap

  private final Map<byte[],byte[]> regionsMap

• parentsMap

  private final Map<String,Pair<String,String>> parentsMap

• monitor

  private final ForeignExceptionDispatcher monitor

• status

  private final MonitoredTask status

• snapshotManifest

  private final SnapshotManifest snapshotManifest

• snapshotDesc

  private final org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshotDesc

• snapshotTable

  private final TableName snapshotTable

• tableDesc

  private final HTableDescriptor tableDesc

• rootDir

  private final org.apache.hadoop.fs.Path rootDir

• tableDir

  private final org.apache.hadoop.fs.Path tableDir

• conf

  private final org.apache.hadoop.conf.Configuration conf

• fs

  private final org.apache.hadoop.fs.FileSystem fs

• createBackRefs

  private final boolean createBackRefs

Constructor Detail

• RestoreSnapshotHelper

  public RestoreSnapshotHelper(org.apache.hadoop.conf.Configuration conf,
                       org.apache.hadoop.fs.FileSystem fs,
                       SnapshotManifest manifest,
                       HTableDescriptor tableDescriptor,
                       org.apache.hadoop.fs.Path rootDir,
                       ForeignExceptionDispatcher monitor,
                       MonitoredTask status)

• RestoreSnapshotHelper

  public RestoreSnapshotHelper(org.apache.hadoop.conf.Configuration conf,
                       org.apache.hadoop.fs.FileSystem fs,
                       SnapshotManifest manifest,
                       HTableDescriptor tableDescriptor,
                       org.apache.hadoop.fs.Path rootDir,
                       ForeignExceptionDispatcher monitor,
                       MonitoredTask status,
                       boolean createBackRefs)

Method Detail

• restoreHdfsRegions

  public RestoreSnapshotHelper.RestoreMetaChanges restoreHdfsRegions()
                                                              throws IOException

  Restore the on-disk table to a specified snapshot state.

  Returns:

  the set of regions touched by the restore operation

  Throws:

  IOException

• restoreHdfsRegions

  private RestoreSnapshotHelper.RestoreMetaChanges restoreHdfsRegions(ThreadPoolExecutor exec)
                                                               throws IOException

  Throws:

  IOException

• removeHdfsRegions

  private void removeHdfsRegions(ThreadPoolExecutor exec,
                       List<HRegionInfo> regions)
                          throws IOException

  Remove specified regions from the file-system, using the archiver.

  Throws:

  IOException

• restoreHdfsRegions

  private void restoreHdfsRegions(ThreadPoolExecutor exec,
                        Map<String,org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest> regionManifests,
                        List<HRegionInfo> regions)
                           throws IOException

  Restore specified regions by restoring content to the snapshot state.

  Throws:

  IOException

• getRegionHFileReferences

  private Map<String,List<org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile>> getRegionHFileReferences(org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest manifest)

• restoreRegion

  private void restoreRegion(HRegionInfo regionInfo,
                   org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest regionManifest)
                      throws IOException

  Restore region by removing files not in the snapshot and adding the missing ones from the snapshot.

  Throws:

  IOException

• getTableRegionFamilyFiles

  private Set<String> getTableRegionFamilyFiles(org.apache.hadoop.fs.Path familyDir)
                                         throws IOException

  Returns:

  The set of files in the specified family directory.

  Throws:

  IOException

• cloneHdfsRegions

  private HRegionInfo[] cloneHdfsRegions(ThreadPoolExecutor exec,
                               Map<String,org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest> regionManifests,
                               List<HRegionInfo> regions)
                                  throws IOException

  Clone specified regions. For each region create a new region and create a HFileLink for each hfile.

  Throws:

  IOException

• cloneRegion

  private void cloneRegion(HRegion region,
                 HRegionInfo snapshotRegionInfo,
                 org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest manifest)
                    throws IOException

  Clone region directory content from the snapshot info. Each region is encoded with the table name, so the cloned region will have a different region name. Instead of copying the hfiles a HFileLink is created.

  Parameters:

  region - HRegion cloned

  snapshotRegionInfo -

  Throws:

  IOException

• restoreStoreFile

  private void restoreStoreFile(org.apache.hadoop.fs.Path familyDir,
                      HRegionInfo regionInfo,
                      org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile storeFile,
                      boolean createBackRef)
                         throws IOException

  Create a new HFileLink to reference the store file.

  The store file in the snapshot can be a simple hfile, an HFileLink or a reference.

  • hfile: abc -> table=region-abc
  • reference: abc.1234 -> table=region-abc.1234
  • hfilelink: table=region-hfile -> table=region-hfile

  Parameters:

  familyDir - destination directory for the store file

  regionInfo - destination region info for the table

  storeFile - store file name (can be a Reference, HFileLink or simple HFile)

  createBackRef - - Whether back reference should be created. Defaults to true.

  Throws:

  IOException

• restoreReferenceFile

  private void restoreReferenceFile(org.apache.hadoop.fs.Path familyDir,
                          HRegionInfo regionInfo,
                          org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile storeFile)
                             throws IOException

  Create a new Reference as copy of the source one.

   The source table looks like:
      1234/abc      (original file)
      5678/abc.1234 (reference file)
  
   After the clone operation looks like:
     wxyz/table=1234-abc
     stuv/table=1234-abc.wxyz
  
   NOTE that the region name in the clone changes (md5 of regioninfo)
   and the reference should reflect that change.
   

  Parameters:

  familyDir - destination directory for the store file

  regionInfo - destination region info for the table

  hfileName - reference file name

  Throws:

  IOException

• cloneRegionInfo

  public HRegionInfo cloneRegionInfo(HRegionInfo snapshotRegionInfo)

  Create a new HRegionInfo from the snapshot region info. Keep the same startKey, endKey, regionId and split information but change the table name.

  Parameters:

  snapshotRegionInfo - Info for region to clone.

  Returns:

  the new HRegion instance

• cloneRegionInfo

  public static HRegionInfo cloneRegionInfo(TableName tableName,
                            HRegionInfo snapshotRegionInfo)

• getTableRegions

  private List<HRegionInfo> getTableRegions()
                                     throws IOException

  Returns:

  the set of the regions contained in the table

  Throws:

  IOException

• copySnapshotForScanner

  public static RestoreSnapshotHelper.RestoreMetaChanges copySnapshotForScanner(org.apache.hadoop.conf.Configuration conf,
                                                                org.apache.hadoop.fs.FileSystem fs,
                                                                org.apache.hadoop.fs.Path rootDir,
                                                                org.apache.hadoop.fs.Path restoreDir,
                                                                String snapshotName)
                                                                         throws IOException

  Copy the snapshot files for a snapshot scanner, discards meta changes.

  Parameters:

  conf -

  fs -

  rootDir -

  restoreDir -

  snapshotName -

  Throws:

  IOException