TSelectSqlStatement (General SQL Parser Java Library Core 4.2.19 API)

Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.TCustomSqlStatement
  - - gudusoft.gsqlparser.stmt.TSelectSqlStatement

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

Direct Known Subclasses:

THiveFromQuery, TPostgresqlTableStmt
```
public class TSelectSqlStatement
extends TCustomSqlStatement
```
Class TSelectSqlStatement represents query specification, query expression and select statement.

query specification including following clause:
- select list getResultColumnList(boolean)
- from clause TCustomSqlStatement.joins
- where clause TCustomSqlStatement.getWhereClause()
- group clause getGroupByClause()
- having clause getGroupByClause()
In some databases, query specification also known as sub-select.

query expression including all elements in query specification and following clause:
- order by clause getOrderbyClause()
- offset clause getOffsetClause()
- for clause
In some databases, query expression also known as full-select.
It is a component of the select-statement, the INSERT statement, and the CREATE VIEW statement. And a full-select that is enclosed in parentheses is sometimes called a sub-query.

select statement including all elements in query expression and following clause:
- compute clause getComputeClause()
- for update clause getForUpdateClause()
- optimizer hint
- ctes TCustomSqlStatement.getCteList()
Lots of clauses on this level are db vendors specific.

Use isCombinedQuery() to check whether UNION, EXCEPT and INTERSECT operators is used. If returns true, use getLeftStmt() and getRightStmt() to get query expression. You need to check isCombinedQuery() recursively, all clauses of TSelectSqlStatement only available when this function returns false.

Nested Class Summary
- Nested classes/interfaces inherited from class gudusoft.gsqlparser.TCustomSqlStatement
  TCustomSqlStatement.SqlNormalizationProfile

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`SET_OPERATOR_EXCEPTDISTINCT`
`static int`	`SET_OPERATOR_INTERSECTDISTINCT`
`static int`	`SET_OPERATOR_MINUSDISTINCT`
`static int`	`SET_OPERATOR_NONE`
`static int`	`SET_OPERATOR_UNIONDISTINCT`
`static int`	`setOperator_except`
`static int`	`setOperator_exceptall`
`static int`	`setOperator_intersect`
`static int`	`setOperator_intersectall`
`static int`	`setOperator_minus`
`static int`	`setOperator_minusall`
`static int`	`setOperator_union`
`static int`	`setOperator_unionall`

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement
dummytag, fromClause, fromSourceJoin, fromSourceTable, isctequery, isparsed, joins, parser, plsqlparser, 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

TSelectSqlStatement(EDbVendor dbvendor)

