When integrating information using a federated query planner it is useful to view the query plans to better understand how information is being accessed and processed, and to troubleshoot problems.

A query plan is a set of instructions created by a query engine for executing a command submitted by a user or application. The purpose of the query plan is to execute the user's query in as efficient a way as possible.

Getting a Query Plan

You can get a query plan any time you execute a command. The SQL options available are as follows:

SET SHOWPLAN [ON|DEBUG]- Returns the processing plan or the plan and the full planner debug log. See also the SET Statement.

With the above options, the query plan is available from the Statement object by casting to the org.teiid.jdbc.TeiidStatement interface or by using the "SHOW PLAN" statement.

statement.execute("set showplan on");
ResultSet rs = statement.executeQuery("select ...");
TeiidStatement tstatement = statement.unwrap(TeiidStatement.class);
PlanNode queryPlan = tstatement.getPlanDescription();
System.out.println(queryPlan);

The query plan is made available automatically in several of Teiid's tools.

Analyzing a Query Plan

Once a query plan has been obtained you will most commonly be looking for:

• Source pushdown -- what parts of the query that got pushed to each source
  • Ensure that any predicates especially against indexes are pushed

• Joins - as federated joins can be quite expensive
  • Join ordering - typically influenced by costing
  • Join criteria type mismatches.
  • Join algorithm used - merge, enhanced merge, nested loop, etc.

• Presence of federated optimizations, such as dependent joins.

• Ensure hints have the desired affects - see Hints and Options, hints in the FROM Clause, Subquery Optimization, and Federated Optimizations.

All of the above information can be determined from the processing plan. You will typically be interested in analyzing the textual form of the final processing plan. To understand why particular decisions are made for debugging or support you will want to obtain the full debug log which will contain the intermediate planning steps as well as annotations as to why specific pushdown decisions are made.

A query plan consists of a set of nodes organized in a tree structure. If you are executing a procedure or generating an XML document from an XML Document Model, the overall query plan will contain additional information related the surrounding procedural execution.

In a procedural context the ordering of child nodes implies the order of execution. In most other situation, child nodes may be executed in any order even in parallel. Only in specific optimizations, such as dependent join, will the children of a join execute serially.

Relational Execution Plans

Relational plans represent the processing plan that is composed of nodes representing building blocks of logical relational operations. Relational processing plans differ from logical debug relational plans in that they will contain additional operations and execution specifics that were chosen by the optimizer.

The nodes for a relational query plan are:

• Access - Access a source. A source query is sent to the connection factory associated with the source. [For a dependent join, this node is called Dependent Access.]

• Dependent Procedure Access - Access a stored procedure on a source using multiple sets of input values.

• Batched Update - Processes a set of updates as a batch.

• Project - Defines the columns returned from the node. This does not alter the number of records returned.

• Project Into - Like a normal project, but outputs rows into a target table.

• Insert Plan Execution - Similar to a project into, but executes a plan rather than a source query. Typically created when executing an insert into view with a query expression.

• Window Function Project - Like a normal project, but includes window functions.

• Select - Select is a criteria evaluation filter node (WHERE / HAVING).

• Join - Defines the join type, join criteria, and join strategy (merge or nested loop).

• Union All - There are no properties for this node, it just passes rows through from it's children. Depending upon other factors, such as if there is a transaction or the source query concurrency allowed, not all of the union children will execute in parallel.

• Sort - Defines the columns to sort on, the sort direction for each column, and whether to remove duplicates or not.

• Dup Remove - Removes duplicate rows. The processing uses a tree structure to detect duplicates so that results will effectively stream at the cost of IO operations.

• Grouping - Groups sets of rows into groups and evaluates aggregate functions.

• Null - A node that produces no rows. Usually replaces a Select node where the criteria is always false (and whatever tree is underneath). There are no properties for this node.

• Plan Execution - Executes another sub plan. Typically the sub plan will be a non-relational plan.

• Dependent Procedure Execution - Executes a sub plan using multiple sets of input values.

