Package org.apache.hadoop.hbase.backup.util

Class BackupFileSystemManager

java.lang.Object

org.apache.hadoop.hbase.backup.util.BackupFileSystemManager

@Private
public class BackupFileSystemManager
extends Object

Initializes and organizes backup directories for continuous Write-Ahead Logs (WALs) and bulk-loaded files within the specified backup root directory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BackupFileSystemManager.WalPathInfo

Field Summary

Fields

Modifier and Type	Field	Description
private final org.apache.hadoop.fs.FileSystem	backupFs
private final org.apache.hadoop.fs.Path	backupRootDir
static final String	BULKLOAD_FILES_DIR
private final org.apache.hadoop.fs.Path	bulkLoadFilesDir
private static final org.slf4j.Logger	LOG
private final String	peerId
static final String	WALS_DIR
private final org.apache.hadoop.fs.Path	walsDir

Constructor Summary

Constructors

Constructor	Description
BackupFileSystemManager(String peerId, org.apache.hadoop.conf.Configuration conf, String backupRootDirStr)

Method Summary

Modifier and Type	Method	Description
private org.apache.hadoop.fs.Path	createDirectory(String dirName)
static BackupFileSystemManager.WalPathInfo	extractWalPathInfo(org.apache.hadoop.fs.Path walPath)	Validate the walPath has the expected structure: .../WALs//<wal-file> and return WalPathInfo(prefixBeforeWALs, dateSegment).
org.apache.hadoop.fs.FileSystem	getBackupFs()
org.apache.hadoop.fs.Path	getBulkLoadFilesDir()
org.apache.hadoop.fs.Path	getWalsDir()
static org.apache.hadoop.fs.Path	resolveBulkLoadFullPath(org.apache.hadoop.fs.Path walPath, org.apache.hadoop.fs.Path relativeBulkPath)	Resolve the full bulk-load file path corresponding to a relative bulk-load path referenced from a WAL file path.

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

WALS_DIR

public static final String WALS_DIR

See Also:

• Constant Field Values

BULKLOAD_FILES_DIR

public static final String BULKLOAD_FILES_DIR

See Also:

• Constant Field Values

peerId

private final String peerId

backupFs

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

backupRootDir

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

walsDir

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

bulkLoadFilesDir

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

Constructor Details

BackupFileSystemManager

public BackupFileSystemManager(String peerId,
 org.apache.hadoop.conf.Configuration conf,
 String backupRootDirStr)
                        throws IOException

Throws:

IOException

Method Details

createDirectory

private org.apache.hadoop.fs.Path createDirectory(String dirName)
                                           throws IOException

Throws:

IOException

getWalsDir

public org.apache.hadoop.fs.Path getWalsDir()

getBulkLoadFilesDir

public org.apache.hadoop.fs.Path getBulkLoadFilesDir()

getBackupFs

public org.apache.hadoop.fs.FileSystem getBackupFs()

extractWalPathInfo

public static BackupFileSystemManager.WalPathInfo extractWalPathInfo(org.apache.hadoop.fs.Path walPath)
                                                              throws IOException

Validate the walPath has the expected structure: .../WALs//<wal-file> and return WalPathInfo(prefixBeforeWALs, dateSegment).

Throws:

IOException - if the path is not in expected format

resolveBulkLoadFullPath

public static org.apache.hadoop.fs.Path resolveBulkLoadFullPath(org.apache.hadoop.fs.Path walPath,
 org.apache.hadoop.fs.Path relativeBulkPath)
                                                         throws IOException

Resolve the full bulk-load file path corresponding to a relative bulk-load path referenced from a WAL file path. For a WAL path like: /some/prefix/.../WALs/23-08-2025/some-wal-file and a relative bulk path like: namespace/table/region/family/file, this returns: /some/prefix/.../bulk-load-files/23-08-2025/namespace/table/region/family/file

Parameters:

walPath - the Path to the WAL file (must contain the WALS_DIR segment followed by date)

relativeBulkPath - the relative bulk-load file Path

Returns:

resolved full Path for the bulk-load file

Throws:

IOException - if the WAL path does not contain the expected segments