org.apache.tajo.plan.util

Class PlannerUtil

java.lang.Object

org.apache.tajo.plan.util.PlannerUtil

public class PlannerUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlannerUtil.JoinKeyPairFinder
static class	PlannerUtil.LogicalNodeReplaceVisitor
static class	PlannerUtil.RelationFinderVisitor

Field Summary

Fields

Modifier and Type	Field and Description
static AggregationFunctionCallEval[]	EMPTY_AGG_FUNCS
static Column[]	EMPTY_COLUMNS

Constructor Summary

Constructors

Constructor and Description
PlannerUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	applySessionToTableProperties(OverridableConf sessionVars, CatalogProtos.StoreType storeType, KeyValueSet tableProperties)
static void	applySystemDefaultToTableProperties(OverridableConf systemConf, TableMeta meta) This method sets a set of table properties by System default configs.
static String	buildExplainString(LogicalNode node) Generate an explain string of a LogicalNode and its descendant nodes.
static boolean	checkIfDDLPlan(LogicalNode node)
static boolean	checkIfNonFromQuery(LogicalPlan plan) Checks whether the query has 'from clause' or not.
static boolean	checkIfQueryTargetIsVirtualTable(LogicalPlan plan) Checks whether the target of this query is a virtual table or not.
static boolean	checkIfSetSession(LogicalNode node)
static boolean	checkIfSimpleQuery(LogicalPlan plan) Checks whether the query is simple or not.
static <T extends LogicalNode> T	clone(LogicalPlan plan, LogicalNode node)
static SortSpec[]	columnsToSortSpecs(Collection<Column> columns)
static SortSpec[]	columnsToSortSpecs(Column[] columns)
static LogicalNode	deleteNode(LogicalNode parent, LogicalNode tobeRemoved) Delete the logical node from a plan.
static boolean	existsAggregationFunction(Expr expr)
static boolean	existsDistinctAggregationFunction(Expr expr)
static LogicalNode[]	findAllNodes(LogicalNode node, NodeType... type) Find the all logical node matched to type from the given node
static <T extends LogicalNode> T	findMostBottomNode(LogicalNode node, NodeType type) Find the most bottom logical node matched to type from the given node
static <T extends LogicalNode> T	findTopNode(LogicalNode node, NodeType type) Find the top logical node matched to type from the given node
static <T extends LogicalNode> T	findTopParentNode(LogicalNode node, NodeType type) Find a parent node of a given-typed operator.
static List<Column[]>	getJoinKeyPairs(EvalNode joinQual, Schema leftSchema, Schema rightSchema, boolean includeThetaJoin)
static String[]	getRelationLineage(LogicalNode from) Get all RelationNodes which are descendant of a given LogicalNode.
static Collection<String>	getRelationLineageWithinQueryBlock(LogicalPlan plan, LogicalNode from) Get all RelationNodes which are descendant of a given LogicalNode.
static SortSpec[][]	getSortKeysFromJoinQual(EvalNode joinQual, Schema outer, Schema inner)
static String	getStoreTableName(LogicalPlan plan)
static CatalogProtos.StoreType	getStoreType(LogicalPlan plan)
static TableDesc	getTableDesc(CatalogService catalog, LogicalNode node)
static boolean	isCommutativeJoin(JoinType joinType)
static boolean	isFileStorageType(CatalogProtos.StoreType storageType)
static boolean	isFileStorageType(String storageType)
static Column[][]	joinJoinKeyForEachTable(EvalNode joinQual, Schema leftSchema, Schema rightSchema, boolean includeThetaJoin)
static void	replaceNode(LogicalNode plan, LogicalNode newNode, NodeType type)
static void	replaceNode(LogicalPlan plan, LogicalNode startNode, LogicalNode oldNode, LogicalNode newNode)
static SortSpec[]	schemaToSortSpecs(Schema schema)
static Target[]	schemaToTargets(Schema schema)
static void	schemaToTargets(Schema schema, Target[] targets) fill targets with FieldEvals from a given schema
static Target[]	schemaToTargetsWithGeneratedFields(Schema schema)
static Schema	sortSpecsToSchema(SortSpec[] sortSpecs)
static Target[]	stripTarget(Target[] sourceTargets) It removes all table names from FieldEvals in targets
static Schema	targetToSchema(Collection<Target> targets)
static Schema	targetToSchema(Target[] targets)
static Collection<String>	toQualifiedFieldNames(Collection<String> fieldNames, String qualifier)

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_COLUMNS

public static final Column[] EMPTY_COLUMNS

EMPTY_AGG_FUNCS

public static final AggregationFunctionCallEval[] EMPTY_AGG_FUNCS

Constructor Detail

PlannerUtil

public PlannerUtil()

Method Detail

checkIfSetSession

public static boolean checkIfSetSession(LogicalNode node)

checkIfDDLPlan

public static boolean checkIfDDLPlan(LogicalNode node)

checkIfSimpleQuery

public static boolean checkIfSimpleQuery(LogicalPlan plan)

Checks whether the query is simple or not. The simple query can be defined as 'select * from tb_name [LIMIT X]'.

Parameters:

plan - The logical plan

Returns:

True if the query is a simple query.

checkIfQueryTargetIsVirtualTable

public static boolean checkIfQueryTargetIsVirtualTable(LogicalPlan plan)

Checks whether the target of this query is a virtual table or not. It will be removed after tajo storage supports catalog service access.

checkIfNonFromQuery

public static boolean checkIfNonFromQuery(LogicalPlan plan)

Checks whether the query has 'from clause' or not.

Parameters:

plan - The logical plan

Returns:

True if a query does not have 'from clause'.

getRelationLineage

public static String[] getRelationLineage(LogicalNode from)

Get all RelationNodes which are descendant of a given LogicalNode.