• Limit - Returns a specified number of rows, then stops processing. Also processes an offset if present.

• XML Table - Evaluates XMLTABLE. The debug plan will contain more information about the XQuery/XPath with regards to their optimization - see the XQuery section below or XQuery Optimization.

• Text Table - Evaluates TEXTTABLE

• Array Table - Evaluates ARRAYTABLE

• Object Table - Evaluates OBJECTTABLE

Node Statistics

Every node has a set of statistics that are output. These can be used to determine the amount of data flowing through the node. Before execution a processor plan will not contain node statistics. Also the statistics are updated as the plan is processed, so typically you'll want the final statistics after all rows have been processed by the client.

In addition to node statistics, some nodes display cost estimates computed at the node.

The root node will display additional information.

Reading a Processor Plan

ProjectNode(0) output=[pm1.g1.e1, pm1.g2.e2, pm1.g3.e3] [pm1.g1.e1, pm1.g2.e2, pm1.g3.e3]
  JoinNode(1) [ENHANCED SORT JOIN (SORT/ALREADY_SORTED)] [INNER JOIN] criteria=[pm1.g3.e1=pm1.g2.e1] output=[pm1.g1.e1, pm1.g2.e2, pm1.g3.e3]
    JoinNode(2) [MERGE JOIN (ALREADY_SORTED/ALREADY_SORTED)] [INNER JOIN] criteria=[pm1.g1.e1=pm1.g3.e1] output=[pm1.g3.e1, pm1.g1.e1, pm1.g3.e3]
      AccessNode(3) output=[pm1.g1.e1] SELECT g_0.e1 AS c_0 FROM pm1.g1 AS g_0 ORDER BY c_0
      AccessNode(4) output=[pm1.g3.e1, pm1.g3.e3] SELECT g_0.e1 AS c_0, g_0.e3 AS c_1 FROM pm1.g3 AS g_0 ORDER BY c_0
    AccessNode(5) output=[pm1.g2.e1, pm1.g2.e2] SELECT g_0.e1 AS c_0, g_0.e2 AS c_1 FROM pm1.g2 AS g_0 ORDER BY c_0

Other Plans

XML document model queries and proecedure execution (including instead of triggers) use intermediate and final plan forms that include relational plans. Generally the structure of the xml/procedure plans will closely match their logical forms. It's the nested relational plans that will be of interest when analyzing performance issues.

Debug Plans

A relational processing plan is created by the optimizer after the logical plan is manipulated by a series of rules. The application of rules is determined both by the query structure and by the rules themselves. The node structure of the debug plan resembles that of the processing plan, but the node types more logically represent SQL operations.

All Nodes

• ACCESS - a source access or plan execution.
• DUP_REMOVE - removes duplicate rows
• JOIN - a join (LEFT OUTER, FULL OUTER, INNER, CROSS, SEMI, etc.)
• PROJECT - a projection of tuple values
• SELECT - a filtering of tuples
• SORT - an ordering operation, which may be inserted to process other operations such as joins
• SOURCE - any logical source of tuples including an inline view, a source access, XMLTABLE, etc.
• GROUP - a grouping operation
• SET_OP - a set operation (UNION/INTERSECT/EXCEPT)
• NULL - a source of no tuples
• TUPLE_LIMIT - row offset / limit

User SQL statements after rewrite are converted into a cannonical plan form. The connonical plan form most closely resembles the initial SQL structure. For example, a SQL statement such as SELECT max(pm1.g1.e1) FROM pm1.g1 WHERE e2 = 1 creates a logical plan:

Project(groups=[anon_grp0], props={PROJECT_COLS=[anon_grp0.agg0 AS expr1]})
  Group(groups=[anon_grp0], props={SYMBOL_MAP={anon_grp0.agg0=MAX(pm1.g1.e1)}})
    Select(groups=[pm1.g1], props={SELECT_CRITERIA=e2 = 1})
      Source(groups=[pm1.g1])

Here the Source corresponds to the FROM clause, the Select corresponds to the WHERE clause, the Group corresponds to the implied grouping to create the max aggregate, and the Project corresponds to the SELECT clause.

