TCustomSqlStatement (General SQL Parser Java Library Core 3.0.9.1 API)

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

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

Direct Known Subclasses:

TAllocateStmt, TAlterAccessPolicy, TAlterAccountStmt, TAlterAuditPolicyStmt, TAlterAuthentication, TAlterConstraintStmt, TAlterCredentialStmt, TAlterDatabaseStmt, TAlterFaultGroup, TAlterFileFormatStmt, TAlterFulltextIndexStmt, TAlterFunctionStmt, TAlterGroup, TAlterIndexStmt, TAlterJWTProviderStmt, TAlterLDAPProviderStmt, TAlterLibraryStmt, TAlterMaterializedViewStmt, TAlterNetworkInterface, TAlterNetworkPolicyStmt, TAlterNode, TAlterPackageStmt, TAlterPartitionFunctionStmt, TAlterPartitionSchemeSqlStatement, TAlterPartitionSchemeStmt, TAlterPipeStmt, TAlterProcedureStmt, TAlterProfile, TAlterProjectionRename, TAlterPSEStmt, TAlterRelation, TAlterRemoteSourceStmt, TAlterResourceMonitorStmt, TAlterResourcePool, TAlterRoleStmt, TAlterSAMLProviderStmt, TAlterSchemaStmt, TAlterSequenceStatement, TAlterSessionStatement, TAlterShareStmt, TAlterStageStmt, TAlterStatisticsStmt, TAlterSubnet, TAlterSynonymStmt, TAlterSystemStmt, TAlterTaskStmt, TAlterTriggerStmt, TAlterTypeStatement, TAlterUserGroupStmt, TAlterUserStmt, TAlterVirtualTableStmt, TAlterWarehouseStmt, TAlterWorkloadClassStmt, TAlterWorkloadMappingStmt, TAlterZoneStmt, TAnalyzeStmt, TAssignStmt, TBackupCancelStmt, TBackupCatalogDeleteStmt, TBackupCheckStmt, TBackupDataStmt, TBackupListDataStmt, TBasicStmt, TBeginTran, TBlockSqlStatement, TBreakStmt, TCacheTable, TCallStatement, TCaseStmt, TCheckWorkload, TCloseStmt, TCommentOnSqlStmt, TCommitStmt, TComputeStats, TConnectStmt, TConvertToDeltaStmt, TCopyStmt, TCreateAccessPolicy, TCreateAliasStmt, TCreateAuditPolicyStmt, TCreateAuthentication, TCreateCatalogStmt, TCreateCertificateStmt, TCreateCollectionStmt, TCreateCredentialStmt, TCreateDatabaseLinkStmt, TCreateDatabaseSqlStatement, TCreateEventSession, TCreateExtensionStmt, TCreateExternalDataSourceStmt, TCreateExternalLanguage, TCreateExternalLocationStmt, TCreateFaultGroup, TCreateFileFormatStmt, TCreateFulltextIndexStmt, TCreateGraphWorkspaceStmt, TCreateGroup, TCreateHCatalogSchema, TCreateIndexSqlStatement, TCreateJWTProviderStmt, TCreateLDAPProviderStmt, TCreateMasterKeyStmt, TCreateMaterializedSqlStatement, TCreateMaterializedViewLogSqlStatement, TCreateNetworkPolicyStmt, TCreatePartitionFunctionStmt, TCreatePartitionSchemeSqlStatement, TCreatePartitionSchemeStmt, TCreatePipeStmt, TCreatePSEStmt, TCreateRemoteSourceStmt, TCreateResourceMonitorStmt, TCreateRoleStmt, TCreateSAMLProviderStmt, TCreateSequenceStmt, TCreateShareStmt, TCreateStageStmt, TCreateStatistics, TCreateStreamStmt, TCreateStructuredPrivilegeStmt, TCreateSubnet, TCreateSynonymStmt, TCreateTablespaceStmt, TCreateTableSqlStatement, TCreateTaskStmt, TCreateTypeStmt, TCreateUserGroupStmt, TCreateUserStmt, TCreateViewSqlStatement, TCreateVirtualFunctionStmt, TCreateVirtualProcedureStmt, TCreateVirtualTableStmt, TCreateWarehouseStmt, TCreateWorkloadClassStmt, TCreateWorkloadMappingStmt, TCreateZoneStmt, TCursorDeclStmt, TCustomDb2Stmt, TCustomDropStatement, TCustomMySQLStmt, TCustomOracleSqlStmt, TDaxStmt, TDb2StmtStub, TDeclareCursorStmt, TDeleteSqlStatement, TDenyStmt, TDescribeStmt, TDisableEnableTriggerStmt, TDisconnectStmt, TDropAccessPolicy, TDropAggregateFunction, TDropAuthentication, TDropConstraintStmt, TDropDatabaseLinkStmt, TDropDatabaseStmt, TDropFaultGroup, TDropFunctionStmt, TDropGroup, TDropLibraryStmt, TDropMacro, TDropMaterializedViewLogStmt, TDropMaterializedViewStmt, TDropNetworkInterface, TDropPartitionSchemeStmt, TDropProcedureStmt, TDropProfileStmt, TDropProjectionStmt, TDropResourcePool, TDropRoleSqlStatement, TDropRoleStmt, TDropSchemaSqlStatement, TDropSequenceStmt, TDropStmt, TDropStreamStmt, TDropSubnet, TDropSynonymStmt, TDropTableSqlStatement, TDropTextIndex, TDropTransformFunction, TDropTriggerSqlStatement, TDropUserStmt, TDropViewSqlStatement, TElsifStmt, TEndTran, TExecutePreparedStatement, TExecuteSqlStatement, TExitStmt, TExplainPlan, TExportDataStmt, TExportStmt, TExportToVertica, TFetchFromStmt, TFetchStmt, TGetDiagnosticsStmt, TGetDiagStmt, TGetStmt, TGrantSqlStatement, TGrantStmt, THelpProcedure, THiveCreateFunction, THiveCreateRole, THiveDescribe, THiveDropDatabase, THiveDropFunction, THiveDropRole, THiveExplain, THiveExportTable, THiveGrant, THiveGrantRole, THiveImportTable, THiveLoad, THiveRevoke, THiveRevokeRole, THiveSet, THiveShow, THiveShowGrant, THiveShowRoleGrant, THiveSwitchDatabase, THiveUnlockTable, TIfStmt, TImportStmt, TInferKeyspaceStmt, TInformixAllocateCollectionStmt, TInformixAllocateDescriptorStmt, TInformixAllocateRow, TInformixAlterAccess_MethodStmt, TInformixAlterFragment, TInformixCreateRowTypeStmt, TInformixCreateTrigger, TInformixDropRowTypeStmt, TInformixExecuteFunction, TInformixExecuteImmediate, TInformixExecuteProcedure, TInformixExecuteStmt, TInsertBulk, TInsertSqlStatement, TIterateStmt, TLeaveStmt, TListStmt, TLoadStmt, TLockSqlStatement, TLockTableStmt, TMdxAlterCube, TMdxCalculate, TMdxCall, TMdxCase, TMdxClearCalculations, TMdxCreateAction, TMdxCreateCellCalculation, TMdxCreateGlobalCube, TMdxCreateMeasure, TMdxCreateMember, TMdxCreateSessionCube, TMdxCreateSet, TMdxCreateSubCube, TMdxDrillthrough, TMdxDropAction, TMdxDropCellCalculation, TMdxDropMember, TMdxDropSet, TMdxDropSubcube, TMdxExpression, TMdxFreeze, TMdxIf, TMdxRefreshCube, TMdxScope, TMdxSelect, TMdxUpdate, TMergeDeltaStmt, TMergeSqlStatement, TMoveStmt, TMSCKStmt, TMssqlAlterSecurityPolicy, TMssqlBeginConversationTimer, TMssqlBeginDialog, TMssqlBulkInsert, TMssqlClose, TMssqlCommit, TMssqlContinue, TMssqlCopyIntoStmt, TMssqlCreateSecurityPolicy, TMssqlCreateType, TMssqlCreateXmlSchemaCollectionStmt, TMssqlDeallocate, TMssqlDeclare, TMssqlDropDbObject, TMssqlDropSecurityPolicy, TMssqlDropTable, TMssqlDropView, TMssqlDummyStmt, TMssqlEndConversation, TMssqlErrorStmt, TMssqlExecute, TMssqlExecuteAs, TMssqlFetch, TMssqlGo, TMssqlGoTo, TMssqlGrant, TMssqlIfElse, TMssqlLabel, TMssqlOpen, TMssqlPrint, TMssqlRaiserror, TMssqlReturn, TMssqlRevert, TMssqlRollback, TMssqlSaveTran, TMssqlSendOnConversation, TMssqlSet, TMssqlSetRowCount, TMssqlStmtStub, TMssqlThrow, TMssqlUpdateStatistics, TMssqlUpdateText, TMssqlWaitFor, TMssqlWithas, TMySQLOptimizeTableStmt, TMySQLStmtStub, TNetezzaGenerateStatistics, TNetezzaGroomTable, TNullStmt, TOpenforStmt, TOpenStmt, TOptimizeStmt, TOracleCreateLibraryStmt, TOracleExecuteProcedure, TParseErrorSqlStatement, TPerformanceStmt, TPgImport, TPlsqlContinue, TPlsqlCreateTriggerSqlStatement, TPlsqlCreateType, TPlsqlCreateType_Placeholder, TPlsqlDummyStmt, TPlsqlForallStmt, TPlsqlGotoStmt, TPlsqlNullStmt, TPlsqlPipeRowStmt, TPlsqlPragmaDeclStmt, TPlsqlProcedureSpecStmt, TPlsqlRecordTypeDefStmt, TPlsqlSqlStmt, TPlsqlStatement, TPlsqlSubProgram, TPlsqlTableTypeDefStmt, TPlsqlVarrayTypeDefStmt, TPostgresqlTableStmt, TPrepareStmt, TProfileStmt, TPseudoExprStmt, TPutStmt, TRaiseStmt, TReconfigure, TRecoverDatabaseStmt, TRecoverDataStmt, TRedshiftAbort, TRedshiftAlterSchema, TRedshiftAlterUser, TRedshiftAnalyze, TRedshiftAnalyzeCompression, TRedshiftBegin, TRedshiftCancel, TRedshiftClose, TRedshiftComment, TRedshiftCommit, TRedshiftCopy, TRedshiftCreateSchema, TRedshiftCreateUser, TRedshiftDeallocate, TRedshiftDeclare, TRedshiftDropSchema, TRedshiftDropUser, TRedshiftEnd, TRedshiftExplain, TRedshiftLock, TRedshiftPrepare, TRedshiftReset, TRedshiftRollback, TRedshiftSessionAuthorization, TRedshiftUnload, TRedshiftVacuum, TRefresh, TRefreshMaterializedViewStmt, TRefreshStatisticsStmt, TReindexStmt, TReleaseSavepointStmt, TRemoveStmt, TRenameStmt, TReorgTableStmt, TResetSessionStmt, TResetStmt, TResourceManagement, TRestoreTableStmt, TReturnStmt, TRevokeStmt, TRollbackStmt, TSavepointStmt, TSelectSqlStatement, TSetCatalogStmt, TSetDatabaseObjectStmt, TSetSchemaStmt, TSetSearchPathStmt, TSetStmt, TShowProcedure, TShowSearchPathStmt, TShowStmt, TSignalStmt, TSlashCommand, TSnowflakeCopyIntoStmt, TSqlplusCmdStatement, TStartTransactionStmt, TSybaseDeleteStatistics, TSybaseDumpTran, TSybaseUpdateIndexStatistics, TSybaseWritetext, TTBuildIndexesStmt, TTeradataAbort, TTeradataBeginLogging, TTeradataBeginTransaction, TTeradataBTEQCmd, TTeradataCollectStatistics, TTeradataCommit, TTeradataCreateTrigger, TTeradataDropDbObject, TTeradataEndLogging, TTeradataExecute, TTeradataFastExportCmd, TTeradataFastLoadCmd, TTeradataGive, TTeradataGrant, TTeradataLock, TTeradataMultiLoadCmd, TTeradataMultiLoadExport, TTeradataMultiLoadImport, TTeradataMultiLoadLayout, TTeradataNotImplement, TTeradataReleaseLockStmt, TTeradataRollback, TTeradataSetRole, TTeradataSetSession, TTeradataSetTimezone, TTeradataStmtStub, TTeradataUsing, TTruncateCollectionStmt, TTruncateStatement, TUndropStmt, TUnknownSqlStatement, TUnloadStmt, TUnsetStmt, TUpdateSqlStatement, TUpsertStmt, TUseDatabase, TUseRole, TUseSchema, TUseSecondaryRolesStmt, TUseStmt, TUseWarehouse, TVacuumStmt, TValidateLDAPProviderStmt, TValidateUserStmt, TVarDeclStmt, TVerticaSetStmt, TVerticaShow
```
public class TCustomSqlStatement
extends TParseTreeNode
implements IRelation
```
TCustomSqlStatement is the root class for all SQL statements.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`dummytag` Tag used by parser internally.
`protected TFromClause`	`fromClause`
`protected TJoinExpr`	`fromSourceJoin`
`protected TTable`	`fromSourceTable`
`protected boolean`	`isparsed`
`TJoinList`	`joins` joins represents table sources in the from clause.
`TCustomParser`	`parser` Parser used to parse this statement.
`TCustomParser`	`plsqlparser` PLSQL parser used to parse this statement.
`protected ArrayList<TAttributeNode>`	`relationAttributes`
`TParseTreeNode`	`rootNode` Original Parse tree node from parser
`TSourceTokenList`	`sourcetokenlist` Source tokens included in this statement.
`ESqlStatementType`	`sqlstatementtype` Type of this statement.
`protected gudusoft.gsqlparser.compiler.TStmtScope`	`stmtScope` Original SQL fragment of this statement.
`TTableList`	`tables` Provides a quick way to access all tables involved in this SQL statement.

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
dbvendor, doubleLinkedTokenListToString, nodeActionAppend, nodeActionInsert, nodeActionRemove, nodeActionUnknown, nodeActionUpdate, nodeActionUpdateText, nodeChangeEndToken, nodeChangeStartToken