Constructors
Constructor and Description
`TSelectSqlStatement(EDbVendor dbvendor)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accept(TParseTreeVisitor v)` Accept a visitor
`void`	`acceptChildren(TParseTreeVisitor v)` Accept visitor to visit this class.
`void`	`addColumnInSelectListToSQLEnv(TSQLTable sqlTable)`
`TWhereClause`	`addCondition(String condition)` this function is alias of addWhereClause
`TWhereClause`	`addConditionOR(String condition)`
`TOrderBy`	`addOrderBy(String orderByStr)` Add an order by clause to this class.
`TWhereClause`	`addWhereClause(String condition)`
`TWhereClause`	`addWhereClauseOR(String condition)`
`protected TWhereClause`	`doAddWhereClause(String condition, boolean isAnd)`
`int`	`doParseStatement(TCustomSqlStatement psql)` This function is used internal.
`TResultColumn`	`findEnclosingAliasDefinition(TObjectName reference, TSQLEnv sqlEnv)` The SELECT-list alias of an ENCLOSING SELECT block that `reference`, an unqualified name of this block, stands for in SAP IQ and SQL Anywhere (Mantis 4752).
`ArrayList<TAttributeNode>`	`getAttributes()` 在 sql script 中，和该 relation 关联的 attribute。 select a from t; attribute a 就是 relation t 的 referenceAttribute, 如果没有 metadata and ddl， relation t 的 getAttributes() 应该可以推断出包含 a, 但 t 是否还包含其他的 attribute 就无从得知。
`TClusterBy`	`getClusterBy()`
`ArrayList<String>`	`getColumnsInFromClause()`
`TComputeClause`	`getComputeClause()`
`TDistributeBy`	`getDistributeBy()`
`TSourceToken`	`getEndToken()` The last token of the node
`TreeMap<String,TResultColumn>`	`getExpandedResultColumns()`
`TExpandOnClause`	`getExpandOnClause()`
`TSelectSqlStatement`	`getFarLeftStmt()`
`TFetchFirstClause`	`getFetchFirstClause()` Fetch first/next clause
`ArrayList<TSelectSqlStatement>`	`getFlattenedSelects()`
`TForUpdate`	`getForUpdateClause()`
`TFromClause`	`getFromClause()`
`TGroupBy`	`getGroupByClause()`
`THierarchical`	`getHierarchicalClause()` Oracle hierarchical_query_clause
`String`	`getHint()` Hint for Oracle and MySQL
`THintClause`	`getHintClause()`
`TStatementList`	`getHiveBodyList()` Deprecated. since 2.6.3.5, please use `getMultiSelectStatements()` to retrieve multimple select statement in Hive from query ... select, select, ...
`THiveHintClause`	`getHiveHintClause()`
`TIntoClause`	`getIntoClause()`
`TIntoTableClause`	`getIntoTableClause()`
`TIsolationClause`	`getIsolationClause()`
`TSelectSqlStatement`	`getLeftStmt()` Valid when `getSetOperator()` is not setOperator_none.
`TLimitClause`	`getLimitClause()` MySQL,PostgreSQL limit clause
`TPTNodeList<TLockingClause>`	`getLockingClauses()` PostgreSQL, for update of, for read only.
`ArrayList<TSelectSqlStatement>`	`getMultiSelectStatements()` Hive, from ...
`TOffsetClause`	`getOffsetClause()` Offset clause.
`TOptionClause`	`getOptionClause()`
`String`	`getOracleHint()` Deprecated. As of 2.0.4.5, replaced by `getHint()`
`TOrderBy`	`getOrderbyClause()`
`int`	`getParenthesisCount()`
`int`	`getParenthesisCountBeforeOrder()`
`TPTNodeList<TParseTreeNode>`	`getPipeOperators()` Get the list of pipe operators for StarRocks pipe query syntax.
`TQualifyClause`	`getQualifyClause()`
`TResultColumnList`	`getResultColumnList()` In select statement, this method returns Items in select_list.
`TResultColumnList`	`getResultColumnList(boolean useColumnsFromLeftmost)`
`TSelectSqlStatement`	`getRightStmt()` Valid when `getSetOperator()` is not setOperator_none.
`TSampleClause`	`getSampleClause()`
`TSelectDistinct`	`getSelectDistinct()`
`ArrayList<TSelectModifier>`	`getSelectModifiers()`
`TSourceToken`	`getSelectToken()`
`int`	`getSetOperator()` Deprecated. As of v1.6.4.2, use `getSetOperatorType()` and `isAll()` instead.
`ESetOperatorType`	`getSetOperatorType()`
`TSortBy`	`getSortBy()`
`TTeradataWithClause`	`getTeradataWithClause()`
`TTimeTravel`	`getTimeTravel()`
`THiveTransformClause`	`getTransformClause()`
`TValueClause`	`getValueClause()` DB2 value clause
`TWindowClause`	`getWindowClause()`
`TStatementListSqlNode`	`getWithPlsqlItems()` Get the inline PL/SQL function/procedure definitions from WITH clause.
`boolean`	`isAll()`
`boolean`	`isChildOfCombinedQuery()`
`boolean`	`isCombinedQuery()` Determine whether The UNION, EXCEPT and INTERSECT operators were used.
`boolean`	`isConsume()`
`boolean`	`isPipeQuery()` Check if this is a StarRocks pipe query.
`boolean`	`isQueryOfCTE()`
`boolean`	`isSetOpDistinct()`
`boolean`	`isStarColumnPushedDown()`
`boolean`	`isSubQueryInFromClauseCanUseParentSelectAsEnclosingScope()`
`boolean`	`isTableQuery()` Whether this query was written as `TABLE t`, the SQL-standard shorthand for `SELECT * FROM t`.
`boolean`	`isValueClause()`
`boolean`	`mayExposeColumn(String columnName, TSQLEnv sqlEnv)` Whether this block may have a column `columnName` of its own: some table it reads may have it (a derived table, a CTE, a table function, a table whose columns the catalog does not all know, or knows to include it).
`static TTable`	`outerCorrelationTable(TObjectName name, TSelectSqlStatement subquery, TSQLEnv sqlEnv)` The table of an enclosing query that the unqualified `name` in `subquery` reads, or null when the name is the subquery's own (Mantis 4797).
`boolean`	`searchColumnInResultSet(TObjectName pColumn, boolean pMustIn)` search column in the select list Internal function, DON'T call it explicitly.
`void`	`setAll(boolean all)`
`void`	`setChildOfCombinedQuery(boolean childOfCombinedQuery)`
`void`	`setClusterBy(TClusterBy clusterBy)`
`void`	`setComputeClause(TComputeClause computeClause)`
`void`	`setConsume(boolean consume)`
`void`	`setDistributeBy(TDistributeBy distributeBy)`
`void`	`setExpandOnClause(TExpandOnClause expandOnClause)`
`void`	`setFetchFirstClause(TFetchFirstClause fetchFirstClause)`
`void`	`setForUpdateClause(TForUpdate forUpdateClause)`
`void`	`setGroupByClause(TGroupBy groupByClause)`
`void`	`setHierarchicalClause(THierarchical hierarchicalClause)`
`void`	`setHintClause(THintClause hintClause)`
`void`	`setHiveHintClause(THiveHintClause hiveHintClause)`
`void`	`setIntoClause(TIntoClause intoClause)`
`void`	`setIntoTableClause(TIntoTableClause intoTableClause)`
`void`	`setIsolationClause(TIsolationClause isolationClause)`
`void`	`setIsPipeQuery(boolean isPipeQuery)` Set whether this is a pipe query.
`void`	`setLeftStmt(TSelectSqlStatement leftStmt)`
`void`	`setLimitClause(TLimitClause limitClause)`
`void`	`setLockingClauses(TPTNodeList<TLockingClause> lockingClauses)`
`void`	`setOffsetClause(TOffsetClause offsetClause)`
`void`	`setOptionClause(TOptionClause optionClause)`
`void`	`setOracleHint(String oracleHint)`
`void`	`setOrderbyClause(TOrderBy newOrderbyClause)`
`void`	`setParenthesisCount(int parenthesisCount)`
`void`	`setParenthesisCountBeforeOrder(int parenthesisCountBeforeOrder)`
`void`	`setPipeOperators(TPTNodeList<TParseTreeNode> pipeOperators)` Set the pipe operators list.
`void`	`setQualifyClause(TQualifyClause qualifyClause)`
`void`	`setQueryOfCTE(boolean queryOfCTE)`
`void`	`setRightStmt(TSelectSqlStatement rightStmt)`
`void`	`setSampleClause(TSampleClause sampleClause)`
`void`	`setSelectDistinct(TSelectDistinct selectDistinct)`
`void`	`setSelectModifiers(ArrayList<TSelectModifier> selectModifiers)`
`void`	`setSelectToken(TSourceToken selectToken)`
`void`	`setSetOperator(int setOperator)`
`void`	`setSetOperatorType(ESetOperatorType setOperatorType)`
`void`	`setSortBy(TSortBy sortBy)`
`void`	`setStarColumnPushedDown(boolean starColumnPushedDown)`
`void`	`setSubQueryInFromClauseCanUseParentSelectAsEnclosingScope(boolean subQueryInFromClauseCanUseParentSelectAsEnclosingScope)`
`void`	`setTeradataWithClause(TTeradataWithClause teradataWithClause)`
`void`	`setTimeTravel(TTimeTravel timeTravel)`
`void`	`setTransformClause(THiveTransformClause transformClause)`
`void`	`setValueClause(TValueClause valueClause)`
`void`	`setWindowClause(TWindowClause windowClause)`
`void`	`setWithPlsqlItems(TStatementListSqlNode withPlsqlItems)` Set the inline PL/SQL function/procedure definitions.
`static boolean`	`unnestHasStructField(TTable unnest, String columnName)` Whether an UNNEST relation provably has a column `columnName` as a field of the STRUCTs its array holds: `UNNEST([STRUCT(0 AS a, 1 AS b)])`, or a CTE or derived column defined so, has the columns a and b.
`static List<String>`	`unnestStructFieldNames(TTable unnest)` The field names of the STRUCTs an UNNEST reads, which are its columns, or null when they are not known or an alias column list names its columns instead.

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement
addToTables, analyzeFromTable, analyzeFromTable, analyzeJoin, analyzeTablename, analyzeTableOrJoin, asCanonical, checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt, clearError, computeSqlHash, dochecksyntax, findTable, fireOnMetaDatabaseTableColumn, getAncestorStmt, getColumnsInTable, getColumnsInTable, getCteIncludeThisStmt, getCteList, getDaxFunctionStack, getEndlabelName, getErrorCount, getErrormessage, getFirstPhysicalTable, getFrameStack, getFromSourceJoin, getFromSourceTable, getGlobalScope, getIndexColumns, getJoins, getLabelName, getOrphanColumns, getOutputClause, getParentObjectName, getParentStmt, getQueryId, getRelationName, getRelations, getReturningClause, getSqlEnv, getSqlHash, getSqlHash, getStatements, getStmtScope, getSymbolTable, getSyntaxErrors, getSyntaxHints, getTables, getTargetTable, getTokenList, getTopClause, getTopStatement, getUsingVariableList, getVariableStack, getWhereClause, isathenaplsql, isBigQueryplsql, isdatabricksplsql, isGaussDBStoredProcedure, isgreeplumplsql, isMySQLDialect, isMySQLDialect, isnzplsql, isoracleplsql, isOraclePseudoColumnReference, isOracleSequencePseudoColumnReference, 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, unbindCteTarget, VerticaStatementCanBeSeparatedByBeginEndPair

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, commentBlockAfter, commentBlockEndAfter, doAppendNewNode, doParse, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCommentBeforeNode, getCommentBeforeNode, getCompactString, getDummyTag, 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

