Package org.apache.hadoop.hbase.regionserver

Class StoreFileWriter.Builder

java.lang.Object

org.apache.hadoop.hbase.regionserver.StoreFileWriter.Builder

Enclosing class:

StoreFileWriter

public static class StoreFileWriter.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private BloomType	bloomType
private final CacheConfig	cacheConf
private Supplier<Collection<HStoreFile>>	compactedFilesSupplier
private CellComparator	comparator
private final org.apache.hadoop.conf.Configuration	conf
private org.apache.hadoop.fs.Path	dir
private InetSocketAddress[]	favoredNodes
private HFileContext	fileContext
private String	fileStoragePolicy
private final org.apache.hadoop.fs.FileSystem	fs
private org.apache.hadoop.fs.Path	historicalFilePath
private boolean	isCompaction
private org.apache.hadoop.fs.Path	liveFilePath
private long	maxKeyCount
private int	maxVersions
private boolean	newVersionBehavior
private boolean	shouldDropCacheBehind
private Consumer<org.apache.hadoop.fs.Path>	writerCreationTracker

Constructor Summary

Constructors

Constructor	Description
Builder(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs)	Creates Builder with cache configuration disabled
Builder(org.apache.hadoop.conf.Configuration conf, CacheConfig cacheConf, org.apache.hadoop.fs.FileSystem fs)

Method Summary

Modifier and Type	Method	Description
StoreFileWriter	build()	Create a store file writer.
StoreFileWriter.Builder	withBloomType(BloomType bloomType)
StoreFileWriter.Builder	withCellComparator(CellComparator comparator)
StoreFileWriter.Builder	withCompactedFilesSupplier(Supplier<Collection<HStoreFile>> compactedFilesSupplier)
StoreFileWriter.Builder	withFavoredNodes(InetSocketAddress[] favoredNodes)
StoreFileWriter.Builder	withFileContext(HFileContext fileContext)
StoreFileWriter.Builder	withFilePath(org.apache.hadoop.fs.Path filePath)	Use either this method or withOutputDir(org.apache.hadoop.fs.Path), but not both.
StoreFileWriter.Builder	withFileStoragePolicy(String fileStoragePolicy)
StoreFileWriter.Builder	withIsCompaction(boolean isCompaction)
StoreFileWriter.Builder	withMaxKeyCount(long maxKeyCount)
StoreFileWriter.Builder	withMaxVersions(int maxVersions)
StoreFileWriter.Builder	withNewVersionBehavior(boolean newVersionBehavior)
StoreFileWriter.Builder	withOutputDir(org.apache.hadoop.fs.Path dir)	Use either this method or withFilePath(org.apache.hadoop.fs.Path), but not both.
StoreFileWriter.Builder	withShouldDropCacheBehind(boolean shouldDropCacheBehind)
StoreFileWriter.Builder	withWriterCreationTracker(Consumer<org.apache.hadoop.fs.Path> writerCreationTracker)

Methods inherited from class java.lang.Object

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

Field Details

conf

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

cacheConf

private final CacheConfig cacheConf

fs

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

bloomType

private BloomType bloomType

maxKeyCount

private long maxKeyCount

dir

private org.apache.hadoop.fs.Path dir

liveFilePath

private org.apache.hadoop.fs.Path liveFilePath

historicalFilePath

private org.apache.hadoop.fs.Path historicalFilePath

favoredNodes

private InetSocketAddress[] favoredNodes

fileContext

private HFileContext fileContext

shouldDropCacheBehind

private boolean shouldDropCacheBehind

compactedFilesSupplier

private Supplier<Collection<HStoreFile>> compactedFilesSupplier

fileStoragePolicy

private String fileStoragePolicy

writerCreationTracker

private Consumer<org.apache.hadoop.fs.Path> writerCreationTracker

maxVersions

private int maxVersions

newVersionBehavior

private boolean newVersionBehavior

comparator

private CellComparator comparator

isCompaction

private boolean isCompaction

Constructor Details

Builder

public Builder(org.apache.hadoop.conf.Configuration conf,
 CacheConfig cacheConf,
 org.apache.hadoop.fs.FileSystem fs)

Builder

public Builder(org.apache.hadoop.conf.Configuration conf,
 org.apache.hadoop.fs.FileSystem fs)

Creates Builder with cache configuration disabled

Method Details

withOutputDir

public StoreFileWriter.Builder withOutputDir(org.apache.hadoop.fs.Path dir)

Use either this method or withFilePath(org.apache.hadoop.fs.Path), but not both.

Parameters:

dir - Path to column family directory. The directory is created if does not exist. The file is given a unique name within this directory.

Returns:

this (for chained invocation)

withFilePath

public StoreFileWriter.Builder withFilePath(org.apache.hadoop.fs.Path filePath)

Use either this method or withOutputDir(org.apache.hadoop.fs.Path), but not both.

Parameters:

filePath - the StoreFile path to write

Returns:

this (for chained invocation)

withFavoredNodes

public StoreFileWriter.Builder withFavoredNodes(InetSocketAddress[] favoredNodes)

Parameters:

favoredNodes - an array of favored nodes or possibly null

Returns:

this (for chained invocation)

withBloomType

public StoreFileWriter.Builder withBloomType(BloomType bloomType)

withMaxKeyCount

public StoreFileWriter.Builder withMaxKeyCount(long maxKeyCount)

Parameters:

maxKeyCount - estimated maximum number of keys we expect to add

Returns:

this (for chained invocation)

withFileContext

public StoreFileWriter.Builder withFileContext(HFileContext fileContext)

withShouldDropCacheBehind

public StoreFileWriter.Builder withShouldDropCacheBehind(boolean shouldDropCacheBehind)

withCompactedFilesSupplier

public StoreFileWriter.Builder withCompactedFilesSupplier(Supplier<Collection<HStoreFile>> compactedFilesSupplier)

withFileStoragePolicy

public StoreFileWriter.Builder withFileStoragePolicy(String fileStoragePolicy)

withWriterCreationTracker

public StoreFileWriter.Builder withWriterCreationTracker(Consumer<org.apache.hadoop.fs.Path> writerCreationTracker)

withMaxVersions

public StoreFileWriter.Builder withMaxVersions(int maxVersions)

withNewVersionBehavior

public StoreFileWriter.Builder withNewVersionBehavior(boolean newVersionBehavior)

withCellComparator

public StoreFileWriter.Builder withCellComparator(CellComparator comparator)

withIsCompaction

public StoreFileWriter.Builder withIsCompaction(boolean isCompaction)

build

public StoreFileWriter build()
                      throws IOException

Create a store file writer. Client is responsible for closing file when done. If metadata, add BEFORE closing using StoreFileWriter.appendMetadata(long, boolean).

Throws:

IOException