Constructor Summary

Constructors
Constructor and Description

TCustomSqlStatement(EDbVendor dbvendor)

Constructors
Constructor and Description
`TCustomSqlStatement(EDbVendor dbvendor)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addToTables(TTable pTable)`
`TWhereClause`	`addWhereClause(String condition)` Deprecated. As of 2.0.9.0, use `setWhereClause(TWhereClause)` instead Or, use `TWhereClause.setText(String)`
`TTable`	`analyzeFromTable(TFromTable pfromTable, Boolean addToTableList)`
`TTable`	`analyzeFromTable(TFromTable pfromTable, Boolean addToTableList, ESqlClause pLocation)`
`TJoin`	`analyzeJoin(TJoinExpr pJoinExpr, TJoin pJoin, Boolean isSub)`
`TTable`	`analyzeTablename(TObjectName tableName)`
`TJoin`	`analyzeTableOrJoin(TFromTable pfromTable)`
`String`	`asCanonical()` this method return a canonical form of a SQL statement in plan text.
`boolean`	`checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt(TObjectName crf, boolean sameLevelOnly)` Found out is a non qualified column is a column in uplevel subquery table like this: take ma_parkey for example: ma_parkey is not a physical column SELECT c_mandant , CASE WHEN EXISTS (SELECT 1 FROM CDS_H_GRUPPE GRP1 WHERE GRP1.c_mandant = c_mandant AND GRP1.parkey1 = ma_parkey) THEN 1 ELSE NULL END MA_ME FROM (SELECT c_mandant , CASE WHEN funktionscode = 'U' THEN parkey1 ELSE parkey2 END MA_PARKEY FROM CDS_H_GRUPPE )
`void`	`clearError()`
`protected int`	`dochecksyntax(TCustomSqlStatement psql)`
`int`	`doParseStatement(TCustomSqlStatement psql)`
`TTable`	`findTable(ETableEffectType[] tableEffectTypes)`
`boolean`	`fireOnMetaDatabaseTableColumn(String pServer, String pDatabase, String pSchema, String pTable, String pColumn)`
`TCustomSqlStatement`	`getAncestorStmt()`
`ArrayList<TAttributeNode>`	`getAttributes()` 每个 relation 包含的 attributes 当它为 base table 时，这些 attributes 的来源有三种可能 1.
`ArrayList<String>`	`getColumnsInTable(String pServer, String pDatabase, String pSchema, String pTable)` Deprecated. since 2.3.8.2, use `TTable.getExpandedStarColumns()` instead.
`ArrayList<String>`	`getColumnsInTable(TTable lcTable)` Deprecated. since 2.3.8.2, use `TTable.getExpandedStarColumns()` instead.
`TCTE`	`getCteIncludeThisStmt()`
`TCTEList`	`getCteList()` Multiple common table expressions `TCTE` can be specified following the single WITH keyword.
`Stack<TDaxFunction>`	`getDaxFunctionStack()`
`TObjectName`	`getEndlabelName()`
`int`	`getErrorCount()` Number of syntax errors for this statement.
`String`	`getErrormessage()`
`TreeMap<String,TResultColumn>`	`getExpandedResultColumns()`
`TTable`	`getFirstPhysicalTable()`
`Stack<gudusoft.gsqlparser.compiler.TFrame>`	`getFrameStack()`
`TFromClause`	`getFromClause()`
`TJoinExpr`	`getFromSourceJoin()` This is a join in from clause, including left and right relation.
`TTable`	`getFromSourceTable()` This is table in from clause if only one table is listed in the from clause, If more than one table is listed in from clause, please check `getFromSourceJoin()` instead.
`gudusoft.gsqlparser.compiler.TGlobalScope`	`getGlobalScope()`
`TPTNodeList<TColumnWithSortOrder>`	`getIndexColumns()`
`TJoinList`	`getJoins()`
`TObjectName`	`getLabelName()`
`TObjectNameList`	`getOrphanColumns()`
`TOutputClause`	`getOutputClause()`
`TParseTreeNode`	`getParentObjectName()`
`TCustomSqlStatement`	`getParentStmt()`
`String`	`getRelationName()`
`ArrayList<TTable>`	`getRelations()` Relations that used in from clause of select statement.
`TResultColumnList`	`getResultColumnList()` In select statement, this method returns Items in select_list.
`TReturningClause`	`getReturningClause()`
`TSQLEnv`	`getSqlEnv()`
`TStatementList`	`getStatements()` Saves all first level sub statements.
`gudusoft.gsqlparser.compiler.TStmtScope`	`getStmtScope()`
`Stack`	`getSymbolTable()` Deprecated. since ver 2.5.3.5, please use `TStmtScope` instead
`ArrayList<TSyntaxError>`	`getSyntaxErrors()`
`ArrayList<TSyntaxError>`	`getSyntaxHints()`
`TTableList`	`getTables()`
`TTable`	`getTargetTable()` target table in the delete/insert/update/create table statement.
`TSourceTokenList`	`getTokenList()`
`TTopClause`	`getTopClause()`
`TCustomSqlStatement`	`getTopStatement()`
`TColumnDefinitionList`	`getUsingVariableList()`
`Stack<TObjectName>`	`getVariableStack()`
`TWhereClause`	`getWhereClause()` restrict the rows selected to those that satisfy one or more conditions.
`boolean`	`isathenaplsql()`
`boolean`	`isBigQueryplsql()`
`boolean`	`isdatabricksplsql()`
`boolean`	`isGaussDBStoredProcedure()`
`boolean`	`isgreeplumplsql()`
`boolean`	`isnzplsql()`
`boolean`	`isoracleplsql()`
`boolean`	`ispgplsql()`
`boolean`	`isprestoplsql()`
`boolean`	`issnowflakeplsql()`
`protected boolean`	`isTableACTE(TTable pTable)`
`boolean`	`isverticaplsql()`
`void`	`linkColumnReferenceToTable(TObjectName cr, ESqlClause plocation)` Deprecated. As of v1.6.0.1, use `linkColumnToTable(gudusoft.gsqlparser.nodes.TObjectName, gudusoft.gsqlparser.ESqlClause)` instead
`boolean`	`linkColumnToTable(TObjectName pColumn, ESqlClause pLocation)`
`protected boolean`	`linkToFirstTable(TObjectName pColumn, int pCandidateTableCnt)`
`boolean`	`locateVariableOrParameter(TObjectName cr)`
`boolean`	`locateVariableOrParameter(TObjectName cr, boolean checkVariableDeclaredInProcedure)`
`boolean`	`OracleStatementCanBeSeparatedByBeginEndPair()`
`EActionOnParseError`	`parseerrormessagehandle(TSyntaxError se)` Log error messages if syntax errors found while parsing this statement.
`int`	`parsestatement(TCustomSqlStatement pparentsql, boolean isparsetreeavailable)`
`int`	`parsestatement(TCustomSqlStatement pparentsql, boolean isparsetreeavailable, boolean onlyNeedRawParseTree)` Parse this statement.
`protected TCTEList`	`searchCTEList(Boolean stopAtFirstFinding)`
`boolean`	`searchDaxVariableInStack(TObjectName pName)`
`TSQLFunction`	`searchFunctionInSQLEnv(String functionName)`
`void`	`setAlreadyAddToParent(boolean alreadyAddToParent)`
`void`	`setCteIncludeThisStmt(TCTE cteIncludeThisStmt)`
`void`	`setCteList(TCTEList cteList)`
`void`	`setEndlabelName(TObjectName endlabelName)`
`void`	`setFrameStack(Stack<gudusoft.gsqlparser.compiler.TFrame> frameStack)`
`void`	`setFromClause(TFromClause fromClause)`
`void`	`setLabelName(TObjectName lName)`
`void`	`setOutputClause(TOutputClause outputClause)`
`void`	`setParentStmt(TCustomSqlStatement parentStmt)`
`void`	`setParentStmtToNull()`
`void`	`setResultColumnList(TResultColumnList resultColumnList)`
`void`	`setReturningClause(TReturningClause returningClause)`
`void`	`setStmtScope(gudusoft.gsqlparser.compiler.TStmtScope stmtScope)`
`void`	`setTargetTable(TTable targetTable)`
`void`	`setTopClause(TTopClause topClause)`
`void`	`setUsingVariableList(TColumnDefinitionList usingVariableList)`
`void`	`setVariableStack(Stack<TObjectName> variableStack)`
`void`	`setWhereClause(TWhereClause newWhereClause)`
`int`	`size()`
`String`	`toScript()` Return the text string of this node, the return value is the same as `TParseTreeNode.toString()` if this node is not modified manually after created by parser.
`boolean`	`VerticaStatementCanBeSeparatedByBeginEndPair()`

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
accept, acceptChildren, 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, 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
  - relationAttributes
