org.apache.hadoop.hbase.wal

类 DefaultWALProvider

java.lang.Object

org.apache.hadoop.hbase.wal.DefaultWALProvider

所有已实现的接口:

WALProvider

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class DefaultWALProvider
extends Object
implements WALProvider

A WAL Provider that returns a single thread safe WAL that writes to Hadoop FS. By default, this implementation picks a directory in Hadoop FS based on a combination of

• the HBase root WAL directory
• HConstants.HREGION_LOGDIR_NAME
• the given factory's factoryId (usually identifying the regionserver by host:port)

It also uses the providerId to diffentiate among files.

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	DefaultWALProvider.Reader
static interface	DefaultWALProvider.Writer

字段概要

字段

限定符和类型	字段和说明
protected FSHLog	log
static String	META_WAL_PROVIDER_ID The hbase:meta region's WAL filename extension
static String	SPLITTING_EXT File Extension used while splitting an WAL into regions (HBASE-2312)
static String	WAL_FILE_NAME_DELIMITER

构造器概要

构造器

构造器和说明
DefaultWALProvider()

方法概要

方法

限定符和类型	方法和说明
void	close() shutdown utstanding WALs and clean up any persisted state.
static DefaultWALProvider.Writer	createWriter(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, boolean overwritable) public because of FSHLog.
static long	extractFileNumFromWAL(WAL wal) It returns the file create timestamp from the file name.
static org.apache.hadoop.fs.Path	getCurrentFileName(WAL wal) return the current filename from the current wal.
long	getLogFileSize() iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the size of files (rolled and active). if either of them aren't, count 0 for that provider.
long	getNumLogFiles() iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the number of files (rolled and active). if either of them aren't, count 0 for that provider.
static int	getNumRolledLogFiles(WAL wal) returns the number of rolled WAL files.
static ServerName	getServerNameFromWALDirectoryName(org.apache.hadoop.conf.Configuration conf, String path) Pulls a ServerName out of a Path generated according to our layout rules.
static ServerName	getServerNameFromWALDirectoryName(org.apache.hadoop.fs.Path logFile) This function returns region server name from a log file name which is in one of the following formats: hdfs://<name node>/hbase/.logs/<server name>-splitting/...
WAL	getWAL(byte[] identifier, byte[] namespace)
static org.apache.hadoop.fs.Path	getWALArchivePath(org.apache.hadoop.fs.Path archiveDir, org.apache.hadoop.fs.Path p)
static String	getWALDirectoryName(String serverName) Construct the directory name for all WALs on a given server.
static String	getWALPrefixFromWALName(String name) Get prefix of the log from its name, assuming WAL name in format of log_prefix.filenumber.log_suffix @see FSHLog.getCurrentFileName()
List<WAL>	getWALs()
void	init(WALFactory factory, org.apache.hadoop.conf.Configuration conf, List<WALActionsListener> listeners, String providerId) Set up the provider to create wals.
static boolean	isMetaFile(org.apache.hadoop.fs.Path p)
static boolean	isMetaFile(String p)
void	shutdown() persist outstanding WALs to storage and stop accepting new appends.
static boolean	validateWALFilename(String filename) A WAL file name is of the format: <wal-name>WAL_FILE_NAME_DELIMITER<file-creation-timestamp>[.meta].

从类继承的方法 java.lang.Object

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

字段详细资料

log

protected volatile FSHLog log

WAL_FILE_NAME_DELIMITER

public static final String WAL_FILE_NAME_DELIMITER

另请参阅:

常量字段值

META_WAL_PROVIDER_ID

public static final String META_WAL_PROVIDER_ID

The hbase:meta region's WAL filename extension

另请参阅:

常量字段值

SPLITTING_EXT

public static final String SPLITTING_EXT

File Extension used while splitting an WAL into regions (HBASE-2312)

另请参阅:

常量字段值

构造器详细资料

DefaultWALProvider

public DefaultWALProvider()

方法详细资料

init

public void init(WALFactory factory,
        org.apache.hadoop.conf.Configuration conf,
        List<WALActionsListener> listeners,
        String providerId)
          throws IOException

从接口复制的说明: WALProvider

Set up the provider to create wals. will only be called once per instance.

指定者:

init 在接口中 WALProvider

参数:

factory - factory that made us, identity used for FS layout. may not be null

conf - may not be null

listeners - may be null

providerId - differentiate between providers from one facotry, used for FS layout. may be null

抛出:

IOException

getWALs

public List<WAL> getWALs()
                  throws IOException

指定者:

getWALs 在接口中 WALProvider

返回:

the List of WALs that are used by this server

抛出:

IOException

getWAL