Note that the affect of grouping generates what is effectively an inline view, anon_grp0, to handle the projection of values created by the grouping.

Node Properties

Each node has a set of applicable properties that are typically shown on the node.

• Access Properties
  • ATOMIC_REQUEST - The final form of a source request
  • MODEL_ID - The metadata object for the target model/schema
  • PROCEDURE_CRITERIA/PROCEDURE_INPUTS/PROCEDURE_DEFAULTS - Used in planning procedureal relational queries
  • IS_MULTI_SOURCE - set to true when the node represents a multi-source access
  • SOURCE_NAME - used to track the multi-source source name
  • CONFORMED_SOURCES - tracks the set of conformed sources when the conformed extension metadata is used
  • SUB_PLAN/SUB_PLANS - used in multi-source planning
• SET_OPERATION/USE_ALL - defines the set operation (UNION/INTERSECT/EXCEPT) and if all rows or distinct rows are used.
• Join Properties
  • JOIN_CRITERIA - all join predicates
  • JOIN_TYPE - type of join (INNER, LEFT OUTER, etc.)
  • JOIN_STRATEGY - the algorithm to use (nested loop, merge, etc.)
  • LEFT_EXPRESSIONS - the expressions in equi-join predicates that originate from the left side of the join
  • RIGHT_EXPRESSIONS - the expressions in equi-join predicates that originate from the right side of the join
  • DEPENDENT_VALUE_SOURCE - set if a dependent join is used
  • NON_EQUI_JOIN_CRITERIA - non-equi join predicates
  • SORT_LEFT - if the left side needs sorted for join processing
  • SORT_RIGHT - if the right side needs sorted for join processing
  • IS_OPTIONAL - if the join is optional
  • IS_LEFT_DISTINCT - if the left side is distinct with respect to the equi join predicates
  • IS_RIGHT_DISTINCT - if the right side is distinct with respect to the equi join predicates
  • IS_SEMI_DEP - if the dependent join represents a semi-join
  • PRESERVE - if the preserve hint is preserving the join order
• Project Properties
  • PROJECT_COLS - the expressions projected
  • INTO_GROUP - the group targeted if this is a select into or insert with a query expression
  • HAS_WINDOW_FUNCTIONS - true if window functions are used
  • CONSTRAINT - the constraint that must be met if the values are being projected into a group
• Select Properties
  • SELECT_CRITERIA - the filter
  • IS_HAVING - if the filter is applied after grouping
  • IS_PHANTOM - true if the node is marked for removal, but temporarily left in the plan.
  • IS_TEMPORARY - inferred criteria that may not be used in the final plan
  • IS_COPIED - if the criteria has already been processed by rule copy criteria
  • IS_PUSHED - if the criteria is pushed as far as possible
  • IS_DEPENDENT_SET - if the criteria is the filter of a dependent join
• Sort Properties
  • SORT_ORDER - the order by that defines the sort
  • UNRELATED_SORT - if the ordering includes a value that is not being projected
  • IS_DUP_REMOVAL - if the sort should also perform duplicate removal over the entire projection
• Source Properties - many source properties also become present on associated access nodes
  • SYMBOL_MAP - the mapping from the columns above the source to the projected expressions. Also present on Group nodes
  • PARTITION_INFO - the partitioning of the union branches
  • VIRTUAL_COMMAND - if the source represents an view or inline view, the query that defined the view
  • MAKE_DEP - hint information
  • PROCESSOR_PLAN - the processor plan of a non-relational source (typically from the NESTED_COMMAND)
  • NESTED_COMMAND - the non-relational command
  • TABLE_FUNCTION - the table function (XMLTABLE, OBJECTTABLE, etc.) defining the source
  • CORRELATED_REFERENCES - the correlated references for the nodes below the source
  • MAKE_NOT_DEP - if make not dep is set
  • INLINE_VIEW - If the source node represents an inline view
  • NO_UNNEST - if the no_unnest hint is set
  • MAKE_IND - if the make ind hint is set
  • SOURCE_HINT - the source hint. See Federated Optimizations.
  • ACCESS_PATTERNS - access patterns yet to be satisfied
  • ACCESS_PATTERN_USED - satisfied access patterns
  • REQUIRED_ACCESS_PATTERN_GROUPS - groups needed to satisfy the access patterns. Used in join planning.