```
protected ArrayList<TAttributeNode> relationAttributes
```
  - fromClause
```
protected TFromClause fromClause
```
  - fromSourceTable
```
protected TTable fromSourceTable
```
  - fromSourceJoin
```
protected TJoinExpr fromSourceJoin
```
  - sqlstatementtype
```
public ESqlStatementType sqlstatementtype
```
    Type of this statement.
  - sourcetokenlist
```
public TSourceTokenList sourcetokenlist
```
    Source tokens included in this statement. only source tokens available when this is a top level statement, otherwise, there is no source token in this statement. Please check TParseTreeNode.getStartToken(), and TParseTreeNode.getEndToken() of this statement.
  - parser
```
public TCustomParser parser
```
    Parser used to parse this statement.
  - plsqlparser
```
public TCustomParser plsqlparser
```
    PLSQL parser used to parse this statement.
  - dummytag
```
public int dummytag
```
    Tag used by parser internally.
  - joins
```
public TJoinList joins
```
    joins represents table sources in the from clause. All structure information was reserved.
    SQL 1:
    select f from t1
    size of joins will be 1, t1 can be fetch via joins.getJoin(0).getTable()
    
    SQL 2:
    select f from t1,t2
    size of joins will be 2,
    t1 can be fetch via joins.getJoin(0).getTable()
    t2 can be fetch via joins.getJoin(1).getTable()
    
    SQL 3:
    select f from t1 join t2 on t1.f1 = t2.f1
    size of joins will be 1,
    t1 information can be fetch via joins.getJoin(0).getTable()
    In order to access t2, we need to introduce a new class TJoinItem which includes all information about t2 and join condition.
    There is a property named joinItems of TJoin which is type of TJoinItemList that includes a list of TJoinItem.
    this property can be access via TJoin.getJoinItems().
    Now, t2 can be fetch via joins.getJoin(0).getJoinItems().getJoinItem(0).getTable()
    
    SQL 4:
    select f from t1 join t2 on t1.f1 = t2.f1 join t3 on t1.f1 = t3.f1
    size of joins will be 1,
    t1 can be fetch via joins.getJoin(0).getTable()
    t2 can be fetch via joins.getJoin(0).getJoinItems().getJoinItem(0).getTable()
    t3 can be fetch via joins.getJoin(0).getJoinItems().getJoinItem(1).getTable()
    See Also:
    
    tables
  - tables
```
public TTableList tables
```
    Provides a quick way to access all tables involved in this SQL statement.
    It stores all tables in a flat way while joins stores all tables in a hierarchical structure.
    joins only represents tables in from clause of select/delete statement, and tables in update/insert statement.
    tables includes all tables in all types of SQL statements such as tables involved in a create table or create trigger statements.
  - rootNode
```
public TParseTreeNode rootNode
```
    Original Parse tree node from parser
  - isparsed
```
protected boolean isparsed
```
  - stmtScope
```
protected gudusoft.gsqlparser.compiler.TStmtScope stmtScope
```
    Original SQL fragment of this statement.
- Constructor Detail
  - TCustomSqlStatement
```
public TCustomSqlStatement(EDbVendor dbvendor)
```
- Method Detail
  - setUsingVariableList
```
public void setUsingVariableList(TColumnDefinitionList usingVariableList)
```
  - getUsingVariableList
```
public TColumnDefinitionList getUsingVariableList()
```
  - getAttributes
```
public ArrayList<TAttributeNode> getAttributes()
```
    Description copied from interface: IRelation
    
    每个 relation 包含的 attributes 当它为 base table 时，这些 attributes 的来源有三种可能 1. 来自数据库的 metadata，第一次 resolve 时就可以获取，来自 sqlenv 2. 来自 create table ddl，第一次 resolve 时就可以获取，来自 sqlenv 3. 来自 sql script，第二次 resolve 时，来自relation的 referenceAttribute 属性。第一、二中来源是可靠的来源，attributes应该是完整的，第三种推断自 sql script，attributes很可能是不完整的。
    
    Specified by:
    
    getAttributes in interface IRelation
    
    Returns:
  - getRelationName
```
public String getRelationName()
```
    Specified by:
    
    getRelationName in interface IRelation
  - size
```
public int size()
```
    Specified by:
    
    size in interface IRelation
  - toScript
```
public String toScript()
```
    Description copied from class: TParseTreeNode
    
    Return the text string of this node, the return value is the same as TParseTreeNode.toString() if this node is not modified manually after created by parser.
    If this node is modified, then use this method to get string representation instead of the TParseTreeNode.toString() method.
    
    Overrides:
    
    toScript in class TParseTreeNode
    
    Returns:
    
    text string of this node
  - setFromClause
```
public void setFromClause(TFromClause fromClause)
```
  - getFromClause
```
public TFromClause getFromClause()
```
  - getRelations
```
public ArrayList<TTable> getRelations()
```
    Relations that used in from clause of select statement. Or tables of other statements such as insert, update, delete and etc Please use this property to get the relations instead of getTables() and getJoins()after version 2.7.4.0 when a join is used in from clause, then the table in getRelations() is type of ETableSource.join, and you can use TTable.getJoinExpr() to get this join.
    
    Returns:
  - getFromSourceTable
```
public TTable getFromSourceTable()
```
    This is table in from clause if only one table is listed in the from clause, If more than one table is listed in from clause, please check getFromSourceJoin() instead.
    
    Returns:
    
    table in from clause
  - getFromSourceJoin
```
public TJoinExpr getFromSourceJoin()
```
    This is a join in from clause, including left and right relation. If only a single table is listed in from clause, please use getFromSourceTable() instead
    
    Returns:
  - asCanonical
```
public String asCanonical()
```
    this method return a canonical form of a SQL statement in plan text.
    1. remove all comment inside SQL query.
    2. remove redundant parenthesis at the begin/end of a select statement.
    3. replace all number in where clause with 999 constant
    4. replace all string constant in where clause with 'placeholder_str'
    5. all number elements in a list such as (1,2,3,4) will be change to a single element (999)
    6. all string elements in a list such as ('a','b','c','d') will be change to a single element ('placeholder_str')
    
    Returns:
    
    a canonical form of a SQL statement in plan text.
  - setCteIncludeThisStmt
```
public void setCteIncludeThisStmt(TCTE cteIncludeThisStmt)
```
  - getCteIncludeThisStmt
```
public TCTE getCteIncludeThisStmt()
```
  - getExpandedResultColumns
```
public TreeMap<String,TResultColumn> getExpandedResultColumns()
```
  - searchFunctionInSQLEnv
```
public TSQLFunction searchFunctionInSQLEnv(String functionName)
```
  - getSqlEnv
```
public TSQLEnv getSqlEnv()
```
  - getGlobalScope
```
public gudusoft.gsqlparser.compiler.TGlobalScope getGlobalScope()
```
  - setFrameStack
```
public void setFrameStack(Stack<gudusoft.gsqlparser.compiler.TFrame> frameStack)
```
  - getFrameStack
```
public Stack<gudusoft.gsqlparser.compiler.TFrame> getFrameStack()
```
  - getIndexColumns
```
public TPTNodeList<TColumnWithSortOrder> getIndexColumns()
```
  - setVariableStack
```
public void setVariableStack(Stack<TObjectName> variableStack)
```
  - getVariableStack
```
public Stack<TObjectName> getVariableStack()
```
  - getDaxFunctionStack
```
public Stack<TDaxFunction> getDaxFunctionStack()
```
  - setLabelName
```
public void setLabelName(TObjectName lName)
```
  - getLabelName
```
public TObjectName getLabelName()
```
    Returns:
    
    label name used in plsql statement.
  - setEndlabelName
```
public void setEndlabelName(TObjectName endlabelName)
```
  - getEndlabelName
```
public TObjectName getEndlabelName()
```
  - getTokenList
```
public TSourceTokenList getTokenList()
```
  - getTargetTable
```
public TTable getTargetTable()
```
    target table in the delete/insert/update/create table statement.
    
    See Also:
    
    joins, TSelectSqlStatement, TDeleteSqlStatement, TUpdateSqlStatement, TCreateTableSqlStatement, TMergeSqlStatement
  - setTargetTable
```
public void setTargetTable(TTable targetTable)
```
  - getJoins
```
public TJoinList getJoins()
```
  - getTables
```
public TTableList getTables()
```
  - getStatements
