org.apache.hadoop.hbase.wal

Class WALSplitUtil

java.lang.Object

org.apache.hadoop.hbase.wal.WALSplitUtil

@InterfaceAudience.Private
public final class WALSplitUtil
extends Object

This class provides static methods to support WAL splitting related works

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WALSplitUtil.MutationReplay A struct used by getMutationsFromWALEntry

Method Summary

Modifier and Type	Method and Description
static void	finishSplitLogFile(String logfile, org.apache.hadoop.conf.Configuration conf) Completes the work done by splitLogFile by archiving logs
static long	getMaxRegionSequenceId(org.apache.hadoop.conf.Configuration conf, RegionInfo region, ConcurrentMapUtils.IOExceptionSupplier<org.apache.hadoop.fs.FileSystem> rootFsSupplier, ConcurrentMapUtils.IOExceptionSupplier<org.apache.hadoop.fs.FileSystem> walFsSupplier) Deprecated. Only for compatibility, will be removed in 4.0.0.
static long	getMaxRegionSequenceId(org.apache.hadoop.fs.FileSystem walFS, org.apache.hadoop.fs.Path regionDir) Get the max sequence id which is stored in the region directory.
static List<WALSplitUtil.MutationReplay>	getMutationsFromWALEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.WALEntry entry, CellScanner cells, Pair<WALKey,WALEdit> logEntry, Durability durability) This function is used to construct mutations from a WALEntry.
static org.apache.hadoop.fs.FileStatus[]	getRecoveredHFiles(org.apache.hadoop.fs.FileSystem rootFS, org.apache.hadoop.fs.Path regionDir, String familyName)
static org.apache.hadoop.fs.Path	getRegionDirRecoveredEditsDir(org.apache.hadoop.fs.Path regionDir)
static NavigableSet<org.apache.hadoop.fs.Path>	getSplitEditFilesSorted(org.apache.hadoop.fs.FileSystem walFS, org.apache.hadoop.fs.Path regionDir) Returns sorted set of edit files made by splitter, excluding files with '.temp' suffix.
static boolean	hasRecoveredEdits(org.apache.hadoop.conf.Configuration conf, RegionInfo regionInfo) Check whether there is recovered.edits in the region dir
static boolean	isSequenceIdFile(org.apache.hadoop.fs.Path file) Is the given file a region open sequence id file.
static org.apache.hadoop.fs.Path	moveAsideBadEditsFile(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path edits) Move aside a bad edits file.
static void	moveWAL(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path p, org.apache.hadoop.fs.Path targetDir) Move WAL.
static void	writeRegionSequenceIdFile(org.apache.hadoop.fs.FileSystem walFS, org.apache.hadoop.fs.Path regionDir, long newMaxSeqId) Create a file with name as region's max sequence id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finishSplitLogFile

public static void finishSplitLogFile(String logfile,
                                      org.apache.hadoop.conf.Configuration conf)
                               throws IOException

Completes the work done by splitLogFile by archiving logs

It is invoked by SplitLogManager once it knows that one of the SplitLogWorkers have completed the splitLogFile() part. If the master crashes then this function might get called multiple times.

Throws:

IOException

moveWAL

public static void moveWAL(org.apache.hadoop.fs.FileSystem fs,
                           org.apache.hadoop.fs.Path p,
                           org.apache.hadoop.fs.Path targetDir)
                    throws IOException

Move WAL. Used to move processed WALs to archive or bad WALs to corrupt WAL dir. WAL may have already been moved; makes allowance.

Throws:

IOException

getRegionDirRecoveredEditsDir

public static org.apache.hadoop.fs.Path getRegionDirRecoveredEditsDir(org.apache.hadoop.fs.Path regionDir)

Parameters:

regionDir - This regions directory in the filesystem.

Returns:

The directory that holds recovered edits files for the region regionDir

hasRecoveredEdits