Parameters:

from - The LogicalNode to start visiting LogicalNodes.

Returns:

an array of all descendant RelationNode of LogicalNode.

getRelationLineageWithinQueryBlock

public static Collection<String> getRelationLineageWithinQueryBlock(LogicalPlan plan,
                                                    LogicalNode from)
                                                             throws PlanningException

Get all RelationNodes which are descendant of a given LogicalNode. The finding is restricted within a query block.

Parameters:

from - The LogicalNode to start visiting LogicalNodes.

Returns:

an array of all descendant RelationNode of LogicalNode.

Throws:

PlanningException

deleteNode

public static LogicalNode deleteNode(LogicalNode parent,
                     LogicalNode tobeRemoved)

Delete the logical node from a plan.

Parameters:

parent - this node must be a parent node of one node to be removed.

tobeRemoved - this node must be a child node of the parent.

replaceNode

public static void replaceNode(LogicalPlan plan,
               LogicalNode startNode,
               LogicalNode oldNode,
               LogicalNode newNode)

replaceNode

public static void replaceNode(LogicalNode plan,
               LogicalNode newNode,
               NodeType type)

findTopNode

public static <T extends LogicalNode> T findTopNode(LogicalNode node,
                                    NodeType type)

Find the top logical node matched to type from the given node

Parameters:

node - start node

type - to find

Returns:

a found logical node

findMostBottomNode

public static <T extends LogicalNode> T findMostBottomNode(LogicalNode node,
                                           NodeType type)

Find the most bottom logical node matched to type from the given node

Parameters:

node - start node

type - to find

Returns:

a found logical node

findAllNodes

public static LogicalNode[] findAllNodes(LogicalNode node,
                         NodeType... type)

Find the all logical node matched to type from the given node

Parameters:

node - start node

type - to find

Returns:

a found logical node

findTopParentNode

public static <T extends LogicalNode> T findTopParentNode(LogicalNode node,
                                          NodeType type)

Find a parent node of a given-typed operator.

Parameters:

node - start node

type - to find

Returns:

the parent node of a found logical node

schemaToTargets

public static void schemaToTargets(Schema schema,
                   Target[] targets)

fill targets with FieldEvals from a given schema

Parameters:

schema - to be transformed to targets

targets - to be filled

schemaToTargets

public static Target[] schemaToTargets(Schema schema)

schemaToTargetsWithGeneratedFields

public static Target[] schemaToTargetsWithGeneratedFields(Schema schema)

schemaToSortSpecs

public static SortSpec[] schemaToSortSpecs(Schema schema)

columnsToSortSpecs

public static SortSpec[] columnsToSortSpecs(Column[] columns)

columnsToSortSpecs

public static SortSpec[] columnsToSortSpecs(Collection<Column> columns)

sortSpecsToSchema

public static Schema sortSpecsToSchema(SortSpec[] sortSpecs)

getSortKeysFromJoinQual

public static SortSpec[][] getSortKeysFromJoinQual(EvalNode joinQual,
                                   Schema outer,
                                   Schema inner)

joinJoinKeyForEachTable

public static Column[][] joinJoinKeyForEachTable(EvalNode joinQual,
                                 Schema leftSchema,
                                 Schema rightSchema,
                                 boolean includeThetaJoin)

Returns:

the first array contains left table's columns, and the second array contains right table's columns.

getJoinKeyPairs

public static List<Column[]> getJoinKeyPairs(EvalNode joinQual,
                             Schema leftSchema,
                             Schema rightSchema,
                             boolean includeThetaJoin)

targetToSchema

public static Schema targetToSchema(Collection<Target> targets)

targetToSchema

public static Schema targetToSchema(Target[] targets)

stripTarget

public static Target[] stripTarget(Target[] sourceTargets)

It removes all table names from FieldEvals in targets

Parameters:

sourceTargets - The targets to be stripped

Returns:

The stripped targets

clone

public static <T extends LogicalNode> T clone(LogicalPlan plan,
                              LogicalNode node)

isCommutativeJoin

public static boolean isCommutativeJoin(JoinType joinType)

existsAggregationFunction

public static boolean existsAggregationFunction(Expr expr)
                                         throws PlanningException

Throws:

PlanningException

existsDistinctAggregationFunction

public static boolean existsDistinctAggregationFunction(Expr expr)
                                                 throws PlanningException

Throws:

PlanningException

toQualifiedFieldNames

public static Collection<String> toQualifiedFieldNames(Collection<String> fieldNames,
                                       String qualifier)

buildExplainString

public static String buildExplainString(LogicalNode node)

Generate an explain string of a LogicalNode and its descendant nodes.

Parameters:

node - The LogicalNode instance to be started

Returns:

A pretty print explain string

applySessionToTableProperties

public static void applySessionToTableProperties(OverridableConf sessionVars,
                                 CatalogProtos.StoreType storeType,
                                 KeyValueSet tableProperties)

applySystemDefaultToTableProperties

public static void applySystemDefaultToTableProperties(OverridableConf systemConf,
                                       TableMeta meta)

This method sets a set of table properties by System default configs. These properties are implicitly used to read or write rows in Table. Don't use this method for TableMeta to be stored in Catalog.

Parameters:

systemConf - System configuration

meta - TableMeta to be set

isFileStorageType

public static boolean isFileStorageType(String storageType)

isFileStorageType

public static boolean isFileStorageType(CatalogProtos.StoreType storageType)

getStoreType

public static CatalogProtos.StoreType getStoreType(LogicalPlan plan)

getStoreTableName

public static String getStoreTableName(LogicalPlan plan)

getTableDesc

public static TableDesc getTableDesc(CatalogService catalog,
                     LogicalNode node)
                              throws IOException

Throws:

IOException