gudusoft.gsqlparser.nodes

Class TCTE

Object

gudusoft.gsqlparser.nodes.TParseTreeNode

gudusoft.gsqlparser.nodes.TNodeWithAliasClause

gudusoft.gsqlparser.nodes.TTable

gudusoft.gsqlparser.nodes.TCTE

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

public class TCTE
extends TTable

A common table expression permits defining a result table with a table-name that can be specified as a table name in any FROM clause of the fullselect that follows.

Multiple common table expressions can be specified following the single WITH keyword.

Each common table expression specified can also be referenced by name in the FROM clause of subsequent common table expressions.

Syntax:

 table-name [column-name [,...n]] AS (fullselect)

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TTable

PIVOT_CLAUSE_ALIAS, TABLE_COLLECTION_ALIAS, tablerefs, UNPIVOT_CLAUSE_ALIAS

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

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

Constructor Summary

Constructors

Constructor and Description
TCTE()

Method Summary

Modifier and Type	Method and Description
void	accept(TParseTreeVisitor v) Accept a visitor
void	acceptChildren(TParseTreeVisitor v) Accept a visitor to iterate this class and sub-nodes of this class
void	doParse(TCustomSqlStatement psql, ESqlClause plocation) Analyze the sub-nodes inside this node.
TObjectNameList	getColumnList()
TDeleteSqlStatement	getDeleteStmt()
TDescribeStmt	getDescribeStmt() DESCRIBE statement used as the body of this CTE (Databricks DESCRIBE HISTORY inside WITH), or null.
TExpression	getExpression() ClickHouse, the body of an expression-CTE (WITH <expr> AS <ident>) — a literal, lambda, function call or parenthesised expression that the identifier names.
TInsertSqlStatement	getInsertStmt()
TSourceToken	getMaterializedToken() ClickHouse, set when the CTE is declared AS MATERIALIZED (subquery).
TCustomSqlStatement	getPreparableStmt() preparable statement can be:
String	getRelationName()
TSelectSqlStatement	getSubquery() fullselect of this common table expression.
TObjectName	getTableName()
TUpdateSqlStatement	getUpdateStmt()
void	incParenthesisCount()
void	init(Object arg1, Object arg2)
void	initAttributesFromColumnList()
void	initAttributesFromSubQuery()
boolean	isRecursive()
boolean	searchColumnInResultSet(TCustomSqlStatement pSql, TTable pTable, TObjectName pColumn, boolean pMustIn)
void	setColumnList(TObjectNameList columnList)
void	setColumnListFromExpressions(TExpressionList exprs) ClickHouse: the columned-CTE grammar (WITH t(c1, c2) AS (subquery)) parses the parenthesised column list as general expressions so the same name '(' prefix can also serve function-call expression-CTEs (WITH plus(1,2) AS x) without a reduce/reduce conflict.
void	setDeleteStmt(TDeleteSqlStatement deleteStmt)
void	setInsertStmt(TInsertSqlStatement insertStmt)
void	setMaterializedToken(TSourceToken materializedToken)
void	setPreparableStmt(TCustomSqlStatement preparableStmt)
void	setRecursive(boolean recursive)
void	setSubquery(TSelectSqlStatement subquery)
void	setTableName(TObjectName tableName)
void	setUpdateStmt(TUpdateSqlStatement updateStmt)

Methods inherited from class gudusoft.gsqlparser.nodes.TTable

addAttribute, checkTableByName, equalByName, getAliasName, getArrayIndexAlias, getAttributes, getAttributesReferenceToThisRelation, getCaseJoin, getColumnDefinitions, getColumnListInTempTable, getColumnsFromSQLEnv, getContainsTable, getCTE, getCteColomnReferences, getDatachangeTable, getDisplayName, getDisplayName, getEffectType, getExpandedStarColumns, getFlashback, getForXMLClause, getFromTableList, getFullName, getFullNameWithAliasString, getFuncCall, getHashByClause, getHiveFromQuery, getJoinExpr, getJsonTable, getLateralViewList, getLinkedColumns, getLinkTable, getLocalOrderBy, getName, getObjectNameReferences, getOpenDatasource, getOpenquery, getOpenRowSet, getOpenXML, getOuterClause, getOutputMerge, getParenthesisAfterAliasCount, getParenthesisCount, getPartitionExtensionClause, getPivotClause, getPivotedTable, getPrefixDatabase, getPrefixSchema, getPrefixServer, getPxGranule, getResolvedTable, getRowList, getSourceTableOfPivot, getSqlEnv, getStageName, getStageReference, getTableExpr, getTableHintList, getTableProperties, getTableSample, getTableType, getTdUnpivot, getTimeTravelClause, getUnnestClause, getValueClause, getXmlTable, initAttributeForRowList, initAttributeForTableFunction, initAttributeForXMLTable, initAttributesForJoin, initAttributesForPivotTable, initAttributesForUnnest, initAttributesFromCTE, initAttributesFromSubquery, initStarAttribute, isBaseTable, isCTEName, isIncludeColumnAlias, isLinkTable, isNPathOnClauseTable, isOnlyKeyword, isResolved, isSuperUnpivot, isTableKeyword, isTableRefBelongToThisTable, searchColumn, searchColumnInAlias, setArrayIndexAlias, setCaseJoin, setColumnDefinitions, setColumnListInTempTable, setContainsTable, setCTE, setCteColomnReferences, setCTEName, setDatachangeTable, setEffectType, setFlashback, setForXMLClause, setFromTableList, setFuncCall, setHashByClause, setHiveFromQuery, setJoinExpr, setJsonTable, setLateralViewList, setLinkedColumns, setLinkTable, setLinkTable, setLocalOrderBy, setNPathOnClauseTable, setObjectNameReferences, setOnlyKeyword, setOpenDatasource, setOpenquery, setOpenRowSet, setOpenXML, setOuterClause, setOutputMerge, setParenthesisAfterAliasCount, setParenthesisCount, setPartitionExtensionClause, setPivotClause, setPivotedTable, setPropertyFromObjectName, setPxGranule, setResolved, setResolvedTable, setRowList, setSourceTableOfPivot, setSqlEnv, setStageReference, setSuperUnpivot, setTableExpr, setTableHintList, setTableKeyword, setTableProperties, setTablerefs, setTableSample, setTableType, setTdUnpivot, setTimeTravelClause, setUnnestClause, setValueClause, setXmlTable, size, toString