• Group Properties
  • GROUP_COLS - the grouping columns
  • ROLLUP - if the grouping includes a rollup
• Tuple Limit Properties
  • MAX_TUPLE_LIMIT - expression that evaluates to the max number of tuples generated
  • OFFSET_TUPLE_COUNT - Expression that evaluates to the tuple offset of the starting tuple
  • IS_IMPLICIT_LIMIT - if the limit is created by the rewriter as part of a subquery optimization
  • IS_NON_STRICT - if the unordered limit should not be enforced strictly
• General and Costing Properties
  • OUTPUT_COLS - the output columns for the node. Is typically set after rule assign output elements.
  • EST_SET_SIZE - represents the estimated set size this node would produce for a sibling node as the independent node in a dependent join scenario
  • EST_DEP_CARDINALITY - value that represents the estimated cardinality (amount of rows) produced by this node as the dependent node in a dependent join scenario
  • EST_DEP_JOIN_COST - value that represents the estimated cost of a dependent join (the join strategy for this could be Nested Loop or Merge)
  • EST_JOIN_COST - value that represents the estimated cost of a merge join (the join strategy for this could be Nested Loop or Merge)
  • EST_CARDINALITY - represents the estimated cardinality (amount of rows) produced by this node
  • EST_COL_STATS - column statistics including number of null values, distinct value count, etc.
  • EST_SELECTIVITY - represents the selectivity of a criteria node

Rules

Plan rule manipulate the plan tree, fire other rules, and drive the optimization process. The structure of the query determines the initial set of rules. Each rule is designed to perform a narrow set of tasks. Some rules can be run multiple times. Some rules require a specific set of precursors to run properly.

• Access Pattern Validation - ensures that all access patterns have been satisfied
• Apply Security - applies row and column level security
• Assign Output Symbol - determines the output of every node and minimizes projection
• Calculate Cost - adds costing information to the plan
• Choose Dependent - choose dependent joins based upon the cost/hints
• Choose Join Strategy - choose the join strategy base upon the cost
• Clean Criteria - removes phantom criteria
• Collapse Source - takes all of the nodes below an access node and creates a SQL query representation
• Copy Criteria - copies criteria based upon join predicates
• Decompose Join - optimizes joins over partitioned unions
• Implement Join Strategy - adds necessary sort and other nodes to process the chosen join strategy
• Merge Criteria - combines select nodes and can convert subqueries to semi-joins
• Merge Virtual - removes view and inline view layers
• Place Access - places access nodes under source nodes
• Plan Joins - determines the best join order
• Plan Procedures - plans procedures that appear in procedural relational queries
• Plan Sorts - optimizations around sorting, such as combining sort operations or moving projection
• Plan Unions - reorders union children for more pushdown
• Plan Aggregates - performs aggregate decomposition over a join or union
• Push Limit - pushes the affect of a limit node further into the plan
• Push Non-Join Criteria - pushes non-equi join conditions out of the on clause when possible
• Push Select Criteria - pushed select nodes as far as possible
• Raise Access - raises access nodes, which increases the work done by source queries
• Raise Null - raises null nodes
• Remove Optional Joins - removes joins that are marked as or determined to be optional
• Substitute Expressions - used only when a function based index is present
• Validate Where All - ensures criteria is used when required by the source

Reading a Debug Plan

As each relational sub plan is optimized, the plan will show what is being optimized and it's canonical form:

OPTIMIZE: 
SELECT e1 FROM (SELECT e1 FROM pm1.g1) AS x

----------------------------------------------------------------------------
GENERATE CANONICAL: 
SELECT e1 FROM (SELECT e1 FROM pm1.g1) AS x

