co.cask.cdap.data2.util.hbase

Interface ScanBuilder

public interface ScanBuilder

Builder for creating Scan. This builder should be used for cross HBase versions compatibility. All methods on this class are just delegating to calls to Scan object.

Method Summary

Methods

Modifier and Type	Method and Description
ScanBuilder	addColumn(byte[] family, byte[] qualifier)
ScanBuilder	addFamily(byte[] family)
org.apache.hadoop.hbase.client.Scan	build()
ScanBuilder	setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)
ScanBuilder	setACL(String user, org.apache.hadoop.hbase.security.access.Permission perms)
ScanBuilder	setAttribute(String name, byte[] value)
ScanBuilder	setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)
ScanBuilder	setBatch(int batch)
ScanBuilder	setCacheBlocks(boolean cacheBlocks)
ScanBuilder	setCaching(int caching)
ScanBuilder	setFamilyMap(Map<byte[],NavigableSet<byte[]>> familyMap)
ScanBuilder	setFilter(org.apache.hadoop.hbase.filter.Filter filter)
ScanBuilder	setId(String id)
ScanBuilder	setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel level)
ScanBuilder	setLoadColumnFamiliesOnDemand(boolean value)
ScanBuilder	setMaxResultSize(long maxResultSize)
ScanBuilder	setMaxResultsPerColumnFamily(int limit)
ScanBuilder	setMaxVersions()
ScanBuilder	setMaxVersions(int maxVersions)
ScanBuilder	setRaw(boolean raw)
ScanBuilder	setRowOffsetPerColumnFamily(int offset)
ScanBuilder	setSmall(boolean small)
ScanBuilder	setStartRow(byte[] startRow)
ScanBuilder	setStopRow(byte[] stopRow)
ScanBuilder	setTimeRange(long minStamp, long maxStamp)
ScanBuilder	setTimeStamp(long timestamp)

Method Detail

addFamily

ScanBuilder addFamily(byte[] family)

addColumn

ScanBuilder addColumn(byte[] family,
                    byte[] qualifier)

setTimeRange

ScanBuilder setTimeRange(long minStamp,
                       long maxStamp)
                         throws IOException

Throws:

IOException

setTimeStamp

ScanBuilder setTimeStamp(long timestamp)
                         throws IOException

Throws:

IOException

setStartRow

ScanBuilder setStartRow(byte[] startRow)

setStopRow

ScanBuilder setStopRow(byte[] stopRow)

setMaxVersions

ScanBuilder setMaxVersions()

setMaxVersions

ScanBuilder setMaxVersions(int maxVersions)

setFilter

ScanBuilder setFilter(org.apache.hadoop.hbase.filter.Filter filter)

setFamilyMap

ScanBuilder setFamilyMap(Map<byte[],NavigableSet<byte[]>> familyMap)

setAttribute

ScanBuilder setAttribute(String name,
                       byte[] value)

setId

ScanBuilder setId(String id)

setAuthorizations

ScanBuilder setAuthorizations(org.apache.hadoop.hbase.security.visibility.Authorizations authorizations)

setACL

ScanBuilder setACL(String user,
                 org.apache.hadoop.hbase.security.access.Permission perms)

setACL

ScanBuilder setACL(Map<String,org.apache.hadoop.hbase.security.access.Permission> perms)

setBatch

ScanBuilder setBatch(int batch)

setMaxResultsPerColumnFamily

ScanBuilder setMaxResultsPerColumnFamily(int limit)

setRowOffsetPerColumnFamily

ScanBuilder setRowOffsetPerColumnFamily(int offset)

setCaching

ScanBuilder setCaching(int caching)

setMaxResultSize

ScanBuilder setMaxResultSize(long maxResultSize)

setCacheBlocks

ScanBuilder setCacheBlocks(boolean cacheBlocks)

setLoadColumnFamiliesOnDemand

ScanBuilder setLoadColumnFamiliesOnDemand(boolean value)

setRaw

ScanBuilder setRaw(boolean raw)

setIsolationLevel

ScanBuilder setIsolationLevel(org.apache.hadoop.hbase.client.IsolationLevel level)

setSmall

ScanBuilder setSmall(boolean small)

build

org.apache.hadoop.hbase.client.Scan build()