public static boolean hasRecoveredEdits(org.apache.hadoop.conf.Configuration conf,
                                        RegionInfo regionInfo)
                                 throws IOException

Check whether there is recovered.edits in the region dir

Parameters:

conf - conf

regionInfo - the region to check

Returns:

true if recovered.edits exist in the region dir

Throws:

IOException

getMaxRegionSequenceId

@Deprecated
public static long getMaxRegionSequenceId(org.apache.hadoop.conf.Configuration conf,
                                                      RegionInfo region,
                                                      ConcurrentMapUtils.IOExceptionSupplier<org.apache.hadoop.fs.FileSystem> rootFsSupplier,
                                                      ConcurrentMapUtils.IOExceptionSupplier<org.apache.hadoop.fs.FileSystem> walFsSupplier)
                                               throws IOException

Deprecated. Only for compatibility, will be removed in 4.0.0.

This method will check 3 places for finding the max sequence id file. One is the expected place, another is the old place under the region directory, and the last one is the wrong one we introduced in HBASE-20734. See HBASE-22617 for more details.

Notice that, you should always call this method instead of getMaxRegionSequenceId(FileSystem, Path) until 4.0.0 release.

Throws:

IOException

getSplitEditFilesSorted

public static NavigableSet<org.apache.hadoop.fs.Path> getSplitEditFilesSorted(org.apache.hadoop.fs.FileSystem walFS,
                                                                              org.apache.hadoop.fs.Path regionDir)
                                                                       throws IOException

Returns sorted set of edit files made by splitter, excluding files with '.temp' suffix.

Parameters:

walFS - WAL FileSystem used to retrieving split edits files.

regionDir - WAL region dir to look for recovered edits files under.

Returns:

Files in passed regionDir as a sorted set.

Throws:

IOException

moveAsideBadEditsFile

public static org.apache.hadoop.fs.Path moveAsideBadEditsFile(org.apache.hadoop.fs.FileSystem fs,
                                                              org.apache.hadoop.fs.Path edits)
                                                       throws IOException

Move aside a bad edits file.

Parameters:

fs - the file system used to rename bad edits file.

edits - Edits file to move aside.

Returns:

The name of the moved aside file.

Throws:

IOException

isSequenceIdFile

public static boolean isSequenceIdFile(org.apache.hadoop.fs.Path file)

Is the given file a region open sequence id file.

getMaxRegionSequenceId

public static long getMaxRegionSequenceId(org.apache.hadoop.fs.FileSystem walFS,
                                          org.apache.hadoop.fs.Path regionDir)
                                   throws IOException

Get the max sequence id which is stored in the region directory. -1 if none.

Throws:

IOException

writeRegionSequenceIdFile

public static void writeRegionSequenceIdFile(org.apache.hadoop.fs.FileSystem walFS,
                                             org.apache.hadoop.fs.Path regionDir,
                                             long newMaxSeqId)
                                      throws IOException

Create a file with name as region's max sequence id

Throws:

IOException

getMutationsFromWALEntry

public static List<WALSplitUtil.MutationReplay> getMutationsFromWALEntry(org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.WALEntry entry,
                                                                         CellScanner cells,
                                                                         Pair<WALKey,WALEdit> logEntry,
                                                                         Durability durability)
                                                                  throws IOException

This function is used to construct mutations from a WALEntry. It also reconstructs WALKey & WALEdit from the passed in WALEntry

Parameters:

logEntry - pair of WALKey and WALEdit instance stores WALKey and WALEdit instances extracted from the passed in WALEntry.

Returns:

list of Pair<MutationType, Mutation> to be replayed

Throws:

IOException

getRecoveredHFiles

public static org.apache.hadoop.fs.FileStatus[] getRecoveredHFiles(org.apache.hadoop.fs.FileSystem rootFS,
                                                                   org.apache.hadoop.fs.Path regionDir,
                                                                   String familyName)
                                                            throws IOException

Throws:

IOException