public WAL getWAL(byte[] identifier,
         byte[] namespace)
           throws IOException

指定者:

getWAL 在接口中 WALProvider

参数:

identifier - may not be null. contents will not be altered.

namespace - could be null, and will use default namespace if null

返回:

a WAL for writing entries for the given region.

抛出:

IOException

close

public void close()
           throws IOException

从接口复制的说明: WALProvider

shutdown utstanding WALs and clean up any persisted state. Call this method only when you will not need to replay any of the edits to the WALs from this provider. After this call completes, the underlying resources should have been reclaimed.

指定者:

close 在接口中 WALProvider

抛出:

IOException

shutdown

public void shutdown()
              throws IOException

从接口复制的说明: WALProvider

persist outstanding WALs to storage and stop accepting new appends. This method serves as shorthand for sending a sync to every WAL provided by a given implementation. Those WALs will also stop accepting new writes.

指定者:

shutdown 在接口中 WALProvider

抛出:

IOException

getNumLogFiles

public long getNumLogFiles()

iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the number of files (rolled and active). if either of them aren't, count 0 for that provider.

指定者:

getNumLogFiles 在接口中 WALProvider

getLogFileSize

public long getLogFileSize()

iff the given WALFactory is using the DefaultWALProvider for meta and/or non-meta, count the size of files (rolled and active). if either of them aren't, count 0 for that provider.

指定者:

getLogFileSize 在接口中 WALProvider

getNumRolledLogFiles

public static int getNumRolledLogFiles(WAL wal)

returns the number of rolled WAL files.

getCurrentFileName

public static org.apache.hadoop.fs.Path getCurrentFileName(WAL wal)

return the current filename from the current wal.

extractFileNumFromWAL

public static long extractFileNumFromWAL(WAL wal)

It returns the file create timestamp from the file name. For name format see validateWALFilename(String) public until remaining tests move to o.a.h.h.wal

参数:

wal - must not be null

返回:

the file number that is part of the WAL file name

validateWALFilename

public static boolean validateWALFilename(String filename)

A WAL file name is of the format: <wal-name>WAL_FILE_NAME_DELIMITER<file-creation-timestamp>[.meta]. provider-name is usually made up of a server-name and a provider-id

参数:

filename - name of the file to validate

返回:

true if the filename matches an WAL, false otherwise

getWALDirectoryName

public static String getWALDirectoryName(String serverName)

Construct the directory name for all WALs on a given server.

参数:

serverName - Server name formatted as described in ServerName

返回:

the relative WAL directory name, e.g. .logs/1.example.org,60030,12345 if serverName passed is 1.example.org,60030,12345

getServerNameFromWALDirectoryName

public static ServerName getServerNameFromWALDirectoryName(org.apache.hadoop.conf.Configuration conf,
                                           String path)
                                                    throws IOException

Pulls a ServerName out of a Path generated according to our layout rules. In the below layouts, this method ignores the format of the logfile component. Current format: [base directory for hbase]/hbase/.logs/ServerName/logfile or [base directory for hbase]/hbase/.logs/ServerName-splitting/logfile Expected to work for individual log files and server-specific directories.

返回:

null if it's not a log file. Returns the ServerName of the region server that created this log file otherwise.

抛出:

IOException

getServerNameFromWALDirectoryName

public static ServerName getServerNameFromWALDirectoryName(org.apache.hadoop.fs.Path logFile)

This function returns region server name from a log file name which is in one of the following formats:

• hdfs://<name node>/hbase/.logs/<server name>-splitting/...
• hdfs://<name node>/hbase/.logs/<server name>/...

参数:

logFile -

返回:

null if the passed in logFile isn't a valid WAL file path

isMetaFile

public static boolean isMetaFile(org.apache.hadoop.fs.Path p)

isMetaFile

public static boolean isMetaFile(String p)

createWriter

public static DefaultWALProvider.Writer createWriter(org.apache.hadoop.conf.Configuration conf,
                                     org.apache.hadoop.fs.FileSystem fs,
                                     org.apache.hadoop.fs.Path path,
                                     boolean overwritable)
                                              throws IOException

public because of FSHLog. Should be package-private

抛出:

IOException

getWALPrefixFromWALName

public static String getWALPrefixFromWALName(String name)

Get prefix of the log from its name, assuming WAL name in format of log_prefix.filenumber.log_suffix @see FSHLog.getCurrentFileName()

参数:

name - Name of the WAL to parse

返回:

prefix of the log

getWALArchivePath

public static org.apache.hadoop.fs.Path getWALArchivePath(org.apache.hadoop.fs.Path archiveDir,
                                          org.apache.hadoop.fs.Path p)