org.apache.tajo.plan

Class LogicalPlanner

java.lang.Object

org.apache.tajo.plan.algebra.BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

org.apache.tajo.plan.LogicalPlanner

All Implemented Interfaces:

AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

public class LogicalPlanner
extends BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

This class creates a logical plan from a nested tajo algebra expression (org.apache.tajo.algebra)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogicalPlanner.PlanContext

Constructor Summary

Constructors

Constructor and Description
LogicalPlanner(CatalogService catalog)

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	checkIfBeEvaluatedAtGroupBy(EvalNode evalNode, GroupbyNode node)
static boolean	checkIfBeEvaluatedAtJoin(LogicalPlan.QueryBlock block, EvalNode evalNode, JoinNode node, boolean isTopMostJoin)
static boolean	checkIfBeEvaluatedAtRelation(LogicalPlan.QueryBlock block, EvalNode evalNode, RelationNode node) It checks if evalNode can be evaluated at this @{link RelationNode}.
static boolean	checkIfBeEvaluatedAtThis(EvalNode evalNode, LogicalNode node)
static boolean	checkIfBeEvaluatedAtWindowAgg(EvalNode evalNode, WindowAggNode node)
static boolean	containsOuterJoin(LogicalPlan.QueryBlock block)
static TajoDataTypes.DataType	convertDataType(DataTypeExpr dataType)
LogicalPlan	createPlan(OverridableConf context, Expr expr) This generates a logical plan.
LogicalPlan	createPlan(OverridableConf queryContext, Expr expr, boolean debug)
static List<Column[]>	generateCuboids(Column[] columns)
ExprAnnotator	getExprAnnotator()
LogicalNode	handleCreateTableLike(LogicalPlanner.PlanContext context, CreateTable expr, CreateTableNode createTableNode)
static boolean	isOuterJoin(JoinType joinType)
List<Integer>	normalize(LogicalPlanner.PlanContext context, Projection projection, ExprNormalizer.ExprNormalizedResult[] normalizedExprList, org.apache.tajo.plan.LogicalPlanner.Matcher matcher)
LogicalNode	postHook(LogicalPlanner.PlanContext context, Stack<Expr> stack, Expr expr, LogicalNode current) The posthook is called before each expression is visited.
void	preHook(LogicalPlanner.PlanContext context, Stack<Expr> stack, Expr expr) The prehook is called before each expression is visited.
static void	throwCannotEvaluateException(Projectable projectable, String columnName)
static void	verifyIfColumnCanBeEvaluated(Schema baseSchema, Projectable projectable, Column[] columns)
static void	verifyIfEvalNodesCanBeEvaluated(Projectable projectable, EvalNode[] evalNodes)
static void	verifyIfTargetsCanBeEvaluated(Schema baseSchema, Projectable projectable)
static void	verifyProjectedFields(LogicalPlan.QueryBlock block, Projectable projectable) It checks if all targets of Projectable plan node can be evaluated from the child node.
LogicalNode	visitAlterTable(LogicalPlanner.PlanContext context, Stack<Expr> stack, AlterTable alterTable)
LogicalNode	visitAlterTablespace(LogicalPlanner.PlanContext context, Stack<Expr> stack, AlterTablespace alterTablespace)
LogicalNode	visitCreateDatabase(LogicalPlanner.PlanContext context, Stack<Expr> stack, CreateDatabase expr)
LogicalNode	visitCreateTable(LogicalPlanner.PlanContext context, Stack<Expr> stack, CreateTable expr)
LogicalNode	visitDropDatabase(LogicalPlanner.PlanContext context, Stack<Expr> stack, DropDatabase expr)
LogicalNode	visitDropTable(LogicalPlanner.PlanContext context, Stack<Expr> stack, DropTable dropTable)
LogicalNode	visitExcept(LogicalPlanner.PlanContext context, Stack<Expr> stack, SetOperation setOperation)
LogicalNode	visitExplain(LogicalPlanner.PlanContext ctx, Stack<Expr> stack, Explain expr)
SelectionNode	visitFilter(LogicalPlanner.PlanContext context, Stack<Expr> stack, Selection selection)
LogicalNode	visitGroupBy(LogicalPlanner.PlanContext context, Stack<Expr> stack, Aggregation aggregation)
LogicalNode	visitHaving(LogicalPlanner.PlanContext context, Stack<Expr> stack, Having expr)
LogicalNode	visitInsert(LogicalPlanner.PlanContext context, Stack<Expr> stack, Insert expr)
LogicalNode	visitIntersect(LogicalPlanner.PlanContext context, Stack<Expr> stack, SetOperation setOperation)
LogicalNode	visitJoin(LogicalPlanner.PlanContext context, Stack<Expr> stack, Join join)
LimitNode	visitLimit(LogicalPlanner.PlanContext context, Stack<Expr> stack, Limit limit)
LogicalNode	visitProjection(LogicalPlanner.PlanContext context, Stack<Expr> stack, Projection projection)
ScanNode	visitRelation(LogicalPlanner.PlanContext context, Stack<Expr> stack, Relation expr)
LogicalNode	visitRelationList(LogicalPlanner.PlanContext context, Stack<Expr> stack, RelationList relations)
LogicalNode	visitSetSession(LogicalPlanner.PlanContext context, Stack<Expr> stack, SetSession expr)
LogicalNode	visitSort(LogicalPlanner.PlanContext context, Stack<Expr> stack, Sort sort)
TableSubQueryNode	visitTableSubQuery(LogicalPlanner.PlanContext context, Stack<Expr> stack, TablePrimarySubQuery expr)
LogicalNode	visitTruncateTable(LogicalPlanner.PlanContext context, Stack<Expr> stack, TruncateTable truncateTable)
LogicalNode	visitUnion(LogicalPlanner.PlanContext context, Stack<Expr> stack, SetOperation setOperation)