CANONICAL PLAN: 
Project(groups=[x], props={PROJECT_COLS=[e1]})
  Source(groups=[x], props={NESTED_COMMAND=SELECT e1 FROM pm1.g1, SYMBOL_MAP={x.e1=e1}})
    Project(groups=[pm1.g1], props={PROJECT_COLS=[e1]})
      Source(groups=[pm1.g1])

With more complicated user queries, such as a procedure invocation or one containing subqueries, the sub plans may be nested within the overall plan. Each plan ends by showing the final processing plan:

----------------------------------------------------------------------------
OPTIMIZATION COMPLETE:
PROCESSOR PLAN:
AccessNode(0) output=[e1] SELECT g_0.e1 FROM pm1.g1 AS g_0

The affect of rules can be seen by the state of the plan tree before and after the rule fires. For example, the debug log below shows the application of rule merge virtual, which will remove the "x" inline view layer:

EXECUTING AssignOutputElements

AFTER: 
Project(groups=[x], props={PROJECT_COLS=[e1], OUTPUT_COLS=[e1]})
  Source(groups=[x], props={NESTED_COMMAND=SELECT e1 FROM pm1.g1, SYMBOL_MAP={x.e1=e1}, OUTPUT_COLS=[e1]})
    Project(groups=[pm1.g1], props={PROJECT_COLS=[e1], OUTPUT_COLS=[e1]})
      Access(groups=[pm1.g1], props={SOURCE_HINT=null, MODEL_ID=Schema name=pm1, nameInSource=null, uuid=3335, OUTPUT_COLS=[e1]})
        Source(groups=[pm1.g1], props={OUTPUT_COLS=[e1]})


============================================================================
EXECUTING MergeVirtual

AFTER: 
Project(groups=[pm1.g1], props={PROJECT_COLS=[e1], OUTPUT_COLS=[e1]})
  Access(groups=[pm1.g1], props={SOURCE_HINT=null, MODEL_ID=Schema name=pm1, nameInSource=null, uuid=3335, OUTPUT_COLS=[e1]})
    Source(groups=[pm1.g1])

Some important planning decisions are shown in the plan as they occur as an annotation. For example the snippet below shows that the access node could not be raised as the parent select node contained an unsupported subquery.

Project(groups=[pm1.g1], props={PROJECT_COLS=[e1], OUTPUT_COLS=null})
  Select(groups=[pm1.g1], props={SELECT_CRITERIA=e1 IN /*+ NO_UNNEST */ (SELECT e1 FROM pm2.g1), OUTPUT_COLS=null})
    Access(groups=[pm1.g1], props={SOURCE_HINT=null, MODEL_ID=Schema name=pm1, nameInSource=null, uuid=3341, OUTPUT_COLS=null})
      Source(groups=[pm1.g1], props={OUTPUT_COLS=null})


============================================================================
EXECUTING RaiseAccess
LOW Relational Planner SubqueryIn is not supported by source pm1 - e1 IN /*+ NO_UNNEST */ (SELECT e1 FROM pm2.g1) was not pushed

AFTER: 
Project(groups=[pm1.g1])
  Select(groups=[pm1.g1], props={SELECT_CRITERIA=e1 IN /*+ NO_UNNEST */ (SELECT e1 FROM pm2.g1), OUTPUT_COLS=null})
    Access(groups=[pm1.g1], props={SOURCE_HINT=null, MODEL_ID=Schema name=pm1, nameInSource=null, uuid=3341, OUTPUT_COLS=null})
      Source(groups=[pm1.g1])

XQuery

XQuery is eligible for specific optimizations. Document projection is the most common optimization. It will be shown in the debug plan as an annotation. For example with the user query containing "xmltable('/a/b' passing doc columns x string path '@x', val string path '/.')", the debug plan would show a tree of the document that will effectively be used by the context and path XQuerys:

MEDIUM XQuery Planning Projection conditions met for /a/b - Document projection will be used
childelement(Q{}a)
  childelement(Q{}b)
    attributeattribute(Q{}x)
      childtext()
    childtext()