- Field Detail
  - SET_OPERATOR_NONE
```
public static final int SET_OPERATOR_NONE
```
    See Also:
    
    Constant Field Values
  - setOperator_union
```
public static final int setOperator_union
```
    See Also:
    
    Constant Field Values
  - setOperator_unionall
```
public static final int setOperator_unionall
```
    See Also:
    
    Constant Field Values
  - SET_OPERATOR_UNIONDISTINCT
```
public static final int SET_OPERATOR_UNIONDISTINCT
```
    See Also:
    
    Constant Field Values
  - setOperator_intersect
```
public static final int setOperator_intersect
```
    See Also:
    
    Constant Field Values
  - setOperator_intersectall
```
public static final int setOperator_intersectall
```
    See Also:
    
    Constant Field Values
  - SET_OPERATOR_INTERSECTDISTINCT
```
public static final int SET_OPERATOR_INTERSECTDISTINCT
```
    See Also:
    
    Constant Field Values
  - setOperator_minus
```
public static final int setOperator_minus
```
    See Also:
    
    Constant Field Values
  - setOperator_minusall
```
public static final int setOperator_minusall
```
    See Also:
    
    Constant Field Values
  - SET_OPERATOR_MINUSDISTINCT
```
public static final int SET_OPERATOR_MINUSDISTINCT
```
    See Also:
    
    Constant Field Values
  - setOperator_except
