abstract class Optimizer extends RuleExecutor[LogicalPlan] with SQLConfHelper
Abstract class all optimizers should inherit of, contains the standard batches (extending Optimizers can override this.
- Alphabetic
- By Inheritance
- Optimizer
- SQLConfHelper
- RuleExecutor
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Optimizer(catalogManager: CatalogManager)
Type Members
- implicit class LogStringContext extends AnyRef
- Definition Classes
- Logging
- case class Batch(name: String, strategy: Strategy, rules: Rule[TreeType]*) extends Product with Serializable
A batch of rules.
A batch of rules.
- Attributes
- protected[catalyst]
- Definition Classes
- RuleExecutor
- case class FixedPoint(maxIterations: Int, errorOnExceed: Boolean = false, maxIterationsSetting: String = null) extends Strategy with Product with Serializable
A strategy that runs until fix point or maxIterations times, whichever comes first.
A strategy that runs until fix point or maxIterations times, whichever comes first. Especially, a FixedPoint(1) batch is supposed to run only once.
- Definition Classes
- RuleExecutor
- abstract class Strategy extends AnyRef
An execution strategy for rules that indicates the maximum number of executions.
An execution strategy for rules that indicates the maximum number of executions. If the execution reaches fix point (i.e. converge) before maxIterations, it will stop.
- Definition Classes
- RuleExecutor
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def batches: Seq[Batch]
Returns (defaultBatches - (excludedRules - nonExcludableRules)), the rule batches that eventually run in the Optimizer.
Returns (defaultBatches - (excludedRules - nonExcludableRules)), the rule batches that eventually run in the Optimizer.
Implementations of this class should override defaultBatches, and nonExcludableRules if necessary, instead of this method.
- Definition Classes
- Optimizer → RuleExecutor
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def conf: SQLConf
The active config object within the current scope.
The active config object within the current scope. See SQLConf.get for more information.
- Definition Classes
- SQLConfHelper
- def defaultBatches: Seq[Batch]
Defines the default rule batches in the Optimizer.
Defines the default rule batches in the Optimizer.
Implementations of this class should override this method, and nonExcludableRules if necessary, instead of batches. The rule batches that eventually run in the Optimizer, i.e., returned by batches, will be (defaultBatches - (excludedRules - nonExcludableRules)).
- def earlyScanPushDownRules: Seq[Rule[LogicalPlan]]
Override to provide additional rules for early projection and filter pushdown to scans.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val excludedOnceBatches: Set[String]
- Attributes
- protected
- Definition Classes
- Optimizer → RuleExecutor
- def execute(plan: LogicalPlan): LogicalPlan
Executes the batches of rules defined by the subclass.
Executes the batches of rules defined by the subclass. The batches are executed serially using the defined execution strategy. Within each batch, rules are also executed serially.
- Definition Classes
- RuleExecutor
- def executeAndTrack(plan: LogicalPlan, tracker: QueryPlanningTracker): LogicalPlan
Executes the batches of rules defined by the subclass, and also tracks timing info for each rule using the provided tracker.
Executes the batches of rules defined by the subclass, and also tracks timing info for each rule using the provided tracker.
- Definition Classes
- RuleExecutor
- See also
- def extendedOperatorOptimizationRules: Seq[Rule[LogicalPlan]]
Override to provide additional rules for the operator optimization batch.
- def fixedPoint: FixedPoint
- Attributes
- protected
- def flattenBatches(nestedBatchSequence: Seq[Any]): Seq[Batch]
A helper method that takes as input a Seq of Batch or Seq[Batch], and flattens it out.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def initializeLogIfNecessary(isInterpreter: Boolean): Unit
- Attributes
- protected
- Definition Classes
- Logging
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isTraceEnabled(): Boolean
- Attributes
- protected
- Definition Classes
- Logging
- def log: Logger
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logDebug(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logError(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logInfo(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logName: String
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logTrace(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(msg: => String, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(entry: LogEntry, throwable: Throwable): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(entry: LogEntry): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def logWarning(msg: => String): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def name: String
Name for this rule executor, automatically inferred based on class name.
Name for this rule executor, automatically inferred based on class name.
- Attributes
- protected
- Definition Classes
- RuleExecutor
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nonExcludableRules: Seq[String]
Defines rules that cannot be excluded from the Optimizer even if they are specified in SQL config "excludedRules".
Defines rules that cannot be excluded from the Optimizer even if they are specified in SQL config "excludedRules".
Implementations of this class can override this method if necessary. The rule batches that eventually run in the Optimizer, i.e., returned by batches, will be (defaultBatches - (excludedRules - nonExcludableRules)).
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def preCBORules: Seq[Rule[LogicalPlan]]
Override to provide additional rules for rewriting plans after operator optimization rules and before any cost-based optimization rules that depend on stats.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def validatePlanChanges(previousPlan: LogicalPlan, currentPlan: LogicalPlan): Option[String]
Defines a validate function that validates the plan changes after the execution of each rule, to make sure these rules make valid changes to the plan.
Defines a validate function that validates the plan changes after the execution of each rule, to make sure these rules make valid changes to the plan. For example, we can check whether a plan is still resolved after each rule in
Optimizer, so that we can catch rules that turn the plan into unresolved.- Attributes
- protected
- Definition Classes
- Optimizer → RuleExecutor
- def validatePlanChangesLightweight(previousPlan: LogicalPlan, currentPlan: LogicalPlan): Option[String]
Defines a validate function that validates the plan changes after the execution of each rule, to make sure these rules make valid changes to the plan.
Defines a validate function that validates the plan changes after the execution of each rule, to make sure these rules make valid changes to the plan. Since this is enabled by default, this should only consist of very lightweight checks.
- Attributes
- protected
- Definition Classes
- Optimizer → RuleExecutor
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withLogContext(context: Map[String, String])(body: => Unit): Unit
- Attributes
- protected
- Definition Classes
- Logging
- def withSQLConf[T](pairs: (String, String)*)(f: => T): T
Sets all SQL configurations specified in
pairs, callsf, and then restores all SQL configurations.Sets all SQL configurations specified in
pairs, callsf, and then restores all SQL configurations.- Attributes
- protected
- Definition Classes
- SQLConfHelper
- object FinishAnalysis extends Rule[LogicalPlan]
Apply finish-analysis rules for the entire plan including all subqueries.
- object OptimizeSubqueries extends Rule[LogicalPlan]
Optimize all the subqueries inside expression.
- object UpdateCTERelationStats extends Rule[LogicalPlan]
Update CTE reference stats.
- case object Once extends Strategy with Product with Serializable
A strategy that is run once and idempotent.
A strategy that is run once and idempotent.
- Definition Classes
- RuleExecutor
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)