Methods inherited from class gudusoft.gsqlparser.nodes.TNodeWithAliasClause

getAliasClause, setAliasClause

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getParentObjectName, getPlainText, getStartToken, getTokenCount, hasNext, 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, toScript, toString2

Methods inherited from class Object

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

Methods inherited from interface Iterator

forEachRemaining

Constructor Detail

TCTE

public TCTE()

Method Detail

setRecursive

public void setRecursive(boolean recursive)

isRecursive

public boolean isRecursive()

initAttributesFromColumnList

public void initAttributesFromColumnList()

initAttributesFromSubQuery

public void initAttributesFromSubQuery()

getRelationName

public String getRelationName()

Specified by:

getRelationName in interface IRelation

Overrides:

getRelationName in class TTable

searchColumnInResultSet

public boolean searchColumnInResultSet(TCustomSqlStatement pSql,
                                       TTable pTable,
                                       TObjectName pColumn,
                                       boolean pMustIn)

getPreparableStmt

public TCustomSqlStatement getPreparableStmt()

preparable statement can be:

getSubquery()

orgetUpdateStmt()

orgetInsertStmt()

orgetDeleteStmt()

Returns:

getUpdateStmt

public TUpdateSqlStatement getUpdateStmt()

getInsertStmt

public TInsertSqlStatement getInsertStmt()

getDeleteStmt

public TDeleteSqlStatement getDeleteStmt()

getDescribeStmt

public TDescribeStmt getDescribeStmt()

DESCRIBE statement used as the body of this CTE (Databricks DESCRIBE HISTORY inside WITH), or null.

getTableName

public TObjectName getTableName()

Overrides:

getTableName in class TTable

Returns:

table name of this common table expression.

setColumnList

public void setColumnList(TObjectNameList columnList)

getSubquery

public TSelectSqlStatement getSubquery()

fullselect of this common table expression.

Overrides:

getSubquery in class TTable

Returns:

getColumnList

public TObjectNameList getColumnList()

Returns:

List of column name of this common table expression.

setColumnListFromExpressions

public void setColumnListFromExpressions(TExpressionList exprs)

ClickHouse: the columned-CTE grammar (WITH t(c1, c2) AS (subquery)) parses the parenthesised column list as general expressions so the same name '(' prefix can also serve function-call expression-CTEs (WITH plus(1,2) AS x) without a reduce/reduce conflict. Convert the expressions back to a column-name list. All-or-nothing: if any element is not a plain column reference (native ClickHouse rejects such a list), NO column list is set — compacting the valid entries would silently shift every later column onto the wrong subquery position.

init

public void init(Object arg1,
                 Object arg2)

Overrides:

init in class TParseTreeNode

getExpression

public TExpression getExpression()

ClickHouse, the body of an expression-CTE (WITH <expr> AS <ident>) — a literal, lambda, function call or parenthesised expression that the identifier names. Null for subquery CTEs.

Returns:

the expression named by this CTE, null for subquery CTEs.

getMaterializedToken

public TSourceToken getMaterializedToken()

ClickHouse, set when the CTE is declared AS MATERIALIZED (subquery).

Returns:

the MATERIALIZED keyword token, null otherwise.

setMaterializedToken

public void setMaterializedToken(TSourceToken materializedToken)

incParenthesisCount

public void incParenthesisCount()

doParse

public void doParse(TCustomSqlStatement psql,
                    ESqlClause plocation)

Description copied from class: TParseTreeNode

Analyze the sub-nodes inside this node. Such as build the relationship between table and column.

Overrides:

doParse in class TParseTreeNode

Parameters:

psql - SQL statement this node belongs to

plocation - SQL clause this node belongs to

accept

public void accept(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor

Specified by:

accept in interface Visitable

Overrides:

accept in class TTable

Parameters:

v - visitor is a descendant class of TParseTreeVisitor

acceptChildren

public void acceptChildren(TParseTreeVisitor v)

Description copied from class: TParseTreeNode

Accept a visitor to iterate this class and sub-nodes of this class

Specified by:

acceptChildren in interface Visitable

Overrides:

acceptChildren in class TTable

Parameters:

v - visitor is a descendant class of TParseTreeVisitor

setSubquery

public void setSubquery(TSelectSqlStatement subquery)

Overrides:

setSubquery in class TTable

setInsertStmt

public void setInsertStmt(TInsertSqlStatement insertStmt)

setUpdateStmt

public void setUpdateStmt(TUpdateSqlStatement updateStmt)

setDeleteStmt

public void setDeleteStmt(TDeleteSqlStatement deleteStmt)

setPreparableStmt

public void setPreparableStmt(TCustomSqlStatement preparableStmt)

setTableName

public void setTableName(TObjectName tableName)

Overrides:

setTableName in class TTable