```
public static final int setOperator_except
```
    See Also:
    
    Constant Field Values
  - setOperator_exceptall
```
public static final int setOperator_exceptall
```
    See Also:
    
    Constant Field Values
  - SET_OPERATOR_EXCEPTDISTINCT
```
public static final int SET_OPERATOR_EXCEPTDISTINCT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TSelectSqlStatement
```
public TSelectSqlStatement(EDbVendor dbvendor)
```
- Method Detail
  - getEndToken
```
public TSourceToken getEndToken()
```
    Description copied from class: TParseTreeNode
    
    The last token of the node
    
    Overrides:
    
    getEndToken in class TParseTreeNode
    
    Returns:
    
    the last token of node
  - setSubQueryInFromClauseCanUseParentSelectAsEnclosingScope
```
public void setSubQueryInFromClauseCanUseParentSelectAsEnclosingScope(boolean subQueryInFromClauseCanUseParentSelectAsEnclosingScope)
```
  - isSubQueryInFromClauseCanUseParentSelectAsEnclosingScope
```
public boolean isSubQueryInFromClauseCanUseParentSelectAsEnclosingScope()
```
  - isStarColumnPushedDown
```
public boolean isStarColumnPushedDown()
```
  - setStarColumnPushedDown
```
public void setStarColumnPushedDown(boolean starColumnPushedDown)
```
  - getWithPlsqlItems
```
public TStatementListSqlNode getWithPlsqlItems()
```
    Get the inline PL/SQL function/procedure definitions from WITH clause. Oracle 12c+ allows defining PL/SQL functions inline in the WITH clause: WITH FUNCTION f(x NUMBER) RETURN NUMBER IS BEGIN RETURN x*2; END; SELECT f(1) FROM dual
    
    Returns:
    
    list of inline function/procedure definitions, or null if none
  - setWithPlsqlItems
```
public void setWithPlsqlItems(TStatementListSqlNode withPlsqlItems)
```
    Set the inline PL/SQL function/procedure definitions.
    
    Parameters:
    
    withPlsqlItems - list of inline function/procedure definitions
  - getPipeOperators
```
public TPTNodeList<TParseTreeNode> getPipeOperators()
```
    Get the list of pipe operators for StarRocks pipe query syntax. Pipe queries use the |> operator to chain operations: FROM table |> SELECT * |> WHERE cond |> ORDER BY col
    
    Returns:
    
    list of TPipeOperator nodes, or null if not a pipe query
  - setPipeOperators
```
public void setPipeOperators(TPTNodeList<TParseTreeNode> pipeOperators)
```
    Set the pipe operators list.
    
    Parameters:
    
    pipeOperators - list of pipe operator nodes
  - isPipeQuery
```
public boolean isPipeQuery()
```
    Check if this is a StarRocks pipe query. Pipe queries use the syntax: FROM table |> SELECT * |> WHERE ...
    
    Returns:
    
    true if this is a pipe query
  - setIsPipeQuery
```
public void setIsPipeQuery(boolean isPipeQuery)
```
    Set whether this is a pipe query.
    
    Parameters:
    
    isPipeQuery - true if this is a pipe query
  - getAttributes
```
public ArrayList<TAttributeNode> getAttributes()
```
    在 sql script 中，和该 relation 关联的 attribute。 select a from t; attribute a 就是 relation t 的 referenceAttribute, 如果没有 metadata and ddl， relation t 的 getAttributes() 应该可以推断出包含 a, 但 t 是否还包含其他的 attribute 就无从得知。
    
    Specified by:
    
    getAttributes in interface IRelation
    
    Overrides:
    
    getAttributes in class TCustomSqlStatement
    
    Returns:
  - getMultiSelectStatements
```
public ArrayList<TSelectSqlStatement> getMultiSelectStatements()
```
    Hive, from ... select, select,...
    Multiple select statement in Hive from query syntax
    
    Returns:
    
    Multiple select statement in Hive from query syntax
  - setClusterBy
```
public void setClusterBy(TClusterBy clusterBy)
```
  - getClusterBy
```
public TClusterBy getClusterBy()
```
  - setConsume
```
public void setConsume(boolean consume)
```
  - isConsume
```
public boolean isConsume()
```
  - getHiveBodyList
```
public TStatementList getHiveBodyList()
```
    Deprecated. since 2.6.3.5, please use getMultiSelectStatements() to retrieve multimple select statement in Hive from query ... select, select, ...
    
    Returns:
  - setSelectModifiers
```
public void setSelectModifiers(ArrayList<TSelectModifier> selectModifiers)
```
  - getSelectModifiers
```
public ArrayList<TSelectModifier> getSelectModifiers()
```
  - setTimeTravel
```
public void setTimeTravel(TTimeTravel timeTravel)
```
  - setHintClause
```
public void setHintClause(THintClause hintClause)
```
  - getTimeTravel
```
public TTimeTravel getTimeTravel()
```
  - getHintClause
```
public THintClause getHintClause()
```
  - setFetchFirstClause
```
public void setFetchFirstClause(TFetchFirstClause fetchFirstClause)
```
  - setParenthesisCount
```
public void setParenthesisCount(int parenthesisCount)
```
  - setParenthesisCountBeforeOrder
```
public void setParenthesisCountBeforeOrder(int parenthesisCountBeforeOrder)
```
  - setAll
```
public void setAll(boolean all)
```
  - setSetOperatorType
```
public void setSetOperatorType(ESetOperatorType setOperatorType)
```
  - setWindowClause
```
public void setWindowClause(TWindowClause windowClause)
```
  - setLockingClauses
```
public void setLockingClauses(TPTNodeList<TLockingClause> lockingClauses)
```
  - setSelectDistinct
```
public void setSelectDistinct(TSelectDistinct selectDistinct)
```
  - setExpandOnClause
```
public void setExpandOnClause(TExpandOnClause expandOnClause)
```
  - setSetOperator
```
public void setSetOperator(int setOperator)
```
  - setLeftStmt
```
public void setLeftStmt(TSelectSqlStatement leftStmt)
```
  - setRightStmt
```
public void setRightStmt(TSelectSqlStatement rightStmt)
```
  - setValueClause
```
public void setValueClause(TValueClause valueClause)
```
  - setOracleHint
```
public void setOracleHint(String oracleHint)
```
  - setHiveHintClause
```
public void setHiveHintClause(THiveHintClause hiveHintClause)
```
  - setTransformClause
```
public void setTransformClause(THiveTransformClause transformClause)
```
  - setDistributeBy
```
public void setDistributeBy(TDistributeBy distributeBy)
```
  - setIntoClause
```
public void setIntoClause(TIntoClause intoClause)
```
  - setOrderbyClause
```
public void setOrderbyClause(TOrderBy newOrderbyClause)
```
  - setQualifyClause
```
public void setQualifyClause(TQualifyClause qualifyClause)
```
  - setSampleClause
```
public void setSampleClause(TSampleClause sampleClause)
```
  - setTeradataWithClause
```
public void setTeradataWithClause(TTeradataWithClause teradataWithClause)
```
  - setForUpdateClause
```
public void setForUpdateClause(TForUpdate forUpdateClause)
```
  - setComputeClause
```
public void setComputeClause(TComputeClause computeClause)
```
  - setGroupByClause
```
public void setGroupByClause(TGroupBy groupByClause)
```
  - setHierarchicalClause
```
public void setHierarchicalClause(THierarchical hierarchicalClause)
```
  - setLimitClause
```
public void setLimitClause(TLimitClause limitClause)
```
  - setOffsetClause
```
public void setOffsetClause(TOffsetClause offsetClause)
```
  - setOptionClause
```
public void setOptionClause(TOptionClause optionClause)
```
  - setIsolationClause
```
public void setIsolationClause(TIsolationClause isolationClause)
```
  - setSortBy
```
public void setSortBy(TSortBy sortBy)
```
  - setIntoTableClause
```
public void setIntoTableClause(TIntoTableClause intoTableClause)
```
  - getParenthesisCountBeforeOrder
```
public int getParenthesisCountBeforeOrder()
```
  - getParenthesisCount
```
public int getParenthesisCount()
```
  - setQueryOfCTE
```
public void setQueryOfCTE(boolean queryOfCTE)
```
  - isQueryOfCTE
```
public boolean isQueryOfCTE()
```
  - findEnclosingAliasDefinition
```
public TResultColumn findEnclosingAliasDefinition(TObjectName reference,
                                                  TSQLEnv sqlEnv)