Methods inherited from class org.apache.tajo.plan.algebra.BaseAlgebraVisitor

visit, visitAnd, visitBetween, visitCaseWhen, visitCastExpr, visitColumnReference, visitConcatenate, visitCountRowsFunction, visitDataType, visitDateLiteral, visitDivide, visitEquals, visitExistsPredicate, visitFunction, visitGeneralSetFunction, visitGreaterThan, visitGreaterThanOrEquals, visitInPredicate, visitIntervalLiteral, visitIsNullPredicate, visitLessThan, visitLessThanOrEquals, visitLikePredicate, visitLiteral, visitMinus, visitModular, visitMultiply, visitNot, visitNotEquals, visitNullLiteral, visitOr, visitPlus, visitQualifiedAsterisk, visitRegexpPredicate, visitScalarSubQuery, visitSign, visitSimilarToPredicate, visitSimpleTableSubQuery, visitTargetExpr, visitTimeLiteral, visitTimestampLiteral, visitValueListExpr, visitWindowFunction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogicalPlanner

public LogicalPlanner(CatalogService catalog)

Method Detail

createPlan

public LogicalPlan createPlan(OverridableConf context,
                     Expr expr)
                       throws PlanningException

This generates a logical plan.

Parameters:

expr - A relational algebraic expression for a query.

Returns:

A logical plan

Throws:

PlanningException

createPlan

public LogicalPlan createPlan(OverridableConf queryContext,
                     Expr expr,
                     boolean debug)
                       throws PlanningException

Throws:

PlanningException

getExprAnnotator

public ExprAnnotator getExprAnnotator()

preHook

public void preHook(LogicalPlanner.PlanContext context,
           Stack<Expr> stack,
           Expr expr)
             throws PlanningException

Description copied from class: BaseAlgebraVisitor

The prehook is called before each expression is visited.

Overrides:

preHook in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

postHook

public LogicalNode postHook(LogicalPlanner.PlanContext context,
                   Stack<Expr> stack,
                   Expr expr,
                   LogicalNode current)
                     throws PlanningException

Description copied from class: BaseAlgebraVisitor

The posthook is called before each expression is visited.

Overrides:

postHook in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitSetSession

public LogicalNode visitSetSession(LogicalPlanner.PlanContext context,
                          Stack<Expr> stack,
                          SetSession expr)
                            throws PlanningException

Specified by:

visitSetSession in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitSetSession in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitExplain

public LogicalNode visitExplain(LogicalPlanner.PlanContext ctx,
                       Stack<Expr> stack,
                       Explain expr)
                         throws PlanningException

