Package org.apache.hadoop.hbase.regionserver

Interface ScanOptions

All Known Implementing Classes:
CustomizedScanInfoBuilder
@LimitedPrivate("Coprocesssor") @Evolving public interface ScanOptions
This class gives you the ability to change the max versions and TTL options before opening a scanner for a Store. And also gives you some information for the scan.

Changing max versions, min versins, KeepDeletedCells, and TTL are usually safe even for flush/compaction, so here we provide a way to do it for you. If you want to do other complicated operations such as filtering, please wrap the InternalScanner in the preCompact and preFlush methods in RegionObserver.

For user scans, we also provide this class as a parameter in the preStoreScannerOpen method in RegionObserver. You can use it to change the inherent properties for a Store. For example, even if you use Scan.readAllVersions, you still can not read two versions if the max versions property of the Store is one. You need to set the max versions to a value greater than two in preStoreScannerOpen.

See Also: