TSelectSqlStatement (gudusoft.gsqlparser 2.0.1.0 API)

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

All Implemented Interfaces:

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

query specification including following clause:
- select list TCustomSqlStatement.getResultColumnList()
- 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.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`setOperator_except`
`static int`	`setOperator_exceptall`
`static int`	`setOperator_exceptdistinct`
`static int`	`setOperator_intersect`
`static int`	`setOperator_intersectall`
`static int`	`setOperator_intersectdistinct`
`static int`	`setOperator_minus`
`static int`	`setOperator_minusall`
`static int`	`setOperator_none`
`static int`	`setOperator_union`
`static int`	`setOperator_unionall`
`static int`	`setOperator_uniondistinct`

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement
dbvendor, dummytag, isparsed, joins, parser, plsqlparser, rootNode, sourcetokenlist, sqlstatementtype, tables

Constructor Summary

Constructors
Constructor and Description

TSelectSqlStatement(EDbVendor dbvendor)

Constructors
Constructor and Description
`TSelectSqlStatement(EDbVendor dbvendor)`

Method Summary

All 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.
`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.
`TComputeClause`	`getComputeClause()`
`THiveDistributeBy`	`getDistributeBy()`
`TExpandOnClause`	`getExpandOnClause()`
`TFetchFirstClause`	`getFetchFirstClause()` Fetch first/next clause
`TForUpdate`	`getForUpdateClause()`
`TGroupBy`	`getGroupByClause()`
`THierarchical`	`getHierarchicalClause()` Oracle hierarchical_query_clause
`THintClause`	`getHintClause()`
`THiveClusterBy`	`getHiveClusterBy()`
`THiveHintClause`	`getHiveHintClause()`
`TIntoClause`	`getIntoClause()`
`TIntoTableClause`	`getIntoTableClause()`
`TIsolationClause`	`getIsolationClause()`
`TSelectSqlStatement`	`getLeftStmt()` Valid when `getSetOperator()` is not setOperator_none.
`TLimitClause`	`getLimitClause()` MySQL,PostgreSQL limit clause
`ESqlClause`	`getLocation()` If this is sub-query inside a sql, then this value indicate where this sub-query appears, such as where clause, having clause and etc.
`TPTNodeList<TLockingClause>`	`getLockingClauses()` PostgreSQL, for update of, for read only.
`TOffsetClause`	`getOffsetClause()` Offset clause.
`TOptionClause`	`getOptionClause()`
`String`	`getOracleHint()`
`TOrderBy`	`getOrderbyClause()`
`int`	`getParenthesisCount()`
`int`	`getParenthesisCountBeforeOrder()`
`TQualifyClause`	`getQualifyClause()`
`TSelectSqlStatement`	`getRightStmt()` Valid when `getSetOperator()` is not setOperator_none.
`TSampleClause`	`getSampleClause()`
`TSelectDistinct`	`getSelectDistinct()`
`TSourceToken`	`getSelectToken()`
`int`	`getSetOperator()` Deprecated. As of v1.6.4.2, use `getSetOperatorType()` and `isAll()` instead.
`ESetOperatorType`	`getSetOperatorType()`
`THiveSortBy`	`getSortBy()`
`TTeradataWithClause`	`getTeradataWithClause()`
`TTimeTravel`	`getTimeTravel()`
`THiveTransformClause`	`getTransformClause()`
`TValueClause`	`getValueClause()` DB2 value clause
`TWindowClause`	`getWindowClause()`
`boolean`	`isAll()`
`boolean`	`isChildOfCombinedQuery()`
`boolean`	`isCombinedQuery()` Determine whether The UNION, EXCEPT and INTERSECT operators were used.
`boolean`	`isQueryOfCTE()`
`boolean`	`isSetOpDistinct()`
`boolean`	`searchColumnInResultSet(TObjectName pColumn, boolean pMustIn)` Internal function, DON'T call it explicitly.
`void`	`setAll(boolean all)`
`void`	`setChildOfCombinedQuery(boolean childOfCombinedQuery)`
`void`	`setComputeClause(TComputeClause computeClause)`
`void`	`setDistributeBy(THiveDistributeBy 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`	`setHiveClusterBy(THiveClusterBy hiveClusterBy)`
`void`	`setHiveHintClause(THiveHintClause hiveHintClause)`
`void`	`setIntoClause(TIntoClause intoClause)`
`void`	`setIntoTableClause(TIntoTableClause intoTableClause)`
`void`	`setIsolationClause(TIsolationClause isolationClause)`
`void`	`setLeftStmt(TSelectSqlStatement leftStmt)`
`void`	`setLimitClause(TLimitClause limitClause)`
`void`	`setLocation(ESqlClause location)`
`void`	`setLockingClauses(TPTNodeList<TLockingClause> lockingClauses)`
`void`	`setOffsetClause(TOffsetClause offsetClause)`
`void`	`setOptionClause(TOptionClause optionClause)`
`void`	`setOracleHint(String oracleHint)`
`void`	`setOrderbyClause(TOrderBy orderbyClause)`
`void`	`setParenthesisCount(int parenthesisCount)`
`void`	`setParenthesisCountBeforeOrder(int parenthesisCountBeforeOrder)`
`void`	`setQualifyClause(TQualifyClause qualifyClause)`
`void`	`setQueryOfCTE(boolean queryOfCTE)`
`void`	`setRightStmt(TSelectSqlStatement rightStmt)`
`void`	`setSampleClause(TSampleClause sampleClause)`
`void`	`setSelectDistinct(TSelectDistinct selectDistinct)`
`void`	`setSelectToken(TSourceToken selectToken)`
`void`	`setSetOperator(int setOperator)`
`void`	`setSetOperatorType(ESetOperatorType setOperatorType)`
`void`	`setSortBy(THiveSortBy sortBy)`
`void`	`setTeradataWithClause(TTeradataWithClause teradataWithClause)`
`void`	`setTimeTravel(TTimeTravel timeTravel)`
`void`	`setTransformClause(THiveTransformClause transformClause)`
`void`	`setValueClause(TValueClause valueClause)`
`void`	`setWindowClause(TWindowClause windowClause)`

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement
addToTables, analyzeFromTable, analyzeJoin, analyzeTablename, checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt, clearError, dochecksyntax, findTable, fireOnMetaDatabaseTableColumn, getAncestorStmt, getCteList, getDaxFunctionStack, getEndlabelName, getErrorCount, getFirstPhysicalTable, getIndexColumns, getJoins, getLabelName, getOrphanColumns, getOutputClause, getParentStmt, getResultColumnList, getReturningClause, getStatements, getSymbolTable, getTables, getTargetTable, getTopClause, getTopStatement, getVariableStack, getWhereClause, isnzplsql, isoracleplsql, ispgplsql, isTableACTE, isverticaplsql, linkColumnReferenceToTable, linkColumnToTable, linkToFirstTable, locateVariableOrParameter, OracleStatementCanBeSeparatedByBeginEndPair, parseerrormessagehandle, parsestatement, searchCTEList, searchDaxVariableInStack, setCteList, setEndlabelName, setLabelName, setOutputClause, setParentStmt, setResultColumnList, setReturningClause, setTargetTable, setTopClause, setVariableStack, setWhereClause, VerticaStatementCanBeSeparatedByBeginEndPair

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, appendString, doParse, fastSetString, getColumnNo, getDummyTag, getEndToken, getGsqlparser, getLineNo, getNodeType, getStartToken, init, init, init, init, init, init, removeAllMyTokensFromTokenList, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setGsqlparser, setIncludingComment, setNodeType, setStartToken, setStartToken, setStartToken, setStartToken, setString, toScript, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- setOperator_none
```
public static final int setOperator_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
- 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
- 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
- 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
- setOperator_uniondistinct
```
public static final int setOperator_uniondistinct
```
  See Also:
  
  Constant Field Values
- setOperator_intersectdistinct
```
public static final int setOperator_intersectdistinct
```
  See Also:
  
  Constant Field Values
- setOperator_exceptdistinct
```
public static final int setOperator_exceptdistinct
```
  See Also:
  
  Constant Field Values

Constructor Detail

TSelectSqlStatement

public TSelectSqlStatement(EDbVendor dbvendor)

Method Detail

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(THiveDistributeBy distributeBy)

setIntoClause

public void setIntoClause(TIntoClause intoClause)

setOrderbyClause

public void setOrderbyClause(TOrderBy orderbyClause)

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)