```
    The SELECT-list alias of an ENCLOSING SELECT block that reference, an unqualified name of this block, stands for in SAP IQ and SQL Anywhere (Mantis 4752).
    SQL Anywhere: "Aliases can be used anywhere in the SELECT block in which they are defined", and an alias "occludes" a column or variable of the same name (Renamed columns in query results). A subquery in the select list, WHERE, GROUP BY, HAVING or ORDER BY of a block is part of that block, so a name the subquery does not resolve itself is the alias of the block around it:
```
SELECT a AS x, (SELECT x) AS y FROM outer_t      -- the inner x is the alias x, that is a
```
    Only what the SQL and the catalog prove is taken. Walking outward from this block, a block is passed only when it provably has no column of that name: it reads no table, or the catalog knows every table it reads, with all its columns, and none of them has that name. A table with no metadata, a table whose columns are not all known (no column list, or a * lineage could not expand), a derived table, a CTE or a table function may have it, so the walk stops there and the name stays a column. The walk leaves a block only from a subquery in one of those clauses or from a branch of a set operation, never from a derived table, a join condition or a CTE. In the enclosing block the alias must be defined before the reference (a forward reference is SQLCODE -831), which also keeps a name inside the alias's own definition a column; there the alias wins over a column of the same name.
    
    The single definition of this rule for the older resolver (TCustomSqlStatement.linkColumnToTable) and resolver2 (TSQLResolver2.handleSelectListAliasResolution). An alias of the reference's own block is TResultColumnList.findLateralAliasDefinition(gudusoft.gsqlparser.EDbVendor, gudusoft.gsqlparser.nodes.TObjectName).
    Parameters:
    
    reference - an unqualified column reference of this block
    
    sqlEnv - the catalog to look a table up in when it has no resolved table, or null; it must be in the statement's own context (current database and schema), so resolver2, which reads the catalog after the whole script, passes null
    
    Returns:
    
    the defining result column of the enclosing block, or null
  - mayExposeColumn
```
public boolean mayExposeColumn(String columnName,
                               TSQLEnv sqlEnv)
