gudusoft.gsqlparser.stmt.flink

Class TFlinkExplainStmt

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.TCustomSqlStatement

gudusoft.gsqlparser.stmt.TExplainPlan

gudusoft.gsqlparser.stmt.flink.TFlinkExplainStmt

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

public class TFlinkExplainStmt
extends TExplainPlan

Flink EXPLAIN statement.

Displays the logical and physical execution plan for a SQL statement.

Syntax:

 EXPLAIN [([ExplainDetail[, ExplainDetail]*]) | PLAN FOR] <statement>
 

ExplainDetail options:

• ESTIMATED_COST - Shows estimated cost of each physical rel node
• CHANGELOG_MODE - Shows changelog mode of each physical rel node
• PLAN_ADVICE - Provides potential risk warnings and optimization advice
• JSON_EXECUTION_PLAN - Shows JSON-format execution plan

Examples:

 EXPLAIN SELECT * FROM Orders;
 EXPLAIN PLAN FOR SELECT * FROM Orders;
 EXPLAIN ESTIMATED_COST, CHANGELOG_MODE SELECT * FROM Orders;
 EXPLAIN (ESTIMATED_COST, CHANGELOG_MODE, PLAN_ADVICE, JSON_EXECUTION_PLAN) SELECT * FROM Orders;
 

Since:

3.2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class gudusoft.gsqlparser.TCustomSqlStatement

TCustomSqlStatement.SqlNormalizationProfile

Field Summary

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement

dummytag, fromClause, fromSourceJoin, fromSourceTable, isctequery, isparsed, joins, parser, plsqlparser, relationAttributes, rootNode, semicolonended, sourcetokenlist, sqlstatementtype, stmtScope, tables

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

dbvendor, doubleLinkedTokenListToString, nodeActionAppend, nodeActionInsert, nodeActionRemove, nodeActionUnknown, nodeActionUpdate, nodeActionUpdateText, nodeChangeEndToken, nodeChangeStartToken

Constructor Summary

Constructors

Constructor and Description
TFlinkExplainStmt(EDbVendor dbvendor)

Method Summary

Modifier and Type	Method and Description
int	doParseStatement(TCustomSqlStatement psql)
boolean	isChangelogMode() Returns whether CHANGELOG_MODE option was specified.
boolean	isEstimatedCost() Returns whether ESTIMATED_COST option was specified.
boolean	isJsonExecutionPlan() Returns whether JSON_EXECUTION_PLAN option was specified.
boolean	isPlanAdvice() Returns whether PLAN_ADVICE option was specified.
boolean	isPlanFor() Returns whether PLAN FOR syntax was used.
void	setChangelogMode(boolean changelogMode)
void	setEstimatedCost(boolean estimatedCost)
void	setIsPlanFor(boolean isPlanFor)
void	setJsonExecutionPlan(boolean jsonExecutionPlan)
void	setPlanAdvice(boolean planAdvice)

Methods inherited from class gudusoft.gsqlparser.stmt.TExplainPlan

accept, acceptChildren, getStatement, setStatement

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement

addToTables, addWhereClause, analyzeFromTable, analyzeFromTable, analyzeJoin, analyzeTablename, analyzeTableOrJoin, asCanonical, checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt, clearError, computeSqlHash, dochecksyntax, findTable, fireOnMetaDatabaseTableColumn, getAncestorStmt, getAttributes, getColumnsInTable, getColumnsInTable, getCteIncludeThisStmt, getCteList, getDaxFunctionStack, getEndlabelName, getErrorCount, getErrormessage, getExpandedResultColumns, getFirstPhysicalTable, getFrameStack, getFromClause, getFromSourceJoin, getFromSourceTable, getGlobalScope, getIndexColumns, getJoins, getLabelName, getOrphanColumns, getOutputClause, getParentObjectName, getParentStmt, getQueryId, getRelationName, getRelations, getResultColumnList, getReturningClause, getSqlEnv, getSqlHash, getSqlHash, getStatements, getStmtScope, getSymbolTable, getSyntaxErrors, getSyntaxHints, getTables, getTargetTable, getTokenList, getTopClause, getTopStatement, getUsingVariableList, getVariableStack, getWhereClause, isathenaplsql, isBigQueryplsql, isdatabricksplsql, isGaussDBStoredProcedure, isgreeplumplsql, isnzplsql, isoracleplsql, ispgplsql, isprestoplsql, issnowflakeplsql, isTableACTE, isverticaplsql, linkColumnReferenceToTable, linkColumnToTable, linkToFirstTable, locateVariableOrParameter, locateVariableOrParameter, OracleStatementCanBeSeparatedByBeginEndPair, parseerrormessagehandle, parsestatement, parsestatement, searchCTEList, searchDaxVariableInStack, searchFunctionInSQLEnv, setAlreadyAddToParent, setCteIncludeThisStmt, setCteList, setEndlabelName, setFrameStack, setFromClause, setLabelName, setOutputClause, setParentStmt, setParentStmtToNull, setQueryId, setResultColumnList, setReturningClause, setSqlHash, setStmtScope, setTargetTable, setTopClause, setUsingVariableList, setVariableStack, setWhereClause, size, toNormalizedSql, toScript, VerticaStatementCanBeSeparatedByBeginEndPair

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, doParse, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getPlainText, getStartToken, getTokenCount, hasNext, init, init, init, init, init, init, init, init, init, init, insertAfterAToken, insertNewNodeBeforeMe, isChanged, isTokensInChain, next, refreshAllNodesTokenCount, remove, removeAllMyTokensFromTokenList, removeTokens, removeTokensBetweenNodes, removeTokensBetweenToken, replaceWithNewNode, resetIterator, setAnchorNode, setChanged, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setEndToken, setEndTokenDirectly, setEvaluateDatatype, setEvalValue, setGsqlparser, setIncludingComment, setLocation, setNewSubNode, setNodeStatus, setNodeType, setParent, setPlainText, setStartToken, setStartToken, setStartToken, setStartToken, setStartTokenDirectly, setString, setString2, subNodeInNode, toString, toString2

Methods inherited from class Object

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

Methods inherited from interface Iterator

forEachRemaining

Constructor Detail

TFlinkExplainStmt

public TFlinkExplainStmt(EDbVendor dbvendor)

Method Detail

isEstimatedCost

public boolean isEstimatedCost()

Returns whether ESTIMATED_COST option was specified.

setEstimatedCost

public void setEstimatedCost(boolean estimatedCost)

isChangelogMode

public boolean isChangelogMode()

Returns whether CHANGELOG_MODE option was specified.

setChangelogMode

public void setChangelogMode(boolean changelogMode)

isPlanAdvice

public boolean isPlanAdvice()

Returns whether PLAN_ADVICE option was specified.

setPlanAdvice

public void setPlanAdvice(boolean planAdvice)

isJsonExecutionPlan

public boolean isJsonExecutionPlan()

Returns whether JSON_EXECUTION_PLAN option was specified.

setJsonExecutionPlan

public void setJsonExecutionPlan(boolean jsonExecutionPlan)

isPlanFor

public boolean isPlanFor()

Returns whether PLAN FOR syntax was used.

setIsPlanFor

public void setIsPlanFor(boolean isPlanFor)

doParseStatement

public int doParseStatement(TCustomSqlStatement psql)

Overrides:

doParseStatement in class TExplainPlan