org.apache.derby.iapi.sql.execute

Interface ResultSetStatistics

All Superinterfaces:

XPLAINable

All Known Implementing Classes:

RealAnyResultSetStatistics, RealCurrentOfStatistics, RealDeleteCascadeResultSetStatistics, RealDeleteResultSetStatistics, RealDeleteVTIResultSetStatistics, RealDistinctScalarAggregateStatistics, RealDistinctScanStatistics, RealGroupedAggregateStatistics, RealHashJoinStatistics, RealHashLeftOuterJoinStatistics, RealHashScanStatistics, RealHashTableStatistics, RealIndexRowToBaseRowStatistics, RealInsertResultSetStatistics, RealInsertVTIResultSetStatistics, RealJoinResultSetStatistics, RealLastIndexKeyScanStatistics, RealMaterializedResultSetStatistics, RealNestedLoopJoinStatistics, RealNestedLoopLeftOuterJoinStatistics, RealNormalizeResultSetStatistics, RealOnceResultSetStatistics, RealProjectRestrictStatistics, RealRowCountStatistics, RealRowResultSetStatistics, RealScalarAggregateStatistics, RealScrollInsensitiveResultSetStatistics, RealSetOpResultSetStatistics, RealSortStatistics, RealTableScanStatistics, RealUnionResultSetStatistics, RealUpdateResultSetStatistics, RealVTIStatistics, RealWindowResultSetStatistics

public interface ResultSetStatistics
extends XPLAINable

The ResultSetStatistics interface is used to provide run time statistics information on a specific ResultSet.

This interface extends Formatable so that all objects which implement this interface can be easily saved to the database.

Method Summary

Modifier and Type	Method and Description
double	getEstimatedRowCount() Get the estimated row count for the number of rows returned by the associated query or statement.
java.lang.String	getScanStatisticsText(java.lang.String tableName, int depth) Return information on the scan nodes from the statement execution plan as a String.
java.lang.String	getStatementExecutionPlanText(int depth) Return the statement execution plan as a String.

Methods inherited from interface org.apache.derby.iapi.sql.execute.xplain.XPLAINable

accept, getResultSetDescriptor, getResultSetTimingsDescriptor, getRSXplainDetails, getRSXplainType, getScanPropsDescriptor, getSortPropsDescriptor

Method Detail

getStatementExecutionPlanText

java.lang.String getStatementExecutionPlanText(int depth)

Return the statement execution plan as a String.

Parameters:

depth - Indentation level.

Returns:

String The statement execution plan as a String.

getScanStatisticsText

java.lang.String getScanStatisticsText(java.lang.String tableName,
                                       int depth)

Return information on the scan nodes from the statement execution plan as a String.

Parameters:

depth - Indentation level.

tableName - if not NULL then return information for this table only

Returns:

String The information on the scan nodes from the statement execution plan as a String.

getEstimatedRowCount

double getEstimatedRowCount()

Get the estimated row count for the number of rows returned by the associated query or statement.

Returns:

The estimated number of rows returned by the associated query or statement.