public class SpliceScanInfo extends java.lang.Object implements ScanInfo
|Modifier and Type||Method and Description|
Return all information gathered about the scan.
public SpliceScanInfo(SpliceScan scan)
public java.util.Properties getAllScanInfo(java.util.Properties prop) throws StandardException
This routine returns a list of properties which contains all information gathered about the scan. If a Property is passed in, then that property list is appeneded to, otherwise a new property object is created and returned.
Not all scans may support all properties, if the property is not supported then it will not be returned. The following is a list of properties that may be returned: numPagesVisited - the number of pages visited during the scan. For btree scans this number only includes the leaf pages visited. numRowsVisited - the number of rows visited during the scan. This number includes all rows, including: those marked deleted, those that don't meet qualification, ... numRowsQualified - the number of undeleted rows, which met the qualification. treeHeight (btree's only) - for btree's the height of the tree. A tree with one page has a height of 1. Total number of pages visited in a btree scan is (treeHeight - 1 + numPagesVisited). NOTE - this list will be expanded as more information about the scan is gathered and returned.