Top Description Methods
org.apache.derby.iapi.sql.compile

public Interface OptTrace

Known Direct Implementers
org.apache.derby.impl.sql.compile.DefaultOptTrace, org.apache.derby.impl.sql.compile.XMLOptTrace
Imports
java.io.PrintWriter, org.apache.derby.iapi.sql.dictionary.ConglomerateDescriptor, org.apache.derby.iapi.util.JBitSet

Interface for optimizer tracing.

Method Summary

Modifier and TypeMethod and Description
public void
printToWriter(PrintWriter out)

Print the trace so far.

public void
traceAddingUnorderedOptimizable(int predicateCount)

Say that we're adding an unordered optimizable.

public void
traceChangingAccessPathForTable(int tableNumber)

Say that we're considering a different access path for a table.

public void
traceCheapestPlanSoFar(int planType, CostEstimate currentCost)

Report the cost of the cheapest plan so far.

public void
traceCompleteJoinOrder()

Say that we have a complete join order.

public void
traceCompositeSelectivityFromStatistics(double statCompositeSelectivity)

Report the selectivity calculated from SYSSTATISTICS.

public void
traceConsideringConglomerate(ConglomerateDescriptor cd, int tableNumber)

Report that we are considering a conglomerate for a table.

public void
traceConsideringJoinStrategy(JoinStrategy js, int tableNumber)

Say that we're considering a particular join strategy on a particular table.

public void
traceConstantStartStopPositions()

Say that we're setting the lock mode to MODE_RECORD because the start and stop positions are all constant.

public void
traceCostIncludingCompositeSelectivityFromStats(CostEstimate cost, int tableNumber)

Report the cost based on selectivities coming out of SYSSTATISTICS.

public void
traceCostIncludingExtra1stColumnSelectivity(CostEstimate cost, int tableNumber)

Report the cost of a scan given the selectivity of an extra first column.

public void
traceCostIncludingExtraNonQualifierSelectivity(CostEstimate cost, int tableNumber)

Report the cost if we include an extra non-qualifier.

public void
traceCostIncludingExtraQualifierSelectivity(CostEstimate cost, int tableNumber)

Report the cost if we include an extra qualifier.

public void
traceCostIncludingExtraStartStop(CostEstimate cost, int tableNumber)

Report the cost if we include an extra start/stop.

public void
traceCostIncludingStatsForIndex(CostEstimate cost, int tableNumber)

Report the cost based on index statistics.

public void
traceCostOfConglomerateScan(int tableNumber, ConglomerateDescriptor cd, CostEstimate costEstimate, int numExtraFirstColumnPreds, double extraFirstColumnSelectivity, int numExtraStartStopPreds, double extraStartStopSelectivity, int startStopPredCount, double statStartStopSelectivity, int numExtraQualifiers, double extraQualifierSelectivity, int numExtraNonQualifiers, double extraNonQualifierSelectivity)

Report the cost of a conglomerate scan.

public void
traceCostOfNoncoveringIndex(CostEstimate cost, int tableNumber)

Report the cost of using a non-covering index.

public void
traceCostOfNScans(int tableNumber, double rowCount, CostEstimate cost)

Report the cost of scanning a table a certain number of times

public void
traceCostWithoutSortAvoidance(CostEstimate currentCost)

Report the cost without a sort.

public void
traceCostWithSortAvoidance(CostEstimate currentSortAvoidanceCost)

Report the cost with sort avoidance.

public void
traceCurrentPlanAvoidsSort(CostEstimate bestCost, CostEstimate currentSortAvoidanceCost)

Say that the current plan avoids a sort.

public void
traceEndQueryBlock()

End tracing the optimization of a query block.

public void
traceEstimatingCostOfConglomerate(ConglomerateDescriptor cd, int tableNumber)

Report the cost of using a particular conglomerate to scan a table.

public void
traceHashKeyColumns(int[] hashKeyColumns)

Report the columns being traced

public void
traceIllegalUserJoinOrder()

Say that the user specified an impossible join order.

public void
traceJoinOrderConsideration(int joinPosition, int[] proposedJoinOrder, JBitSet assignedTableMap)

Say that we're considering a join order.

public void
traceLookingForSpecifiedIndex(String indexName, int tableNumber)

Say that we're looking for an index specified by optimizer hints.