```
public TStatementList getStatements()
```
    Saves all first level sub statements.
    By iterating statements recursively, you can fetch all included statements in an easy way.
    select f1+(select f2 from t2) from t1 where f2 > all (select f3 from t3 where f4 = (select f5 from t4))
    Statements included in above SQL was save in a hierarchical way like this:
    - (select f2 from t2)
    - (select f3 from t3 where f4 = (select f5 from t4))
      
      (select f5 from t4)
    If this statement is a create procedure/function statement, then all declaration statements and statements in procedure body can also be fetched quickly by iterating this property recursively.
  - setCteList
```
public void setCteList(TCTEList cteList)
```
  - getCteList
```
public TCTEList getCteList()
```
    Multiple common table expressions TCTE 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.
    Used in select, delete, update statement.
    
    Returns:
    
    List of common table expression.
  - setResultColumnList
```
public void setResultColumnList(TResultColumnList resultColumnList)
```
  - getResultColumnList
```
public TResultColumnList getResultColumnList()
```
    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.
    
    Returns:
    
    select list of select statement or assignments of update statement.
  - setReturningClause
```
public void setReturningClause(TReturningClause returningClause)
```
  - getReturningClause
```
public TReturningClause getReturningClause()
```
    Returns:
    
    returning clause.
  - setOutputClause
```
public void setOutputClause(TOutputClause outputClause)
```
  - getOutputClause
```
public TOutputClause getOutputClause()
```
    Returns:
    
    output clause.
  - setTopClause
```
public void setTopClause(TTopClause topClause)
```
  - getTopClause
```
public TTopClause getTopClause()
```
    Returns:
    
    top clause.
  - setWhereClause
```
public void setWhereClause(TWhereClause newWhereClause)
```
  - addWhereClause
```
public TWhereClause addWhereClause(String condition)
```
    Deprecated. As of 2.0.9.0, use setWhereClause(TWhereClause) instead Or, use TWhereClause.setText(String)
    
    Parameters:
    
    condition -
    
    Returns:
  - getWhereClause
```
public TWhereClause getWhereClause()
```
    restrict the rows selected to those that satisfy one or more conditions. used in select, delete, update statement.
    
    Returns:
    
    where clause.
  - setAlreadyAddToParent
```
public void setAlreadyAddToParent(boolean alreadyAddToParent)
```
  - searchCTEList
```
protected TCTEList searchCTEList(Boolean stopAtFirstFinding)
```
  - getParentStmt
```
public TCustomSqlStatement getParentStmt()
```
  - getParentObjectName
```
public TParseTreeNode getParentObjectName()
```
    Overrides:
    
    getParentObjectName in class TParseTreeNode
  - setParentStmt
```
public void setParentStmt(TCustomSqlStatement parentStmt)
```
  - setParentStmtToNull
```
public void setParentStmtToNull()
```
  - getAncestorStmt
```
public TCustomSqlStatement getAncestorStmt()
```
  - getSymbolTable
```
public Stack getSymbolTable()
```
    Deprecated. since ver 2.5.3.5, please use TStmtScope instead
  - getSyntaxErrors
```
public ArrayList<TSyntaxError> getSyntaxErrors()
```
  - getErrormessage
```
public String getErrormessage()
```
  - getSyntaxHints
```
public ArrayList<TSyntaxError> getSyntaxHints()
```
  - getErrorCount
```
public int getErrorCount()
```
    Number of syntax errors for this statement.
    
    Returns:
    
    0 means no syntax error.
  - parseerrormessagehandle
```
public EActionOnParseError parseerrormessagehandle(TSyntaxError se)
```
    Log error messages if syntax errors found while parsing this statement.
    
    Parameters:
    
    se - syntax error structure.
    
    Returns:
    
    type of error
  - parsestatement
```
public int parsestatement(TCustomSqlStatement pparentsql,
                          boolean isparsetreeavailable)
```
  - parsestatement
```
public int parsestatement(TCustomSqlStatement pparentsql,
                          boolean isparsetreeavailable,
                          boolean onlyNeedRawParseTree)
```
    Parse this statement.
    
    Parameters:
    
    pparentsql -
    
    isparsetreeavailable -
    
    Returns:
    
    parse result, zero means no syntax error found.
  - OracleStatementCanBeSeparatedByBeginEndPair
```
public boolean OracleStatementCanBeSeparatedByBeginEndPair()
```
  - VerticaStatementCanBeSeparatedByBeginEndPair
```
public boolean VerticaStatementCanBeSeparatedByBeginEndPair()
```
  - isnzplsql
```
public boolean isnzplsql()
```
  - ispgplsql
```
public boolean ispgplsql()
```
  - isGaussDBStoredProcedure
```
public boolean isGaussDBStoredProcedure()
```
  - isdatabricksplsql
```
public boolean isdatabricksplsql()
```
  - isgreeplumplsql
```
public boolean isgreeplumplsql()
```
  - isathenaplsql
```
public boolean isathenaplsql()
```
  - isprestoplsql
```
public boolean isprestoplsql()
```
  - issnowflakeplsql
```
public boolean issnowflakeplsql()
```
  - isBigQueryplsql
```
public boolean isBigQueryplsql()
```
  - isverticaplsql
```
public boolean isverticaplsql()
```
  - isoracleplsql
```
public boolean isoracleplsql()
```
  - dochecksyntax
```
protected int dochecksyntax(TCustomSqlStatement psql)
```
  - clearError
```
public void clearError()
```
  - setStmtScope
```
public void setStmtScope(gudusoft.gsqlparser.compiler.TStmtScope stmtScope)
```
  - getStmtScope