Specified by:

visitExplain in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitExplain in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitProjection

public LogicalNode visitProjection(LogicalPlanner.PlanContext context,
                          Stack<Expr> stack,
                          Projection projection)
                            throws PlanningException

Specified by:

visitProjection in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitProjection in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

normalize

public List<Integer> normalize(LogicalPlanner.PlanContext context,
                      Projection projection,
                      ExprNormalizer.ExprNormalizedResult[] normalizedExprList,
                      org.apache.tajo.plan.LogicalPlanner.Matcher matcher)
                        throws PlanningException

Throws:

PlanningException

verifyProjectedFields

public static void verifyProjectedFields(LogicalPlan.QueryBlock block,
                         Projectable projectable)
                                  throws PlanningException

It checks if all targets of Projectable plan node can be evaluated from the child node. It can avoid potential errors which possibly occur in physical operators.

Parameters:

block - QueryBlock which includes the Projectable node

projectable - Projectable node to be valid

Throws:

PlanningException

verifyIfEvalNodesCanBeEvaluated

public static void verifyIfEvalNodesCanBeEvaluated(Projectable projectable,
                                   EvalNode[] evalNodes)
                                            throws PlanningException

Throws:

PlanningException

verifyIfTargetsCanBeEvaluated

public static void verifyIfTargetsCanBeEvaluated(Schema baseSchema,
                                 Projectable projectable)
                                          throws PlanningException

Throws:

PlanningException

verifyIfColumnCanBeEvaluated

public static void verifyIfColumnCanBeEvaluated(Schema baseSchema,
                                Projectable projectable,
                                Column[] columns)
                                         throws PlanningException

Throws:

PlanningException

throwCannotEvaluateException

public static void throwCannotEvaluateException(Projectable projectable,
                                String columnName)
                                         throws PlanningException

Throws:

PlanningException

visitLimit

public LimitNode visitLimit(LogicalPlanner.PlanContext context,
                   Stack<Expr> stack,
                   Limit limit)
                     throws PlanningException

Specified by:

visitLimit in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitLimit in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitSort

public LogicalNode visitSort(LogicalPlanner.PlanContext context,
                    Stack<Expr> stack,
                    Sort sort)
                      throws PlanningException

Specified by:

visitSort in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitSort in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitHaving

public LogicalNode visitHaving(LogicalPlanner.PlanContext context,
                      Stack<Expr> stack,
                      Having expr)
                        throws PlanningException

Specified by:

visitHaving in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitHaving in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitGroupBy

public LogicalNode visitGroupBy(LogicalPlanner.PlanContext context,
                       Stack<Expr> stack,
                       Aggregation aggregation)
                         throws PlanningException

Specified by:

visitGroupBy in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitGroupBy in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

generateCuboids

public static List<Column[]> generateCuboids(Column[] columns)

visitFilter

public SelectionNode visitFilter(LogicalPlanner.PlanContext context,
                        Stack<Expr> stack,
                        Selection selection)
                          throws PlanningException

Specified by:

visitFilter in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitFilter in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitJoin

public LogicalNode visitJoin(LogicalPlanner.PlanContext context,
                    Stack<Expr> stack,
                    Join join)
                      throws PlanningException

Specified by:

visitJoin in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitJoin in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitRelationList

public LogicalNode visitRelationList(LogicalPlanner.PlanContext context,
                            Stack<Expr> stack,
                            RelationList relations)
                              throws PlanningException

Specified by:

visitRelationList in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitRelationList in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitRelation

public ScanNode visitRelation(LogicalPlanner.PlanContext context,
                     Stack<Expr> stack,
                     Relation expr)
                       throws PlanningException

Specified by:

visitRelation in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitRelation in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitTableSubQuery

public TableSubQueryNode visitTableSubQuery(LogicalPlanner.PlanContext context,
                                   Stack<Expr> stack,
                                   TablePrimarySubQuery expr)
                                     throws PlanningException

Specified by:

visitTableSubQuery in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitTableSubQuery in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitUnion

public LogicalNode visitUnion(LogicalPlanner.PlanContext context,
                     Stack<Expr> stack,
                     SetOperation setOperation)
                       throws PlanningException

