Top Description Fields Constructors Methods
org.apache.derby.impl.sql.compile

public Class OptimizerFactoryImpl

extends Object
implements ModuleControl, OptimizerFactory
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.sql.compile.OptimizerFactory, org.apache.derby.iapi.services.monitor.ModuleControl
Imports
java.util.Properties, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.services.monitor.ModuleControl, org.apache.derby.iapi.services.property.PropertyUtil, org.apache.derby.iapi.sql.compile.CostEstimate, .JoinStrategy, .OptimizableList, .OptimizablePredicateList, .Optimizer, .OptimizerFactory, .OptimizerPlan, .RequiredRowOrdering, org.apache.derby.iapi.sql.conn.LanguageConnectionContext, org.apache.derby.iapi.sql.dictionary.DataDictionary

This is simply the factory for creating an optimizer.

Field Summary

Modifier and TypeField and Description
private boolean
protected JoinStrategy[]
protected int
protected boolean
protected String
protected boolean
protected boolean

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
boot(boolean
True if the database should be created
create
,
Properties
Configuration properties
startParams
)

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Boot this module with the given properties.

public boolean
public CostEstimate
public int
getMaxMemoryPerTable()

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.getMaxMemoryPerTable.

Return the maxMemoryPerTable setting, this is used in optimizer, as well as subquery materialization at run time.

public Optimizer
getOptimizer(OptimizableList
The list of Optimizables to optimize.
optimizableList
,
OptimizablePredicateList
The list of unassigned OptimizablePredicates.
predList
,
DataDictionary
The DataDictionary to use.
dDictionary
,
RequiredRowOrdering
The required ordering of the rows to come out of the optimized result set
requiredRowOrdering
,
int
The number of tables in the current query
numTablesInQuery
,
OptimizerPlan
(Optional) A complete plan specified by optimizer overrides. Must have been bound already.
overridingPlan
,
LanguageConnectionContext
The LanguageConnectionContext RESOLVE - We probably want to pass a subquery list, once we define a new interface for them, so that the Optimizer can out where to attach the subqueries.
lcc
)

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.getOptimizer.

Only one optimizer level should exist in the database, however, the connection may have multiple instances of that optimizer at a given time.

protected Optimizer
getOptimizerImpl(OptimizableList optimizableList, OptimizablePredicateList predList, DataDictionary dDictionary, RequiredRowOrdering requiredRowOrdering, int numTablesInQuery, OptimizerPlan overridingPlan, LanguageConnectionContext lcc)

public void
public boolean
supportsOptimizerTrace()

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.supportsOptimizerTrace.

Return whether or not the optimizer associated with this factory supports optimizer trace.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

joinOrderOptimizationback to summary
private boolean joinOrderOptimization
joinStrategySetback to summary
protected JoinStrategy[] joinStrategySet
maxMemoryPerTableback to summary
protected int maxMemoryPerTable
noTimeoutback to summary
protected boolean noTimeout
optimizerIdback to summary
protected String optimizerId
ruleBasedOptimizationback to summary
protected boolean ruleBasedOptimization
useStatisticsback to summary
protected boolean useStatistics

Constructor Detail

OptimizerFactoryImplback to summary
public OptimizerFactoryImpl()

Method Detail

bootback to summary
public void boot(boolean create, Properties startParams) throws StandardException

Implements org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.boot.

Boot this module with the given properties. Creates a module instance that can be found using the findModule() methods of Monitor. The module can only be found using one of these findModule() methods once this method has returned.

An implementation's boot method can throw StandardException. If it is thrown the module is not registered by the monitor and therefore cannot be found through a findModule(). In this case the module's stop() method is not called, thus throwing this exception must free up any resources.

When create is true the contents of the properties object will be written to the service.properties of the persistent service. Thus any code that requires an entry in service.properties must explicitly place the value in this properties set using the put method.
Typically the properties object contains one or more default properties sets, which are not written out to service.properties. These default sets are how callers modify the create process. In a JDBC connection database create the first set of defaults is a properties object that contains the attributes that were set on the jdbc:derby: URL. This attributes properties set has the second default properties set as its default. This set (which could be null) contains the properties that the user set on their DriverManager.getConnection() call, and are thus not owned by Derby code, and thus must not be modified by Derby code.