```
public gudusoft.gsqlparser.compiler.TStmtScope getStmtScope()
```
  - doParseStatement
```
public int doParseStatement(TCustomSqlStatement psql)
```
  - analyzeTablename
```
public TTable analyzeTablename(TObjectName tableName)
```
  - isTableACTE
```
protected boolean isTableACTE(TTable pTable)
```
  - findTable
```
public TTable findTable(ETableEffectType[] tableEffectTypes)
```
  - addToTables
```
public void addToTables(TTable pTable)
```
  - analyzeTableOrJoin
```
public TJoin analyzeTableOrJoin(TFromTable pfromTable)
```
  - analyzeFromTable
```
public TTable analyzeFromTable(TFromTable pfromTable,
                               Boolean addToTableList)
```
  - analyzeFromTable
```
public TTable analyzeFromTable(TFromTable pfromTable,
                               Boolean addToTableList,
                               ESqlClause pLocation)
```
  - analyzeJoin
```
public TJoin analyzeJoin(TJoinExpr pJoinExpr,
                         TJoin pJoin,
                         Boolean isSub)
```
  - locateVariableOrParameter
```
public boolean locateVariableOrParameter(TObjectName cr)
```
  - locateVariableOrParameter
```
public boolean locateVariableOrParameter(TObjectName cr,
                                         boolean checkVariableDeclaredInProcedure)
```
  - getColumnsInTable
```
public ArrayList<String> getColumnsInTable(TTable lcTable)
```
    Deprecated. since 2.3.8.2, use TTable.getExpandedStarColumns() instead.
    
    Parameters:
    
    lcTable -
    
    Returns:
  - getColumnsInTable
```
public ArrayList<String> getColumnsInTable(String pServer,
                                           String pDatabase,
                                           String pSchema,
                                           String pTable)
```
    Deprecated. since 2.3.8.2, use TTable.getExpandedStarColumns() instead.
    
    Parameters:
    
    pServer -
    
    pDatabase -
    
    pSchema -
    
    pTable -
    
    Returns:
  - fireOnMetaDatabaseTableColumn
```
public boolean fireOnMetaDatabaseTableColumn(String pServer,
                                             String pDatabase,
                                             String pSchema,
                                             String pTable,
                                             String pColumn)
```
  - getFirstPhysicalTable
```
public TTable getFirstPhysicalTable()
```
  - getOrphanColumns
```
public TObjectNameList getOrphanColumns()
```
  - linkToFirstTable
```
protected boolean linkToFirstTable(TObjectName pColumn,
                                   int pCandidateTableCnt)
```
  - searchDaxVariableInStack
```
public boolean searchDaxVariableInStack(TObjectName pName)
```
  - linkColumnToTable
```
public boolean linkColumnToTable(TObjectName pColumn,
                                 ESqlClause pLocation)
```
  - linkColumnReferenceToTable
```
public void linkColumnReferenceToTable(TObjectName cr,
                                       ESqlClause plocation)
```
    Deprecated. As of v1.6.0.1, use linkColumnToTable(gudusoft.gsqlparser.nodes.TObjectName, gudusoft.gsqlparser.ESqlClause) instead
  - checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt
```
public boolean checkNonQualifiedColumnReferenceInSubQueryOfUplevelStmt(TObjectName crf,
                                                                       boolean sameLevelOnly)
```
    Found out is a non qualified column is a column in uplevel subquery table like this: take ma_parkey for example: ma_parkey is not a physical column SELECT c_mandant , CASE WHEN EXISTS (SELECT 1 FROM CDS_H_GRUPPE GRP1 WHERE GRP1.c_mandant = c_mandant AND GRP1.parkey1 = ma_parkey) THEN 1 ELSE NULL END MA_ME FROM (SELECT c_mandant , CASE WHEN funktionscode = 'U' THEN parkey1 ELSE parkey2 END MA_PARKEY FROM CDS_H_GRUPPE )
  - getTopStatement
```
public TCustomSqlStatement getTopStatement()
```

Class TCustomSqlStatement

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class Object

Methods inherited from interface Iterator

Field Detail

relationAttributes

fromClause

fromSourceTable

fromSourceJoin

sqlstatementtype

sourcetokenlist

parser

plsqlparser

dummytag

joins

tables

rootNode

isparsed

stmtScope

Constructor Detail

TCustomSqlStatement

Method Detail

setUsingVariableList

getUsingVariableList

getAttributes

getRelationName

size

toScript

setFromClause

getFromClause

getRelations

getFromSourceTable

getFromSourceJoin

asCanonical

setCteIncludeThisStmt

getCteIncludeThisStmt

getExpandedResultColumns

searchFunctionInSQLEnv

getSqlEnv

getGlobalScope

setFrameStack

getFrameStack

getIndexColumns

setVariableStack

getVariableStack

getDaxFunctionStack

setLabelName

getLabelName

setEndlabelName

getEndlabelName

getTokenList

getTargetTable

setTargetTable

getJoins

getTables

getStatements

setCteList

getCteList

setResultColumnList

getResultColumnList

setReturningClause

getReturningClause

setOutputClause

getOutputClause

setTopClause

getTopClause

setWhereClause

addWhereClause

getWhereClause

setAlreadyAddToParent

searchCTEList

getParentStmt

getParentObjectName

setParentStmt

setParentStmtToNull

getAncestorStmt