SnapshotReferenceUtil (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.snapshot.SnapshotReferenceUtil

@InterfaceAudience.Private
public final class SnapshotReferenceUtil
extends Object

Utility methods for interacting with the snapshot referenced files.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SnapshotReferenceUtil.SnapshotVisitor

static interface SnapshotReferenceUtil.StoreFileVisitor

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SnapshotReferenceUtil.SnapshotVisitor`
`static interface`	`SnapshotReferenceUtil.StoreFileVisitor`

Field Summary

Fields
Modifier and Type Field and Description

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

Fields
Modifier and Type	Field and Description
`private static org.apache.commons.logging.Log`	`LOG`

Constructor Summary

Constructors
Modifier Constructor and Description

private SnapshotReferenceUtil()

Constructors
Modifier	Constructor and Description
`private`	`SnapshotReferenceUtil()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`concurrentVisitReferencedFiles(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, SnapshotManifest manifest, SnapshotReferenceUtil.StoreFileVisitor visitor)`
`static Set<String>`	`getHFileNames(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir)` Returns the store file names in the snapshot.
`private static Set<String>`	`getHFileNames(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshotDesc)` Returns the store file names in the snapshot.
`static org.apache.hadoop.fs.Path`	`getLogsDir(org.apache.hadoop.fs.Path snapshotDir, String serverName)` Get log directory for a server in a snapshot.
`static Set<String>`	`getWALNames(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir)` Returns the log file names available in the snapshot.
`static void`	`verifySnapshot(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshotDesc)` Verify the validity of the snapshot
`static void`	`verifySnapshot(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, SnapshotManifest manifest)` Verify the validity of the snapshot
`private static void`	`verifyStoreFile(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot, HRegionInfo regionInfo, String family, org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile storeFile)` Verify the validity of the snapshot store file
`static void`	`visitLogFiles(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, FSVisitor.LogFileVisitor visitor)` Iterate over the snapshot log files
`static void`	`visitReferencedFiles(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription desc, SnapshotReferenceUtil.SnapshotVisitor visitor)` Iterate over the snapshot store files, restored.edits and logs
`static void`	`visitReferencedFiles(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, SnapshotReferenceUtil.SnapshotVisitor visitor)` Iterate over the snapshot store files, restored.edits and logs
`(package private) static void`	`visitRegionStoreFiles(org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest manifest, SnapshotReferenceUtil.StoreFileVisitor visitor)` Iterate over the snapshot store files in the specified region
`(package private) static void`	`visitTableStoreFiles(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path snapshotDir, org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription desc, SnapshotReferenceUtil.StoreFileVisitor visitor)` © Iterate over the snapshot store files

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

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

Constructor Detail
- SnapshotReferenceUtil
```
private SnapshotReferenceUtil()
```

Method Detail

getLogsDir
```
public static org.apache.hadoop.fs.Path getLogsDir(org.apache.hadoop.fs.Path snapshotDir,
                                   String serverName)
```
Get log directory for a server in a snapshot.

Parameters:
snapshotDir - directory where the specific snapshot is stored
serverName - name of the parent regionserver for the log files

Returns:
path to the log home directory for the archive files.

visitReferencedFiles

public static void visitReferencedFiles(org.apache.hadoop.conf.Configuration conf,
                        org.apache.hadoop.fs.FileSystem fs,
                        org.apache.hadoop.fs.Path snapshotDir,
                        SnapshotReferenceUtil.SnapshotVisitor visitor)
                                 throws IOException

Iterate over the snapshot store files, restored.edits and logs

Parameters:: conf - The current Configuration instance.; fs - FileSystem; snapshotDir - Path to the Snapshot directory; visitor - callback object to get the referenced files
Throws:: IOException - if an error occurred while scanning the directory

visitReferencedFiles

public static void visitReferencedFiles(org.apache.hadoop.conf.Configuration conf,
                        org.apache.hadoop.fs.FileSystem fs,
                        org.apache.hadoop.fs.Path snapshotDir,
                        org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription desc,
                        SnapshotReferenceUtil.SnapshotVisitor visitor)
                                 throws IOException

Iterate over the snapshot store files, restored.edits and logs

Parameters:: conf - The current Configuration instance.; fs - FileSystem; snapshotDir - Path to the Snapshot directory; desc - the HBaseProtos.SnapshotDescription of the snapshot to verify; visitor - callback object to get the referenced files
Throws:: IOException - if an error occurred while scanning the directory

visitTableStoreFiles

static void visitTableStoreFiles(org.apache.hadoop.conf.Configuration conf,
                        org.apache.hadoop.fs.FileSystem fs,
                        org.apache.hadoop.fs.Path snapshotDir,
                        org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription desc,
                        SnapshotReferenceUtil.StoreFileVisitor visitor)
                          throws IOException

Parameters:: conf - The current Configuration instance.; fs - FileSystem; snapshotDir - Path to the Snapshot directory; desc - the HBaseProtos.SnapshotDescription of the snapshot to verify; visitor - callback object to get the store files
Throws:: IOException - if an error occurred while scanning the directory

visitRegionStoreFiles

static void visitRegionStoreFiles(org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest manifest,
                         SnapshotReferenceUtil.StoreFileVisitor visitor)
                           throws IOException

Iterate over the snapshot store files in the specified region

Parameters:: manifest - snapshot manifest to inspect; visitor - callback object to get the store files
Throws:: IOException - if an error occurred while scanning the directory

visitLogFiles

public static void visitLogFiles(org.apache.hadoop.fs.FileSystem fs,
                 org.apache.hadoop.fs.Path snapshotDir,
                 FSVisitor.LogFileVisitor visitor)
                          throws IOException

Iterate over the snapshot log files

Parameters:: fs - FileSystem; snapshotDir - Path to the Snapshot directory; visitor - callback object to get the log files
Throws:: IOException - if an error occurred while scanning the directory

verifySnapshot
```
public static void verifySnapshot(org.apache.hadoop.conf.Configuration conf,
                  org.apache.hadoop.fs.FileSystem fs,
                  org.apache.hadoop.fs.Path snapshotDir,
                  org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshotDesc)
                           throws IOException
```
Verify the validity of the snapshot

Parameters:
conf - The current Configuration instance.
fs - FileSystem
snapshotDir - Path to the Snapshot directory of the snapshot to verify
snapshotDesc - the HBaseProtos.SnapshotDescription of the snapshot to verify

Throws:

CorruptedSnapshotException - if the snapshot is corrupted

IOException - if an error occurred while scanning the directory

verifySnapshot
```
public static void verifySnapshot(org.apache.hadoop.conf.Configuration conf,
                  org.apache.hadoop.fs.FileSystem fs,
                  SnapshotManifest manifest)
                           throws IOException
```
Verify the validity of the snapshot

Parameters:
conf - The current Configuration instance.
fs - FileSystem
manifest - snapshot manifest to inspect

Throws:

CorruptedSnapshotException - if the snapshot is corrupted

IOException - if an error occurred while scanning the directory

concurrentVisitReferencedFiles

public static void concurrentVisitReferencedFiles(org.apache.hadoop.conf.Configuration conf,
                                  org.apache.hadoop.fs.FileSystem fs,
                                  SnapshotManifest manifest,
                                  SnapshotReferenceUtil.StoreFileVisitor visitor)
                                           throws IOException

Throws:: IOException

verifyStoreFile

private static void verifyStoreFile(org.apache.hadoop.conf.Configuration conf,
                   org.apache.hadoop.fs.FileSystem fs,
                   org.apache.hadoop.fs.Path snapshotDir,
                   org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot,
                   HRegionInfo regionInfo,
                   String family,
                   org.apache.hadoop.hbase.protobuf.generated.SnapshotProtos.SnapshotRegionManifest.StoreFile storeFile)
                             throws IOException

Verify the validity of the snapshot store file

Parameters:: conf - The current Configuration instance.; fs - FileSystem; snapshotDir - Path to the Snapshot directory of the snapshot to verify; snapshot - the HBaseProtos.SnapshotDescription of the snapshot to verify; regionInfo - HRegionInfo of the region that contains the store file; family - family that contains the store file; storeFile - the store file to verify
Throws:: CorruptedSnapshotException - if the snapshot is corrupted; IOException - if an error occurred while scanning the directory

getHFileNames
```
public static Set<String> getHFileNames(org.apache.hadoop.conf.Configuration conf,
                        org.apache.hadoop.fs.FileSystem fs,
                        org.apache.hadoop.fs.Path snapshotDir)
                                 throws IOException
```
Returns the store file names in the snapshot.

Parameters:
conf - The current Configuration instance.
fs - FileSystem
snapshotDir - Path to the Snapshot directory

Returns:
the names of hfiles in the specified snaphot

Throws:

IOException - if an error occurred while scanning the directory

getHFileNames

private static Set<String> getHFileNames(org.apache.hadoop.conf.Configuration conf,
                        org.apache.hadoop.fs.FileSystem fs,
                        org.apache.hadoop.fs.Path snapshotDir,
                        org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshotDesc)
                                  throws IOException

Returns the store file names in the snapshot.

Parameters:: conf - The current Configuration instance.; fs - FileSystem; snapshotDir - Path to the Snapshot directory; snapshotDesc - the HBaseProtos.SnapshotDescription of the snapshot to inspect
Returns:: the names of hfiles in the specified snaphot
Throws:: IOException - if an error occurred while scanning the directory

getWALNames
```
public static Set<String> getWALNames(org.apache.hadoop.fs.FileSystem fs,
                      org.apache.hadoop.fs.Path snapshotDir)
                               throws IOException
```
Returns the log file names available in the snapshot.

Parameters:
fs - FileSystem
snapshotDir - Path to the Snapshot directory

Returns:
the names of wals in the specified snaphot

Throws:

IOException - if an error occurred while scanning the directory

Class SnapshotReferenceUtil

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

Constructor Detail

SnapshotReferenceUtil

Method Detail

getLogsDir

visitReferencedFiles

visitReferencedFiles

visitTableStoreFiles

visitRegionStoreFiles

visitLogFiles

verifySnapshot

verifySnapshot

concurrentVisitReferencedFiles

verifyStoreFile

getHFileNames

getHFileNames

getWALNames