public void
traceModifyingAccessPaths(int optimizerID)

Say that we're modifying access paths.

public void
traceNextAccessPath(String baseTable, int predicateCount)

Report that we are advancing to the next access path for the table.

public void
traceNoBestPlan()

Say that we couldn't find a best plan.

public void
traceNoMoreConglomerates(int tableNumber)

Say that we have exhausted the conglomerate possibilities for a table.

public void
traceNonCoveringIndexCost(double cost, int tableNumber)

Say that we're considering a non-covering index.

public void
traceNoStartStopPosition()

Say that we're setting the lock mode to MODE_TABLE because there is no start/stop position.

public void
traceOptimizingJoinNode()

Say that we're starting to optimize a join node

public void
traceRememberingBestAccessPath(AccessPath accessPath, int tableNumber, int planType)

Report that we've found a best access path.

public void
traceRememberingBestAccessPathSubstring(AccessPath ap, int tableNumber)

Report the best access path for the table so far.

public void
traceRememberingBestJoinOrder(int joinPosition, int[] bestJoinOrder, int planType, CostEstimate planCost, JBitSet assignedTableMap)

Say that we are remembering the current plan as the best join order so far.

public void
traceRememberingBestSortAvoidanceAccessPathSubstring(AccessPath ap, int tableNumber)

Report the best sort-avoiding access path for this table so far.

public void
traceRememberingBestUnknownAccessPathSubstring(AccessPath ap, int tableNumber)

Report an optimizer failure, e.g., while optimizing an outer join

public void
traceRememberingJoinStrategy(JoinStrategy joinStrategy, int tableNumber)

Say that we've found a new best join strategy for the table.

public void
traceScanningHeapWithUniqueKey()

Say that we're considering scanning a heap even though we have a unique key match.

public void
traceShortCircuiting(boolean timeExceeded, Optimizable thisOpt, int joinPosition)

Say that we short-circuited a join order.

public void
traceSingleMatchedRowCost(double cost, int tableNumber)

Report the cost of a scan which will match exactly one row.

public void
traceSkipHashJoinNoHashKeys()

Say we won't consider a hash join because there are no hash key columns.

public void
traceSkippingBecauseTooMuchMemory(int maxMemoryPerTable)

Say that we are skipping a plan because it consumes too much memory.

public void
traceSkippingJoinOrder(int nextOptimizable, int joinPosition, int[] proposedJoinOrder, JBitSet assignedTableMap)

Say that we're skipping the join order starting with the next optimizable.

public void
traceSkipUnmaterializableHashJoin()

Say that we won't consider a hash join because the result can't be materialized

public void
traceSortCost(CostEstimate sortCost, CostEstimate currentCost)

Report the sort cost.

public void
traceSortNeededForOrdering(int planType, RequiredRowOrdering requiredRowOrdering)

Report that this plan needs a sort

public void
traceStartQueryBlock(long timeOptimizationStarted, int optimizerID, OptimizableList optimizableList)

Start optimizer tracing for a query block.

public void
traceStartStatement(String statementText)

Start the start of tracing a statement.

public void
traceTimeout(long currentTime, CostEstimate bestCost)

Say that the optimizer ran out of time.

public void
traceUserJoinOrderOptimized()

Say that we have optimized the user-specified join order.

public void
traceVacuous()

Say that there's nothing to optimizer.

Method Detail

printToWriterback to summary
public void printToWriter(PrintWriter out)

Print the trace so far.

traceAddingUnorderedOptimizableback to summary
public void traceAddingUnorderedOptimizable(int predicateCount)

Say that we're adding an unordered optimizable.

traceChangingAccessPathForTableback to summary
public void traceChangingAccessPathForTable(int tableNumber)

Say that we're considering a different access path for a table.

traceCheapestPlanSoFarback to summary
public void traceCheapestPlanSoFar(int planType, CostEstimate currentCost)

Report the cost of the cheapest plan so far.

traceCompleteJoinOrderback to summary
public void traceCompleteJoinOrder()

Say that we have a complete join order.

traceCompositeSelectivityFromStatisticsback to summary
public void traceCompositeSelectivityFromStatistics(double statCompositeSelectivity)

Report the selectivity calculated from SYSSTATISTICS.

traceConsideringConglomerateback to summary
public void traceConsideringConglomerate(ConglomerateDescriptor cd, int tableNumber)