```
    Whether this block may have a column columnName of its own: some table it reads may have it (a derived table, a CTE, a table function, a table whose columns the catalog does not all know, or knows to include it). False only when the block provably has none. sqlEnv as in findEnclosingAliasDefinition(gudusoft.gsqlparser.nodes.TObjectName, gudusoft.gsqlparser.sqlenv.TSQLEnv).
  - outerCorrelationTable
```
public static TTable outerCorrelationTable(TObjectName name,
                                           TSelectSqlStatement subquery,
                                           TSQLEnv sqlEnv)
```
    The table of an enclosing query that the unqualified name in subquery reads, or null when the name is the subquery's own (Mantis 4797). A SELECT in an expression of a query reads a name from its own tables while they may have it: in (select Jahr from m_version_table2 where Jahr234 = year(now())) both names are m_version_table2's, though a derived table around the subquery names them too. The name is an enclosing query's when it is compared with a column of the subquery's own tables, the subquery's own tables do not prove it and the enclosing query does: in (SELECT max(v) FROM customfieldvalues WHERE resourceid = resumeid) under FROM (SELECT id AS resumeid FROM resumes) r, resumeid is r's. Parse-time linking (TCustomSqlStatement.linkColumnToTable) and resolver2 (NameResolver) both decide by this rule.
    
    Parameters:
    
    sqlEnv - the catalog the parse reads, or null when each table's TTable.getResolvedTable() is what proves its columns, as after resolver2 bound the tables
  - unnestHasStructField
```
public static boolean unnestHasStructField(TTable unnest,
                                           String columnName)
