类 org.apache.hadoop.hbase.client.Scan
的使用

使用Scan的程序包

程序包	说明
org.apache.hadoop.hbase
org.apache.hadoop.hbase.client	Provides HBase Client Table of Contents Overview Example API Usage Overview To administer HBase, create and drop tables, list and alter tables, use Admin.
org.apache.hadoop.hbase.client.coprocessor	Provides client classes for invoking Coprocessor RPC protocols Overview Example Usage Overview The coprocessor framework provides a way for custom code to run in place on the HBase region servers with each of a table's regions.
org.apache.hadoop.hbase.protobuf	Holds classes generated from protobuf src/main/protobuf definition files.
org.apache.hadoop.hbase.quotas

org.apache.hadoop.hbase中Scan的使用

返回Scan的org.apache.hadoop.hbase中的方法

限定符和类型	方法和说明
static Scan	MetaTableAccessor.getScanForTableName(TableName tableName) This method creates a Scan object that will only scan catalog rows that belong to the specified table.

org.apache.hadoop.hbase.client中Scan的使用

声明为Scan的org.apache.hadoop.hbase.client中的字段

限定符和类型	字段和说明
protected Scan	ScannerCallable.scan
protected Scan	ClientScanner.scan

返回Scan的org.apache.hadoop.hbase.client中的方法

限定符和类型	方法和说明
Scan	Scan.addColumn(byte[] family, byte[] qualifier) Get the column from the specified family with the specified qualifier.
Scan	Scan.addFamily(byte[] family) Get all columns from the specified family.
static Scan	Scan.createScanFromCursor(Cursor cursor) Create a new Scan with a cursor.
protected Scan	ScannerCallable.getScan()
protected Scan	ClientScanner.getScan()
Scan	Scan.setACL(Map<String,Permission> perms)
Scan	Scan.setACL(String user, Permission perms)
Scan	Scan.setAllowPartialResults(boolean allowPartialResults) Setting whether the caller wants to see the partial results when server returns less-than-expected cells.
Scan	Scan.setAttribute(String name, byte[] value)
Scan	Scan.setAuthorizations(Authorizations authorizations)
Scan	Scan.setBatch(int batch) Set the maximum number of cells to return for each call to next().
Scan	Scan.setCacheBlocks(boolean cacheBlocks) Set whether blocks should be cached for this Scan.
Scan	Scan.setCaching(int caching) Set the number of rows for caching that will be passed to scanners.
Scan	Scan.setColumnFamilyTimeRange(byte[] cf, long minStamp, long maxStamp)
Scan	Scan.setConsistency(Consistency consistency)
Scan	Scan.setFamilyMap(Map<byte[],NavigableSet<byte[]>> familyMap) Setting the familyMap
Scan	Scan.setFilter(Filter filter)
Scan	Scan.setId(String id)
Scan	Scan.setIsolationLevel(IsolationLevel level)
Scan	Scan.setLimit(int limit) Set the limit of rows for this scan.
Scan	Scan.setLoadColumnFamiliesOnDemand(boolean value)
Scan	Scan.setMaxResultSize(long maxResultSize) Set the maximum result size.
Scan	Scan.setMaxResultsPerColumnFamily(int limit) Set the maximum number of values to return per row per Column Family
Scan	Scan.setMaxVersions() Get all available versions.
Scan	Scan.setMaxVersions(int maxVersions) Get up to the specified number of versions of each column.
Scan	Scan.setNeedCursorResult(boolean needCursorResult) When the server is slow or we scan a table with many deleted data or we use a sparse filter, the server will response heartbeat to prevent timeout.
Scan	Scan.setOneRowLimit() Call this when you only want to get one row.
Scan	Scan.setPriority(int priority)
Scan	Scan.setRaw(boolean raw) Enable/disable "raw" mode for this scan.
Scan	Scan.setReadType(Scan.ReadType readType) Set the read type for this scan.
Scan	Scan.setReplicaId(int Id)
Scan	Scan.setReversed(boolean reversed) Set whether this scan is a reversed one This is false by default which means forward(normal) scan.
Scan	Scan.setRowOffsetPerColumnFamily(int offset) Set offset for the row per Column Family.
Scan	Scan.setRowPrefixFilter(byte[] rowPrefix) Set a filter (using stopRow and startRow) so the result set only contains rows where the rowKey starts with the specified prefix.
Scan	Scan.setScanMetricsEnabled(boolean enabled) Enable collection of ScanMetrics.
Scan	Scan.setSmall(boolean small) Set whether this scan is a small scan Small scan should use pread and big scan can use seek + read seek + read is fast but can cause two problem (1) resource contention (2) cause too much network io [89-fb] Using pread for non-compaction read request https://issues.apache.org/jira/browse/HBASE-7266 On the other hand, if setting it true, we would do openScanner,next,closeScanner in one RPC call.
Scan	Scan.setStartRow(byte[] startRow) 已过时。 use withStartRow(byte[]) instead. This method may change the inclusive of the stop row to keep compatible with the old behavior.
Scan	Scan.setStopRow(byte[] stopRow) 已过时。 use withStartRow(byte[]) instead. This method may change the inclusive of the stop row to keep compatible with the old behavior.
Scan	Scan.setTimeRange(long minStamp, long maxStamp) Get versions of columns only within the specified timestamp range, [minStamp, maxStamp).
Scan	Scan.setTimeStamp(long timestamp) Get versions of columns with the specified timestamp.
Scan	Scan.withStartRow(byte[] startRow) Set the start row of the scan.
Scan	Scan.withStartRow(byte[] startRow, boolean inclusive) Set the start row of the scan.
Scan	Scan.withStopRow(byte[] stopRow) Set the stop row of the scan.
Scan	Scan.withStopRow(byte[] stopRow, boolean inclusive) Set the stop row of the scan.