Specified by:

visitUnion in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitUnion in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitExcept

public LogicalNode visitExcept(LogicalPlanner.PlanContext context,
                      Stack<Expr> stack,
                      SetOperation setOperation)
                        throws PlanningException

Specified by:

visitExcept in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitExcept in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitIntersect

public LogicalNode visitIntersect(LogicalPlanner.PlanContext context,
                         Stack<Expr> stack,
                         SetOperation setOperation)
                           throws PlanningException

Specified by:

visitIntersect in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitIntersect in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitInsert

public LogicalNode visitInsert(LogicalPlanner.PlanContext context,
                      Stack<Expr> stack,
                      Insert expr)
                        throws PlanningException

Specified by:

visitInsert in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitInsert in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitCreateDatabase

public LogicalNode visitCreateDatabase(LogicalPlanner.PlanContext context,
                              Stack<Expr> stack,
                              CreateDatabase expr)
                                throws PlanningException

Specified by:

visitCreateDatabase in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitCreateDatabase in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

visitDropDatabase

public LogicalNode visitDropDatabase(LogicalPlanner.PlanContext context,
                            Stack<Expr> stack,
                            DropDatabase expr)
                              throws PlanningException

Specified by:

visitDropDatabase in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitDropDatabase in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

handleCreateTableLike

public LogicalNode handleCreateTableLike(LogicalPlanner.PlanContext context,
                                CreateTable expr,
                                CreateTableNode createTableNode)
                                  throws PlanningException

Throws:

PlanningException

visitCreateTable

public LogicalNode visitCreateTable(LogicalPlanner.PlanContext context,
                           Stack<Expr> stack,
                           CreateTable expr)
                             throws PlanningException

Specified by:

visitCreateTable in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitCreateTable in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

convertDataType

public static TajoDataTypes.DataType convertDataType(DataTypeExpr dataType)

visitDropTable

public LogicalNode visitDropTable(LogicalPlanner.PlanContext context,
                         Stack<Expr> stack,
                         DropTable dropTable)

Specified by:

visitDropTable in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitDropTable in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

visitAlterTablespace

public LogicalNode visitAlterTablespace(LogicalPlanner.PlanContext context,
                               Stack<Expr> stack,
                               AlterTablespace alterTablespace)

Specified by:

visitAlterTablespace in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitAlterTablespace in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

visitAlterTable

public LogicalNode visitAlterTable(LogicalPlanner.PlanContext context,
                          Stack<Expr> stack,
                          AlterTable alterTable)

Specified by:

visitAlterTable in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitAlterTable in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

visitTruncateTable

public LogicalNode visitTruncateTable(LogicalPlanner.PlanContext context,
                             Stack<Expr> stack,
                             TruncateTable truncateTable)
                               throws PlanningException

Specified by:

visitTruncateTable in interface AlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Overrides:

visitTruncateTable in class BaseAlgebraVisitor<LogicalPlanner.PlanContext,LogicalNode>

Throws:

PlanningException

checkIfBeEvaluatedAtWindowAgg

public static boolean checkIfBeEvaluatedAtWindowAgg(EvalNode evalNode,
                                    WindowAggNode node)

checkIfBeEvaluatedAtGroupBy

public static boolean checkIfBeEvaluatedAtGroupBy(EvalNode evalNode,
                                  GroupbyNode node)

checkIfBeEvaluatedAtJoin

public static boolean checkIfBeEvaluatedAtJoin(LogicalPlan.QueryBlock block,
                               EvalNode evalNode,
                               JoinNode node,
                               boolean isTopMostJoin)

isOuterJoin

public static boolean isOuterJoin(JoinType joinType)

containsOuterJoin

public static boolean containsOuterJoin(LogicalPlan.QueryBlock block)

checkIfBeEvaluatedAtRelation

public static boolean checkIfBeEvaluatedAtRelation(LogicalPlan.QueryBlock block,
                                   EvalNode evalNode,
                                   RelationNode node)

It checks if evalNode can be evaluated at this @{link RelationNode}.

checkIfBeEvaluatedAtThis

public static boolean checkIfBeEvaluatedAtThis(EvalNode evalNode,
                               LogicalNode node)