```
    Whether an UNNEST relation provably has a column columnName as a field of the STRUCTs its array holds: UNNEST([STRUCT(0 AS a, 1 AS b)]), or a CTE or derived column defined so, has the columns a and b.
  - unnestStructFieldNames
```
public static List<String> unnestStructFieldNames(TTable unnest)
```
    The field names of the STRUCTs an UNNEST reads, which are its columns, or null when they are not known or an alias column list names its columns instead. Parse-time linking and resolver2's UnnestNamespace both read them here.
  - getOffsetClause
```
public TOffsetClause getOffsetClause()
```
    Offset clause.
```
OFFSET 2 ROWS FETCH NEXT 4 ROWS ONLY;
```
    Returns:
    
    offset clause
  - getFetchFirstClause
```
public TFetchFirstClause getFetchFirstClause()
```
    Fetch first/next clause
```
OFFSET 2 ROWS FETCH NEXT 4 ROWS ONLY;
```
    Returns:
    
    fetch first/next clause
  - getOptionClause
```
public TOptionClause getOptionClause()
```
    Returns:
    
    sql server option clause
    
    See Also:
    
    TOptionClause
  - getIsolationClause
```
public TIsolationClause getIsolationClause()
```
    Returns:
    
    isolation clause
  - getSortBy
```
public TSortBy getSortBy()
```
    Returns:
    
    Hive sort by clause
  - getIntoTableClause
```
public TIntoTableClause getIntoTableClause()
```
    Returns:
    
    informix into table clause
  - setSelectToken
```
public void setSelectToken(TSourceToken selectToken)
```
  - getSelectToken
```
public TSourceToken getSelectToken()
```
    Returns:
    
    SELECT token of this query.
  - isTableQuery
```
public boolean isTableQuery()
```
    Whether this query was written as TABLE t, the SQL-standard shorthand for SELECT * FROM t.
    Such a query is analyzed as SELECT * FROM t: t is in TCustomSqlStatement.getTables() and TCustomSqlStatement.getJoins(), and getResultColumnList() holds one wildcard result column. That wildcard is synthesized: its tokens are not in the source token list, and the text has no SELECT or FROM keyword, so code that rewrites the token stream (a formatter) must leave the select list and the FROM list of such a query alone.
    
    Returns:
    
    true if this query was written as TABLE t
  - isAll
```
public boolean isAll()
```
  - isSetOpDistinct
```
public boolean isSetOpDistinct()
```
  - getSetOperatorType
```
public ESetOperatorType getSetOperatorType()
```
  - getWindowClause
```
public TWindowClause getWindowClause()
```
    Returns:
    
    window clause.
  - getLockingClauses
```
public TPTNodeList<TLockingClause> getLockingClauses()
```
    PostgreSQL, for update of, for read only.
    
    Returns:
    
    list of TLockingClause
  - getSelectDistinct
```
public TSelectDistinct getSelectDistinct()
```
    Returns:
    
    distinct clause
  - getIntoClause
```
public TIntoClause getIntoClause()
```
    Returns:
    
    into clause
  - getOrderbyClause
```
public TOrderBy getOrderbyClause()
```
    Returns:
    
    order by clause
  - getQualifyClause
```
public TQualifyClause getQualifyClause()
```
    Returns:
    
    teradata qualify clause
  - getTeradataWithClause
```
public TTeradataWithClause getTeradataWithClause()
```
    Returns:
    
    Teradata with clause
  - getSampleClause
```
public TSampleClause getSampleClause()
```
    Returns:
    
    SQL Server sample clause
  - getForUpdateClause
```
public TForUpdate getForUpdateClause()
```
    Returns:
    
    for update clause
  - getComputeClause
```
public TComputeClause getComputeClause()
```
    Returns:
    
    SQL Server compute clause
  - getGroupByClause
```
public TGroupBy getGroupByClause()
```
    Returns:
    
    group by clause and having clause
  - getHierarchicalClause
```
public THierarchical getHierarchicalClause()
```
    Oracle hierarchical_query_clause
    
    Returns:
    
    Oracle hierarchical_query_clause
  - getLimitClause
```
public TLimitClause getLimitClause()
```
    MySQL,PostgreSQL limit clause
    
    Returns:
    
    MySQL,PostgreSQL limit clause
  - getExpandOnClause
```
public TExpandOnClause getExpandOnClause()
```
    Returns:
    
    Teradata expand on clause
  - getSetOperator
```
public int getSetOperator()
```
    Deprecated. As of v1.6.4.2, use getSetOperatorType() and isAll() instead.
    
    The set operators UNION, EXCEPT, and INTERSECT correspond to the relational operators union, difference, and intersection.
    
    Returns:
    
    set operator of this statement.If a set operator is not used, setOperator_none will be returned. otherwise, set operand can be fetched by using getLeftStmt() and getRightStmt().
  - getLeftStmt
```
public TSelectSqlStatement getLeftStmt()
```
    Valid when getSetOperator() is not setOperator_none.
    
    Returns:
    
    left side query expression
  - getFarLeftStmt
```
public TSelectSqlStatement getFarLeftStmt()
```
  - getRightStmt
```
public TSelectSqlStatement getRightStmt()
```
    Valid when getSetOperator() is not setOperator_none.
    
    Returns:
    
    right side query expression.
  - isValueClause
```
public boolean isValueClause()
```
  - getHint
```
public String getHint()
```
    Hint for Oracle and MySQL
    
    Returns:
    
    hint string
  - getOracleHint
```
public String getOracleHint()
```
    Deprecated. As of 2.0.4.5, replaced by getHint()
  - getHiveHintClause
```
public THiveHintClause getHiveHintClause()
```
    Returns:
    
    Hive hint clause
  - getTransformClause
```
public THiveTransformClause getTransformClause()
```
    Returns:
    
    Hive from clause
  - getDistributeBy
```
public TDistributeBy getDistributeBy()
```
    Returns:
    
    Hive distribute by clause
  - getValueClause
```
public TValueClause getValueClause()
```
    DB2 value clause
    
    Returns:
    
    DB2 value clause
  - setChildOfCombinedQuery
```
public void setChildOfCombinedQuery(boolean childOfCombinedQuery)
```
  - isChildOfCombinedQuery
```
public boolean isChildOfCombinedQuery()
```
  - getExpandedResultColumns
```
public TreeMap<String,TResultColumn> getExpandedResultColumns()
```
    Overrides:
    
    getExpandedResultColumns in class TCustomSqlStatement
  - getFlattenedSelects
```
public ArrayList<TSelectSqlStatement> getFlattenedSelects()
```
  - doParseStatement
```
public int doParseStatement(TCustomSqlStatement psql)
```
    This function is used internal. DON'T call it explicitly.
    
    Overrides:
    
    doParseStatement in class TCustomSqlStatement
    
    Parameters:
    
    psql - input query.
    
    Returns:
    
    zero means there is no syntax error detected.
  - isCombinedQuery
```
public boolean isCombinedQuery()
```
    Determine whether The UNION, EXCEPT and INTERSECT operators were used.
    
    Returns:
    
    true if one of those operators were used.
  - accept
```
public void accept(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor
    
    Specified by:
    
    accept in interface Visitable
    
    Overrides:
    
    accept in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - acceptChildren
```
public void acceptChildren(TParseTreeVisitor v)
```
    Accept visitor to visit this class.
    
    Specified by:
    
    acceptChildren in interface Visitable
    
    Overrides:
    
    acceptChildren in class TParseTreeNode
    
    Parameters:
    
    v - user defined visitor.
  - addOrderBy
```
public TOrderBy addOrderBy(String orderByStr)
```
    Add an order by clause to this class.
    
    Parameters:
    
    orderByStr - new order by string
    
    Returns:
    
    added order by clause.
  - addCondition
```
public TWhereClause addCondition(String condition)
```
    this function is alias of addWhereClause
    
    Parameters:
    
    condition - new condition
    
    Returns:
    
    new where clause
  - addConditionOR
```
public TWhereClause addConditionOR(String condition)
```
  - addWhereClause
```
public TWhereClause addWhereClause(String condition)
```
    Overrides:
    
    addWhereClause in class TCustomSqlStatement
    
    Returns:
  - addWhereClauseOR
```
public TWhereClause addWhereClauseOR(String condition)
```
  - doAddWhereClause
```
protected TWhereClause doAddWhereClause(String condition,
                                        boolean isAnd)
```
  - getFromClause
```
public TFromClause getFromClause()
```
    Overrides:
    
    getFromClause in class TCustomSqlStatement
  - getResultColumnList
```
public TResultColumnList getResultColumnList(boolean useColumnsFromLeftmost)
```
  - getResultColumnList
```
public TResultColumnList getResultColumnList()
```
    Description copied from class: TCustomSqlStatement
    
    In select statement, this method returns Items in select_list. Can be *, expr, and name.*
    
    In update statement, this method returns assignments in set clause.
    
    Overrides:
    
    getResultColumnList in class TCustomSqlStatement
    
    Returns:
    
    select list of select statement or assignments of update statement.
  - getColumnsInFromClause
```
public ArrayList<String> getColumnsInFromClause()
```
  - addColumnInSelectListToSQLEnv
```
public void addColumnInSelectListToSQLEnv(TSQLTable sqlTable)
```
  - searchColumnInResultSet
```
public boolean searchColumnInResultSet(TObjectName pColumn,
                                       boolean pMustIn)
```
    search column in the select list Internal function, DON'T call it explicitly.
    
    Parameters:
    
    pColumn -
    
    pMustIn -
    
    Returns:
    
    true if found.

Class TSelectSqlStatement

Nested Class Summary

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

Field Summary

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class Object

Methods inherited from interface Iterator

Field Detail

SET_OPERATOR_NONE

setOperator_union

setOperator_unionall

SET_OPERATOR_UNIONDISTINCT

setOperator_intersect

setOperator_intersectall

SET_OPERATOR_INTERSECTDISTINCT

setOperator_minus

setOperator_minusall

SET_OPERATOR_MINUSDISTINCT

setOperator_except

setOperator_exceptall

SET_OPERATOR_EXCEPTDISTINCT

Constructor Detail

TSelectSqlStatement

Method Detail

getEndToken

setSubQueryInFromClauseCanUseParentSelectAsEnclosingScope

isSubQueryInFromClauseCanUseParentSelectAsEnclosingScope

isStarColumnPushedDown

setStarColumnPushedDown

getWithPlsqlItems

setWithPlsqlItems

getPipeOperators

setPipeOperators

isPipeQuery

setIsPipeQuery

getAttributes

getMultiSelectStatements

setClusterBy

getClusterBy

setConsume

isConsume

getHiveBodyList

setSelectModifiers

getSelectModifiers

setTimeTravel

setHintClause

getTimeTravel

getHintClause

setFetchFirstClause

setParenthesisCount

setParenthesisCountBeforeOrder

setAll

setSetOperatorType

setWindowClause

setLockingClauses

setSelectDistinct

setExpandOnClause

setSetOperator

setLeftStmt

setRightStmt

setValueClause

setOracleHint

setHiveHintClause

setTransformClause

setDistributeBy

setIntoClause

setOrderbyClause

setQualifyClause

setSampleClause

setTeradataWithClause

setForUpdateClause

setComputeClause

setGroupByClause

setHierarchicalClause

setLimitClause