参数类型为Scan的org.apache.hadoop.hbase.client中的方法

限定符和类型	方法和说明
static ScanResultCache	ConnectionUtils.createScanResultCache(Scan scan, List<Result> cache)
static long	PackagePrivateFieldAccessor.getMvccReadPoint(Scan scan)
ResultScanner	HTable.getScanner(Scan scan) The underlying HTable must not be closed.
ResultScanner	Table.getScanner(Scan scan) Returns a scanner on the current table as specified by the Scan object.
protected void	AbstractClientScanner.initScanMetrics(Scan scan) Check and initialize if application wants to collect scan metrics
static void	PackagePrivateFieldAccessor.setMvccReadPoint(Scan scan, long mvccReadPoint)

参数类型为Scan的org.apache.hadoop.hbase.client中的构造器

构造器和说明
ClientScanner(org.apache.hadoop.conf.Configuration conf, Scan scan, TableName tableName, ClusterConnection connection, RpcRetryingCallerFactory rpcFactory, RpcControllerFactory controllerFactory, ExecutorService pool, int primaryOperationTimeout) Create a new ClientScanner for the specified table Note that the passed Scan's start row maybe changed changed.
ClientSimpleScanner(org.apache.hadoop.conf.Configuration configuration, Scan scan, TableName name, ClusterConnection connection, RpcRetryingCallerFactory rpcCallerFactory, RpcControllerFactory rpcControllerFactory, ExecutorService pool, int replicaCallTimeoutMicroSecondScan)
ReversedClientScanner(org.apache.hadoop.conf.Configuration conf, Scan scan, TableName tableName, ClusterConnection connection, RpcRetryingCallerFactory rpcFactory, RpcControllerFactory controllerFactory, ExecutorService pool, int primaryOperationTimeout) Create a new ReversibleClientScanner for the specified table Note that the passed Scan's start row maybe changed.
ReversedScannerCallable(ClusterConnection connection, TableName tableName, Scan scan, ScanMetrics scanMetrics, RpcControllerFactory rpcFactory)
ReversedScannerCallable(ClusterConnection connection, TableName tableName, Scan scan, ScanMetrics scanMetrics, RpcControllerFactory rpcFactory, int replicaId)
Scan(Scan scan) Creates a new instance of this class while copying all values.
ScannerCallable(ClusterConnection connection, TableName tableName, Scan scan, ScanMetrics scanMetrics, RpcControllerFactory rpcControllerFactory)
ScannerCallable(ClusterConnection connection, TableName tableName, Scan scan, ScanMetrics scanMetrics, RpcControllerFactory rpcControllerFactory, int id)

org.apache.hadoop.hbase.client.coprocessor中Scan的使用

参数类型为Scan的org.apache.hadoop.hbase.client.coprocessor中的方法

限定符和类型	方法和说明
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> double	AggregationClient.avg(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) This is the client side interface/handle for calling the average method for a given cf-cq combination.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> double	AggregationClient.avg(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) This is the client side interface/handle for calling the average method for a given cf-cq combination.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> R	AggregationClient.max(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It gives the maximum value of a column for a given column family for the given range.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> R	AggregationClient.max(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It gives the maximum value of a column for a given column family for the given range.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> R	AggregationClient.median(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) This is the client side interface/handler for calling the median method for a given cf-cq combination.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> R	AggregationClient.median(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) This is the client side interface/handler for calling the median method for a given cf-cq combination.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> R	AggregationClient.min(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It gives the minimum value of a column for a given column family for the given range.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> R	AggregationClient.min(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It gives the minimum value of a column for a given column family for the given range.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> long	AggregationClient.rowCount(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It gives the row count, by summing up the individual results obtained from regions.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> long	AggregationClient.rowCount(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It gives the row count, by summing up the individual results obtained from regions.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> double	AggregationClient.std(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) This is the client side interface/handle for calling the std method for a given cf-cq combination.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> double	AggregationClient.std(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) This is the client side interface/handle for calling the std method for a given cf-cq combination.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> S	AggregationClient.sum(Table table, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It sums up the value returned from various regions.
<R,S,P extends com.google.protobuf.Message,Q extends com.google.protobuf.Message,T extends com.google.protobuf.Message> S	AggregationClient.sum(TableName tableName, ColumnInterpreter<R,S,P,Q,T> ci, Scan scan) It sums up the value returned from various regions.

org.apache.hadoop.hbase.protobuf中Scan的使用

返回Scan的org.apache.hadoop.hbase.protobuf中的方法

限定符和类型	方法和说明
static Scan	ProtobufUtil.toScan(org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Scan proto) Convert a protocol buffer Scan to a client Scan

参数类型为Scan的org.apache.hadoop.hbase.protobuf中的方法

限定符和类型	方法和说明
static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ScanRequest	RequestConverter.buildScanRequest(byte[] regionName, Scan scan, int numberOfRows, boolean closeScanner) Create a protocol buffer ScanRequest for a client Scan
static org.apache.hadoop.hbase.protobuf.generated.ClientProtos.Scan	ProtobufUtil.toScan(Scan scan) Convert a client Scan to a protocol buffer Scan

org.apache.hadoop.hbase.quotas中Scan的使用

返回Scan的org.apache.hadoop.hbase.quotas中的方法

限定符和类型	方法和说明
static Scan	QuotaTableUtil.makeScan(QuotaFilter filter)