When create is false the properties object contains all the properties set in the service.properties file plus a limited number of attributes from the JDBC URL attributes or connection properties set. This avoids properties set by the user compromising the boot process. An example of a property passed in from the JDBC world is the bootPassword for encrypted databases.

Code should not hold onto the passed in properties reference after boot time as its contents may change underneath it. At least after the complete boot is completed, the links to all the default sets will be removed.

Parameters
create:boolean

True if the database should be created

startParams:Properties

Configuration properties

Exceptions
StandardException:
Module cannot be started.
doJoinOrderOptimizationback to summary
public boolean doJoinOrderOptimization()

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.doJoinOrderOptimization.

Doc from org.apache.derby.iapi.sql.compile.OptimizerFactory.doJoinOrderOptimization.

Tell whether to do join order optimization.

Returns:boolean

true means do join order optimization, false means don't do it.

Annotations
@Override
getCostEstimateback to summary
public CostEstimate getCostEstimate()

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.getCostEstimate.

Doc from org.apache.derby.iapi.sql.compile.OptimizerFactory.getCostEstimate.

Return a new CostEstimate.

See Also
OptimizerFactory#getCostEstimate
getMaxMemoryPerTableback to summary
public int getMaxMemoryPerTable()

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.getMaxMemoryPerTable.

Doc from org.apache.derby.iapi.sql.compile.OptimizerFactory.getMaxMemoryPerTable.

Return the maxMemoryPerTable setting, this is used in optimizer, as well as subquery materialization at run time.

Returns:int

maxMemoryPerTable value

See Also
OptimizerFactory#getMaxMemoryPerTable
getOptimizerback to summary
public Optimizer getOptimizer(OptimizableList optimizableList, OptimizablePredicateList predList, DataDictionary dDictionary, RequiredRowOrdering requiredRowOrdering, int numTablesInQuery, OptimizerPlan overridingPlan, LanguageConnectionContext lcc) throws StandardException

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.getOptimizer.

Doc from org.apache.derby.iapi.sql.compile.OptimizerFactory.getOptimizer.

Only one optimizer level should exist in the database, however, the connection may have multiple instances of that optimizer at a given time.

Parameters
optimizableList:OptimizableList

The list of Optimizables to optimize.

predList:OptimizablePredicateList

The list of unassigned OptimizablePredicates.

dDictionary:DataDictionary

The DataDictionary to use.

requiredRowOrdering:RequiredRowOrdering

The required ordering of the rows to come out of the optimized result set

numTablesInQuery:int

The number of tables in the current query

overridingPlan:OptimizerPlan

(Optional) A complete plan specified by optimizer overrides. Must have been bound already.

lcc:LanguageConnectionContext

The LanguageConnectionContext RESOLVE - We probably want to pass a subquery list, once we define a new interface for them, so that the Optimizer can out where to attach the subqueries.

Exceptions
StandardException:
Thrown on error
See Also
OptimizerFactory#getOptimizer
getOptimizerImplback to summary
protected Optimizer getOptimizerImpl(OptimizableList optimizableList, OptimizablePredicateList predList, DataDictionary dDictionary, RequiredRowOrdering requiredRowOrdering, int numTablesInQuery, OptimizerPlan overridingPlan, LanguageConnectionContext lcc) throws StandardException
stopback to summary
public void stop()

Implements org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Doc from org.apache.derby.iapi.services.monitor.ModuleControl.stop.

Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.

supportsOptimizerTraceback to summary
public boolean supportsOptimizerTrace()

Implements org.apache.derby.iapi.sql.compile.OptimizerFactory.supportsOptimizerTrace.

Doc from org.apache.derby.iapi.sql.compile.OptimizerFactory.supportsOptimizerTrace.

Return whether or not the optimizer associated with this factory supports optimizer trace.

Returns:boolean

Whether or not the optimizer associated with this factory supports optimizer trace.

See Also
OptimizerFactory#supportsOptimizerTrace