Report that we are considering a conglomerate for a table.

traceConsideringJoinStrategyback to summary
public void traceConsideringJoinStrategy(JoinStrategy js, int tableNumber)

Say that we're considering a particular join strategy on a particular table.

traceConstantStartStopPositionsback to summary
public void traceConstantStartStopPositions()

Say that we're setting the lock mode to MODE_RECORD because the start and stop positions are all constant.

traceCostIncludingCompositeSelectivityFromStatsback to summary
public void traceCostIncludingCompositeSelectivityFromStats(CostEstimate cost, int tableNumber)

Report the cost based on selectivities coming out of SYSSTATISTICS.

traceCostIncludingExtra1stColumnSelectivityback to summary
public void traceCostIncludingExtra1stColumnSelectivity(CostEstimate cost, int tableNumber)

Report the cost of a scan given the selectivity of an extra first column.

traceCostIncludingExtraNonQualifierSelectivityback to summary
public void traceCostIncludingExtraNonQualifierSelectivity(CostEstimate cost, int tableNumber)

Report the cost if we include an extra non-qualifier.

traceCostIncludingExtraQualifierSelectivityback to summary
public void traceCostIncludingExtraQualifierSelectivity(CostEstimate cost, int tableNumber)

Report the cost if we include an extra qualifier.

traceCostIncludingExtraStartStopback to summary
public void traceCostIncludingExtraStartStop(CostEstimate cost, int tableNumber)

Report the cost if we include an extra start/stop.

traceCostIncludingStatsForIndexback to summary
public void traceCostIncludingStatsForIndex(CostEstimate cost, int tableNumber)

Report the cost based on index statistics.

traceCostOfConglomerateScanback to summary
public void traceCostOfConglomerateScan(int tableNumber, ConglomerateDescriptor cd, CostEstimate costEstimate, int numExtraFirstColumnPreds, double extraFirstColumnSelectivity, int numExtraStartStopPreds, double extraStartStopSelectivity, int startStopPredCount, double statStartStopSelectivity, int numExtraQualifiers, double extraQualifierSelectivity, int numExtraNonQualifiers, double extraNonQualifierSelectivity)

Report the cost of a conglomerate scan.

traceCostOfNoncoveringIndexback to summary
public void traceCostOfNoncoveringIndex(CostEstimate cost, int tableNumber)

Report the cost of using a non-covering index.

traceCostOfNScansback to summary
public void traceCostOfNScans(int tableNumber, double rowCount, CostEstimate cost)

Report the cost of scanning a table a certain number of times

traceCostWithoutSortAvoidanceback to summary
public void traceCostWithoutSortAvoidance(CostEstimate currentCost)

Report the cost without a sort.

traceCostWithSortAvoidanceback to summary
public void traceCostWithSortAvoidance(CostEstimate currentSortAvoidanceCost)

Report the cost with sort avoidance.

traceCurrentPlanAvoidsSortback to summary
public void traceCurrentPlanAvoidsSort(CostEstimate bestCost, CostEstimate currentSortAvoidanceCost)

Say that the current plan avoids a sort.

traceEndQueryBlockback to summary
public void traceEndQueryBlock()

End tracing the optimization of a query block.

traceEstimatingCostOfConglomerateback to summary
public void traceEstimatingCostOfConglomerate(ConglomerateDescriptor cd, int tableNumber)

Report the cost of using a particular conglomerate to scan a table.

traceHashKeyColumnsback to summary
public void traceHashKeyColumns(int[] hashKeyColumns)

Report the columns being traced

traceIllegalUserJoinOrderback to summary
public void traceIllegalUserJoinOrder()

Say that the user specified an impossible join order.

traceJoinOrderConsiderationback to summary
public void traceJoinOrderConsideration(int joinPosition, int[] proposedJoinOrder, JBitSet assignedTableMap)

Say that we're considering a join order.

traceLookingForSpecifiedIndexback to summary
public void traceLookingForSpecifiedIndex(String indexName, int tableNumber)

Say that we're looking for an index specified by optimizer hints.

traceModifyingAccessPathsback to summary
public void traceModifyingAccessPaths(int optimizerID)

Say that we're modifying access paths.

traceNextAccessPathback to summary
public void traceNextAccessPath(String baseTable, int predicateCount)