setHiveClusterBy

public void setHiveClusterBy(THiveClusterBy hiveClusterBy)

setSortBy

public void setSortBy(THiveSortBy 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()
```

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

setLocation

public void setLocation(ESqlClause location)

getLocation
```
public ESqlClause getLocation()
```
If this is sub-query inside a sql, then this value indicate where this sub-query appears, such as where clause, having clause and etc.

getIsolationClause

public TIsolationClause getIsolationClause()

Returns:: isolation clause

getHiveClusterBy

public THiveClusterBy getHiveClusterBy()

Returns:: Hive cluster by clause

getSortBy
```
public THiveSortBy 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.

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

getRightStmt
```
public TSelectSqlStatement getRightStmt()
```
Valid when getSetOperator() is not setOperator_none.

Returns:

right side query expression.

getOracleHint
```
public String getOracleHint()
```
Returns:

Oracle hint string.

getHiveHintClause

public THiveHintClause getHiveHintClause()

Returns:: Hive hint clause

getTransformClause

public THiveTransformClause getTransformClause()

Returns:: Hive from clause

getDistributeBy

public THiveDistributeBy 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()

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

addWhereClauseOR

public TWhereClause addWhereClauseOR(String condition)

doAddWhereClause

protected TWhereClause doAddWhereClause(String condition,
                                        boolean isAnd)

searchColumnInResultSet

public boolean searchColumnInResultSet(TObjectName pColumn,
                                       boolean pMustIn)

Internal function, DON'T call it explicitly.

Parameters:: pColumn -; pMustIn -
Returns:: true if found.

Class TSelectSqlStatement

Field Summary

Fields inherited from class gudusoft.gsqlparser.TCustomSqlStatement

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.TCustomSqlStatement

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class java.lang.Object

Field Detail

setOperator_none

setOperator_union

setOperator_unionall

setOperator_intersect

setOperator_intersectall

setOperator_minus

setOperator_minusall

setOperator_except

setOperator_exceptall

setOperator_uniondistinct

setOperator_intersectdistinct

setOperator_exceptdistinct

Constructor Detail

TSelectSqlStatement

Method Detail

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

setOffsetClause

setOptionClause

setIsolationClause

setHiveClusterBy

setSortBy

setIntoTableClause

getParenthesisCountBeforeOrder

getParenthesisCount

setQueryOfCTE

isQueryOfCTE

getOffsetClause

getFetchFirstClause

getOptionClause

setLocation

getLocation

getIsolationClause

getHiveClusterBy

getSortBy

getIntoTableClause

setSelectToken

getSelectToken

isAll

isSetOpDistinct

getSetOperatorType

getWindowClause