org.apache.hadoop.hbase.regionserver

Class ScanInfo

java.lang.Object

org.apache.hadoop.hbase.regionserver.ScanInfo

@InterfaceAudience.Private
public class ScanInfo
extends Object

Immutable information for scans over a store.

Field Summary

Fields

Modifier and Type	Field and Description
private long	cellsPerTimeoutCheck
private CellComparator	comparator
private byte[]	family
static long	FIXED_OVERHEAD
private KeepDeletedCells	keepDeletedCells
private int	maxVersions
private int	minVersions
private boolean	newVersionBehavior
private boolean	parallelSeekEnabled
private long	preadMaxBytes
private long	tableMaxRowSize
private long	timeToPurgeDeletes
private long	ttl
private boolean	usePread

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ScanInfo(byte[] family, int minVersions, int maxVersions, long ttl, KeepDeletedCells keepDeletedCells, long timeToPurgeDeletes, CellComparator comparator, long tableMaxRowSize, boolean usePread, long cellsPerTimeoutCheck, boolean parallelSeekEnabled, long preadMaxBytes, boolean newVersionBehavior)
	ScanInfo(org.apache.hadoop.conf.Configuration conf, byte[] family, int minVersions, int maxVersions, long ttl, KeepDeletedCells keepDeletedCells, long blockSize, long timeToPurgeDeletes, CellComparator comparator, boolean newVersionBehavior) n * @param family Name of this store's column family
	ScanInfo(org.apache.hadoop.conf.Configuration conf, ColumnFamilyDescriptor family, long ttl, long timeToPurgeDeletes, CellComparator comparator) n * @param family ColumnFamilyDescriptor describing the column family

Method Summary

Modifier and Type	Method and Description
(package private) ScanInfo	customize(int maxVersions, long ttl, KeepDeletedCells keepDeletedCells) Used by CP users for customizing max versions, ttl and keepDeletedCells.
(package private) ScanInfo	customize(int maxVersions, long ttl, KeepDeletedCells keepDeletedCells, int minVersions, long timeToPurgeDeletes) Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions, and time to purge deletes.
(package private) long	getCellsPerTimeoutCheck()
private static long	getCellsPerTimeoutCheck(org.apache.hadoop.conf.Configuration conf)
CellComparator	getComparator()
byte[]	getFamily()
KeepDeletedCells	getKeepDeletedCells()
int	getMaxVersions()
int	getMinVersions()
(package private) long	getPreadMaxBytes()
(package private) long	getTableMaxRowSize()
long	getTimeToPurgeDeletes()
long	getTtl()
boolean	isNewVersionBehavior()
(package private) boolean	isParallelSeekEnabled()
(package private) boolean	isUsePread()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

family

private byte[] family

minVersions

private int minVersions

maxVersions

private int maxVersions

ttl

private long ttl

keepDeletedCells

private KeepDeletedCells keepDeletedCells

timeToPurgeDeletes

private long timeToPurgeDeletes

comparator

private CellComparator comparator

tableMaxRowSize

private long tableMaxRowSize

usePread

private boolean usePread

cellsPerTimeoutCheck

private long cellsPerTimeoutCheck

parallelSeekEnabled

private boolean parallelSeekEnabled

preadMaxBytes

private final long preadMaxBytes

newVersionBehavior

private final boolean newVersionBehavior

FIXED_OVERHEAD

public static final long FIXED_OVERHEAD

Constructor Detail

ScanInfo

public ScanInfo(org.apache.hadoop.conf.Configuration conf,
                ColumnFamilyDescriptor family,
                long ttl,
                long timeToPurgeDeletes,
                CellComparator comparator)

n * @param family ColumnFamilyDescriptor describing the column family

Parameters:

ttl - Store's TTL (in ms)

timeToPurgeDeletes - duration in ms after which a delete marker can be purged during a major compaction.

comparator - The store's comparator

ScanInfo

public ScanInfo(org.apache.hadoop.conf.Configuration conf,
                byte[] family,
                int minVersions,
                int maxVersions,
                long ttl,
                KeepDeletedCells keepDeletedCells,
                long blockSize,
                long timeToPurgeDeletes,
                CellComparator comparator,
                boolean newVersionBehavior)

n * @param family Name of this store's column family

Parameters:

minVersions - Store's MIN_VERSIONS setting

maxVersions - Store's VERSIONS setting

ttl - Store's TTL (in ms)

blockSize - Store's block size

timeToPurgeDeletes - duration in ms after which a delete marker can be purged during a major compaction.

keepDeletedCells - Store's keepDeletedCells setting

comparator - The store's comparator

ScanInfo

private ScanInfo(byte[] family,
                 int minVersions,
                 int maxVersions,
                 long ttl,
                 KeepDeletedCells keepDeletedCells,
                 long timeToPurgeDeletes,
                 CellComparator comparator,
                 long tableMaxRowSize,
                 boolean usePread,
                 long cellsPerTimeoutCheck,
                 boolean parallelSeekEnabled,
                 long preadMaxBytes,
                 boolean newVersionBehavior)

Method Detail

getCellsPerTimeoutCheck

private static long getCellsPerTimeoutCheck(org.apache.hadoop.conf.Configuration conf)

getTableMaxRowSize

long getTableMaxRowSize()

isUsePread

boolean isUsePread()

getCellsPerTimeoutCheck

long getCellsPerTimeoutCheck()

isParallelSeekEnabled

boolean isParallelSeekEnabled()

getFamily

public byte[] getFamily()

getMinVersions

public int getMinVersions()

getMaxVersions

public int getMaxVersions()

getTtl

public long getTtl()

getKeepDeletedCells

public KeepDeletedCells getKeepDeletedCells()

getTimeToPurgeDeletes

public long getTimeToPurgeDeletes()

getComparator

public CellComparator getComparator()

getPreadMaxBytes

long getPreadMaxBytes()

isNewVersionBehavior

public boolean isNewVersionBehavior()

customize

ScanInfo customize(int maxVersions,
                   long ttl,
                   KeepDeletedCells keepDeletedCells)

Used by CP users for customizing max versions, ttl and keepDeletedCells.

customize

ScanInfo customize(int maxVersions,
                   long ttl,
                   KeepDeletedCells keepDeletedCells,
                   int minVersions,
                   long timeToPurgeDeletes)

Used by CP users for customizing max versions, ttl, keepDeletedCells, min versions, and time to purge deletes.

toString

public String toString()

Overrides:

toString in class Object