Report that we are advancing to the next access path for the table.

traceNoBestPlanback to summary
public void traceNoBestPlan()

Say that we couldn't find a best plan.

traceNoMoreConglomeratesback to summary
public void traceNoMoreConglomerates(int tableNumber)

Say that we have exhausted the conglomerate possibilities for a table.

traceNonCoveringIndexCostback to summary
public void traceNonCoveringIndexCost(double cost, int tableNumber)

Say that we're considering a non-covering index.

traceNoStartStopPositionback to summary
public void traceNoStartStopPosition()

Say that we're setting the lock mode to MODE_TABLE because there is no start/stop position.

traceOptimizingJoinNodeback to summary
public void traceOptimizingJoinNode()

Say that we're starting to optimize a join node

traceRememberingBestAccessPathback to summary
public void traceRememberingBestAccessPath(AccessPath accessPath, int tableNumber, int planType)

Report that we've found a best access path.

traceRememberingBestAccessPathSubstringback to summary
public void traceRememberingBestAccessPathSubstring(AccessPath ap, int tableNumber)

Report the best access path for the table so far.

traceRememberingBestJoinOrderback to summary
public void traceRememberingBestJoinOrder(int joinPosition, int[] bestJoinOrder, int planType, CostEstimate planCost, JBitSet assignedTableMap)

Say that we are remembering the current plan as the best join order so far.

traceRememberingBestSortAvoidanceAccessPathSubstringback to summary
public void traceRememberingBestSortAvoidanceAccessPathSubstring(AccessPath ap, int tableNumber)

Report the best sort-avoiding access path for this table so far.

traceRememberingBestUnknownAccessPathSubstringback to summary
public void traceRememberingBestUnknownAccessPathSubstring(AccessPath ap, int tableNumber)

Report an optimizer failure, e.g., while optimizing an outer join

traceRememberingJoinStrategyback to summary
public void traceRememberingJoinStrategy(JoinStrategy joinStrategy, int tableNumber)

Say that we've found a new best join strategy for the table.

traceScanningHeapWithUniqueKeyback to summary
public void traceScanningHeapWithUniqueKey()

Say that we're considering scanning a heap even though we have a unique key match.

traceShortCircuitingback to summary
public void traceShortCircuiting(boolean timeExceeded, Optimizable thisOpt, int joinPosition)

Say that we short-circuited a join order.

traceSingleMatchedRowCostback to summary
public void traceSingleMatchedRowCost(double cost, int tableNumber)

Report the cost of a scan which will match exactly one row.

traceSkipHashJoinNoHashKeysback to summary
public void traceSkipHashJoinNoHashKeys()

Say we won't consider a hash join because there are no hash key columns.

traceSkippingBecauseTooMuchMemoryback to summary
public void traceSkippingBecauseTooMuchMemory(int maxMemoryPerTable)

Say that we are skipping a plan because it consumes too much memory.

traceSkippingJoinOrderback to summary
public void traceSkippingJoinOrder(int nextOptimizable, int joinPosition, int[] proposedJoinOrder, JBitSet assignedTableMap)

Say that we're skipping the join order starting with the next optimizable.

traceSkipUnmaterializableHashJoinback to summary
public void traceSkipUnmaterializableHashJoin()

Say that we won't consider a hash join because the result can't be materialized

traceSortCostback to summary
public void traceSortCost(CostEstimate sortCost, CostEstimate currentCost)

Report the sort cost.

traceSortNeededForOrderingback to summary
public void traceSortNeededForOrdering(int planType, RequiredRowOrdering requiredRowOrdering)

Report that this plan needs a sort

traceStartQueryBlockback to summary
public void traceStartQueryBlock(long timeOptimizationStarted, int optimizerID, OptimizableList optimizableList)

Start optimizer tracing for a query block.

traceStartStatementback to summary
public void traceStartStatement(String statementText)

Start the start of tracing a statement.

traceTimeoutback to summary
public void traceTimeout(long currentTime, CostEstimate bestCost)

Say that the optimizer ran out of time.

traceUserJoinOrderOptimizedback to summary
public void traceUserJoinOrderOptimized()

Say that we have optimized the user-specified join order.

traceVacuousback to summary
public void traceVacuous()

Say that there's nothing to optimizer.