TTable (General SQL Parser Java Library Core 4.2.19 API)

Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.nodes.TNodeWithAliasClause
  - - gudusoft.gsqlparser.nodes.TTable

All Implemented Interfaces:

IRelation, Visitable, Iterator<TSourceToken>

Direct Known Subclasses:

TCTE
```
public class TTable
extends TNodeWithAliasClause
implements IRelation
```
Represents various kinds of table source in from clause. Can also be a simple table/view name in create table and all other places. result of getTableType() can be one of:
- ftt_objectname, in from clause, a simple table/view name, reference: tableName
- ftt_subquery, is a subquery that retrieves rows from the database, also known as derived table. reference: subquery
- ftt_tableExpr,it's usually a table-valued expression., reference: tableExpr
- ftt_function, it's usually a table-valued function., reference: funcCall
- ETableSource.rowList, it's constructed rows, reference: rowList
- ftt_containsTable, CONTAINSTABLE clause of sql server. reference: containsTable, type of TContainsTable
- ftt_freetextTable, FREETEXTTABLE clause of sql server. reference: containsTable, type of TContainsTable
- ftt_openrowset, OPENROWSET clause of sql server. reference: openRowSet, type of TOpenRowSet
- ftt_openxml, OPENXML clause of sql server. reference: openXML, type of TOpenXML
- ftt_opendatasource, OPENDATASOURCE clause of sql server. reference: openDatasource, type of TOpenDatasource
- ftt_openquery, OPENQUERY clause of sql server. reference: openquery, type of (@link TOpenQuery)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PIVOT_CLAUSE_ALIAS`
`TSelectSqlStatement`	`subquery`
`static String`	`TABLE_COLLECTION_ALIAS`
`TTableReferenceList`	`tablerefs`
`static String`	`UNPIVOT_CLAUSE_ALIAS`

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

Constructor Summary

Constructors
Constructor and Description

TTable()

TTable(TObjectName pobjectname)

Constructors
Constructor and Description
`TTable()`
`TTable(TObjectName pobjectname)`

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 a visitor to iterate this class and sub-nodes of this class
`void`	`addAttribute(TAttributeNode node)`
`boolean`	`checkTableByName(String pTablename)`
`boolean`	`equalByName(String pTableName)`
`String`	`getAliasName()`
`TObjectName`	`getArrayIndexAlias()`
`ArrayList<TAttributeNode>`	`getAttributes()` Deprecated. , this method is deprecated since version 3.3.1.0, don't use it in TSQLResolver2
`ArrayList<TObjectName>`	`getAttributesReferenceToThisRelation()`
`TCaseJoinClause`	`getCaseJoin()`
`ETableCatalogStatus`	`getCatalogStatus()` Whether this table reference was found in the catalog metadata.
`TColumnDefinitionList`	`getColumnDefinitions()`
`TResultColumnList`	`getColumnListInTempTable()`
`ArrayList<TObjectName>`	`getColumnsFromSQLEnv(TSQLEnv sqlEnv)`
`TContainsTable`	`getContainsTable()`
`TCTE`	`getCTE()`
`TObjectNameList`	`getCteColomnReferences()`
`TDataChangeTable`	`getDatachangeTable()` DB2 data change
`List<String>`	`getDeclaredFunctionColumns()` The columns of the user table function this FROM item calls, as the catalog declares them (a CREATE FUNCTION of the input registered before the call, or catalog metadata): recorded by resolver2 when it resolves the call, so that `getLateralColumnNames()` and resolver2 read one layout.
`String`	`getDisplayName()`
`String`	`getDisplayName(boolean removeDBLink)`
`ETableEffectType`	`getEffectType()`
`ArrayList<String>`	`getExpandedStarColumns()` If a star column is linked to this table, use this method to returns all underlying columns that represented by the star column.
`TFlashback`	`getFlashback()`
`TForXMLClause`	`getForXMLClause()` SQL Server for xml clause
`TFromTableList`	`getFromTableList()`
`String`	`getFullName()`
`String`	`getFullNameWithAliasString()`
`TFunctionCall`	`getFuncCall()`
`THashByClause`	`getHashByClause()` Gets the HASH BY clause for Teradata table functions.
`THiveFromQuery`	`getHiveFromQuery()` Deprecated. As of v2.1.0.0, please use `getSubquery()`
`TJoinExpr`	`getJoinExpr()`
`TJsonTable`	`getJsonTable()`
`List<TParseTreeNode>`	`getLateralArguments()` The arguments `getLateralColumnInputs()` index: the call's argument expressions (a named argument's value), or the arrays of an `UNNEST` (an expression, or the column name of its legacy form); null when the call has no layout.
`List<String>`	`getLateralColumnInputs()` Per column of `getLateralColumnNames()`, the indexes in `getLateralArguments()` of the arguments whose values make it (`"0,1"`), or the empty string for a column computed over the generated rows (an ordinal); null when the arguments are not settled.
`List<String>`	`getLateralColumnNames()` The columns this FROM item's call generates, in order (a built-in table function, `UNNEST`, a Hive-family `LATERAL VIEW` generator), by the rule resolver2 resolves their names with (`TableFunctionLayout`); null when the rule does not settle the call's columns.
`String`	`getLateralRowInputs()` The indexes in `getLateralArguments()` of the arguments whose values decide the rows the call generates (`"0,1"`; empty when none, as for an array literal), or null when the rule does not settle the rows.
`TLateralView`	`getLateralView()` The LATERAL VIEW this table stands for when it is the relation a Hive-family `LATERAL VIEW` adds to its SELECT (`TLateralView.createATable(gudusoft.gsqlparser.TCustomSqlStatement)`); null for any other table.
`ArrayList<TLateralView>`	`getLateralViewList()`
`TObjectNameList`	`getLinkedColumns()` Deprecated. , this method is deprecated since version 3.3.1.0, don't use it in TSQLResolver2
`TTable`	`getLinkTable()`
`TOrderBy`	`getLocalOrderBy()` Gets the LOCAL ORDER BY clause for Teradata table functions.
`String`	`getName()`
`TObjectNameList`	`getObjectNameReferences()` Deprecated. As of v1.6.0.1, use `getLinkedColumns()` instead
`TOpenDatasource`	`getOpenDatasource()` Valid when `tableType` is ftt_opendatasource.
`TOpenQuery`	`getOpenquery()`
`TOpenRowSet`	`getOpenRowSet()`
`TOpenXML`	`getOpenXML()`
`TInformixOuterClause`	`getOuterClause()`
`TMergeSqlStatement`	`getOutputMerge()`
`int`	`getParenthesisAfterAliasCount()`
`int`	`getParenthesisCount()`
`TPartitionExtensionClause`	`getPartitionExtensionClause()`
`TPivotClause`	`getPivotClause()` Deprecated. As of v1.6.2.4, replaced by `TPivotedTable`
`TPivotedTable`	`getPivotedTable()`
`TExpression`	`getPointInTime()` The expression that picks the point in time a table is read at: `AS OF <expr>` (Oracle flashback, Teradata temporal tables) or `AT \| BEFORE (TIMESTAMP \| OFFSET => <expr>)` (Snowflake time travel).
`String`	`getPrefixDatabase()`
`String`	`getPrefixSchema()`
`String`	`getPrefixServer()`
`TPxGranule`	`getPxGranule()`
`String`	`getRelationName()`
`TSQLTable`	`getResolvedTable()`
`TMultiTargetList`	`getRowList()` Deprecated. As of v2.3.6.9, please use `getValueClause()` instead row constructor like this: '(' RW_VALUES MultiTargets ')'
`TTable`	`getSourceTableOfPivot()`
`TSQLEnv`	`getSqlEnv()`
`String`	`getStageName()`
`TStageReference`	`getStageReference()`
`TSelectSqlStatement`	`getSubquery()`
`TExpression`	`getTableExpr()`
`TPTNodeList<TTableHint>`	`getTableHintList()`
`TObjectName`	`getTableName()`
`TAliasClause`	`getTableOperatorInputAlias()`
`TOrderBy`	`getTableOperatorOrderBy()`
`TPartitionClause`	`getTableOperatorPartitionBy()`
`TPTNodeList<THiveKeyValueProperty>`	`getTableProperties()`
`TTableSample`	`getTableSample()`
`ETableSource`	`getTableType()`
`TTDUnpivot`	`getTdUnpivot()`
`TAtBeforeClause`	`getTimeTravelClause()`
`TUnnestClause`	`getUnnestClause()`
`TValueClause`	`getValueClause()`
`TXmlTable`	`getXmlTable()`
`void`	`initAttributeForRowList()`
`void`	`initAttributeForTableFunction()`
`void`	`initAttributeForXMLTable()`
`void`	`initAttributesForJoin()` 主要是在处理列级别的信息，它的主要目的是确保 JOIN 操作后的表对象包含所有参与 JOIN 的表的列信息，这对于后续的查询处理（特别是列引用解析）是必要的。
`void`	`initAttributesForPivotTable()`
`void`	`initAttributesForUnnest(TSQLEnv sqlEnv, TSelectSqlStatement select)`
`void`	`initAttributesFromCTE(TCTE cte)`
`void`	`initAttributesFromSubquery(TSelectSqlStatement subquery, String prefix)`
`void`	`initStarAttribute()` Initialize a star attribute node (tableName.*) for this table.
`boolean`	`isBaseTable()`
`boolean`	`isCTEName()`
`boolean`	`isIncludeColumnAlias()`
`boolean`	`isLateralLayoutClosed()` Whether `getLateralColumnNames()` are all the call's columns (false for an array of unknown element type, whose STRUCT or ROW fields would be columns of their own).
`boolean`	`isLinkTable()`
`boolean`	`isNPathOnClauseTable()` Returns true if this table comes from a Teradata NPath function's ON clause.
`boolean`	`isOnlyKeyword()`
`boolean`	`isResolved()`
`boolean`	`isSuperUnpivot()`
`boolean`	`isTableKeyword()`
`boolean`	`isTableRefBelongToThisTable(TTableReference tableref)`
`boolean`	`searchColumn(TSelectSqlStatement select, String tableName, TObjectName pColumn, boolean pMustIn)`
`int`	`searchColumnInAlias(TObjectName pColumn)`
`void`	`setArrayIndexAlias(TObjectName arrayIndexAlias)`
`void`	`setCaseJoin(TCaseJoinClause caseJoin)`
`void`	`setCatalogStatus(ETableCatalogStatus catalogStatus)`
`void`	`setColumnDefinitions(TColumnDefinitionList columnDefinitions)`
`void`	`setColumnListInTempTable(TResultColumnList columnListInTempTable)`
`void`	`setContainsTable(TContainsTable containsTable)`
`boolean`	`setCTE(TCTE pCTE)`
`void`	`setCteColomnReferences(TObjectNameList cteColomnReferences)`
`void`	`setCTEName(boolean CTEName)`
`void`	`setDatachangeTable(TDataChangeTable datachangeTable)`
`void`	`setDeclaredFunctionColumns(List<String> columns)` Sets the declared columns of the user table function this FROM item calls (see `getDeclaredFunctionColumns()`).
`void`	`setEffectType(ETableEffectType effectType)`
`void`	`setFlashback(TFlashback flashback)`
`void`	`setForXMLClause(TForXMLClause forXMLClause)`
`void`	`setFromTableList(TFromTableList fromTableList)`
`void`	`setFuncCall(TFunctionCall funcCall)`
`void`	`setHashByClause(THashByClause hashByClause)` Sets the HASH BY clause for Teradata table functions.
`void`	`setHiveFromQuery(THiveFromQuery hiveFromQuery)`
`void`	`setJoinExpr(TJoinExpr joinExpr)`
`void`	`setJsonTable(TJsonTable jsonTable)`
`void`	`setLateralView(TLateralView lateralView)`
`void`	`setLateralViewList(ArrayList<TLateralView> lateralViewList)`
`void`	`setLinkedColumns(TObjectNameList linkedColumns)`
`void`	`setLinkTable(boolean isLinkTable)` Deprecated. As of v1.8.4.6, set in `setLinkTable(gudusoft.gsqlparser.nodes.TTable)`
`void`	`setLinkTable(TTable linkTable)`
`void`	`setLocalOrderBy(TOrderBy localOrderBy)` Sets the LOCAL ORDER BY clause for Teradata table functions.
`void`	`setNPathOnClauseTable(boolean npathOnClauseTable)` Marks this table as coming from a Teradata NPath function's ON clause.
`void`	`setObjectNameReferences(TObjectNameList objectNameReferences)`
`void`	`setOnlyKeyword(boolean onlyKeyword)`
`void`	`setOpenDatasource(TOpenDatasource openDatasource)`
`void`	`setOpenquery(TOpenQuery openquery)`
`void`	`setOpenRowSet(TOpenRowSet openRowSet)`
`void`	`setOpenXML(TOpenXML openXML)`
`void`	`setOuterClause(TInformixOuterClause outerClause)`
`void`	`setOutputMerge(TMergeSqlStatement outputMerge)`
`void`	`setParenthesisAfterAliasCount(int parenthesisAfterAliasCount)`
`void`	`setParenthesisCount(int parenthesisCount)`
`void`	`setPartitionExtensionClause(TPartitionExtensionClause partitionExtensionClause)`
`void`	`setPivotClause(TPivotClause pivotClause)`
`void`	`setPivotedTable(TPivotedTable pivotedTable)`
`void`	`setPropertyFromObjectName(TObjectName objectName, ETableEffectType tableEffectType)`
`void`	`setPxGranule(TPxGranule pxGranule)`
`void`	`setResolved(boolean resolved)`
`void`	`setResolvedTable(TSQLTable resolvedTable)`
`void`	`setRowList(TMultiTargetList rowList)`
`void`	`setSourceTableOfPivot(TTable sourceTableOfPivot)`
`void`	`setSqlEnv(TSQLEnv sqlEnv)`
`void`	`setStageReference(TStageReference stageReference)`
`void`	`setSubquery(TSelectSqlStatement subquery)`
`void`	`setSuperUnpivot(boolean superUnpivot)`
`void`	`setTableExpr(TExpression tableExpr)`
`void`	`setTableHintList(TPTNodeList<TTableHint> tableHintList)`
`void`	`setTableKeyword(boolean tableKeyword)`
`void`	`setTableName(TObjectName tableName)`
`void`	`setTableOperatorInputAlias(TAliasClause value)`
`void`	`setTableOperatorOrderBy(TOrderBy value)`
`void`	`setTableOperatorPartitionBy(TPartitionClause value)`
`void`	`setTableProperties(TPTNodeList<THiveKeyValueProperty> tableProperties)`
`void`	`setTablerefs(TTableReferenceList tablerefs)`
`void`	`setTableSample(TTableSample tableSample)`
`void`	`setTableType(ETableSource tableType)`
`void`	`setTdUnpivot(TTDUnpivot tdUnpivot)`
`void`	`setTimeTravelClause(TAtBeforeClause timeTravelClause)`
`void`	`setUnnestClause(TUnnestClause unnestClause)`
`void`	`setValueClause(TValueClause valueClause)`
`void`	`setXmlTable(TXmlTable xmlTable)`
`int`	`size()`
`String`	`toString()` Tf there is no alias clause of this node, then toString() is the same as `TParseTreeNode`

Methods inherited from class gudusoft.gsqlparser.nodes.TNodeWithAliasClause
getAliasClause, setAliasClause

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, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getParentObjectName, 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, toScript, toString2

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

Methods inherited from interface Iterator
forEachRemaining

- Field Detail
  - PIVOT_CLAUSE_ALIAS
```
public static final String PIVOT_CLAUSE_ALIAS
```
    See Also:
    
    Constant Field Values
  - UNPIVOT_CLAUSE_ALIAS
```
public static final String UNPIVOT_CLAUSE_ALIAS
```
    See Also:
    
    Constant Field Values
  - TABLE_COLLECTION_ALIAS
```
public static final String TABLE_COLLECTION_ALIAS
```
    See Also:
    
    Constant Field Values
  - subquery
```
public TSelectSqlStatement subquery
```
  - tablerefs
```
public TTableReferenceList tablerefs
```
- Constructor Detail
  - TTable
```
public TTable(TObjectName pobjectname)
```
  - TTable
```
public TTable()
```
- Method Detail
  - getAttributes
```
public ArrayList<TAttributeNode> getAttributes()
```
    Deprecated. , this method is deprecated since version 3.3.1.0, don't use it in TSQLResolver2
    
    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
  - setStageReference
```
public void setStageReference(TStageReference stageReference)
```
  - getStageReference
```
public TStageReference getStageReference()
```
  - setTimeTravelClause
```
public void setTimeTravelClause(TAtBeforeClause timeTravelClause)
```
  - getTimeTravelClause
```
public TAtBeforeClause getTimeTravelClause()
```
  - setCaseJoin
```
public void setCaseJoin(TCaseJoinClause caseJoin)
```
  - getCaseJoin
```
public TCaseJoinClause getCaseJoin()
```
  - getStageName
```
public String getStageName()
```
  - initStarAttribute
```
public void initStarAttribute()
```
    Initialize a star attribute node (tableName.*) for this table. This is used for regular tables (without DDL/metadata) in contexts where they need to compete with subqueries that have star columns. For example, in MERGE statements, the target table needs a star attribute so that unqualified columns in the ON clause can be resolved to it instead of being incorrectly pushed down through the source subquery's star column.
  - initAttributeForXMLTable
```
public void initAttributeForXMLTable()
```
  - initAttributeForTableFunction
```
public void initAttributeForTableFunction()
```
  - initAttributeForRowList
```
public void initAttributeForRowList()
```
  - initAttributesFromCTE
```
public void initAttributesFromCTE(TCTE cte)
```
  - initAttributesFromSubquery
```
public void initAttributesFromSubquery(TSelectSqlStatement subquery,
                                       String prefix)
```
  - getDisplayName
```
public String getDisplayName()
```
  - getDisplayName
```
public String getDisplayName(boolean removeDBLink)
```
  - initAttributesForPivotTable
```
public void initAttributesForPivotTable()
```
  - initAttributesForJoin
```
public void initAttributesForJoin()
```
    主要是在处理列级别的信息，它的主要目的是确保 JOIN 操作后的表对象包含所有参与 JOIN 的表的列信息，这对于后续的查询处理（特别是列引用解析）是必要的。
  - initAttributesForUnnest
```
public void initAttributesForUnnest(TSQLEnv sqlEnv,
                                    TSelectSqlStatement select)
```
  - addAttribute
```
public void addAttribute(TAttributeNode node)
```
  - getAttributesReferenceToThisRelation
```
public ArrayList<TObjectName> getAttributesReferenceToThisRelation()
```
  - setResolvedTable
```
public void setResolvedTable(TSQLTable resolvedTable)
```
  - getCatalogStatus
```
public ETableCatalogStatus getCatalogStatus()
```
    Whether this table reference was found in the catalog metadata. A fact about the table, separate from which table a column belongs to: see ETableCatalogStatus.
  - setCatalogStatus
```
public void setCatalogStatus(ETableCatalogStatus catalogStatus)
```
  - setResolved
```
public void setResolved(boolean resolved)
```
  - getResolvedTable
```
public TSQLTable getResolvedTable()
```
  - isResolved
```
public boolean isResolved()
```
  - getColumnsFromSQLEnv
```
public ArrayList<TObjectName> getColumnsFromSQLEnv(TSQLEnv sqlEnv)
```
  - setJoinExpr
```
public void setJoinExpr(TJoinExpr joinExpr)
```
  - getJoinExpr
```
public TJoinExpr getJoinExpr()
```
  - setForXMLClause
```
public void setForXMLClause(TForXMLClause forXMLClause)
```
  - getForXMLClause
```
public TForXMLClause getForXMLClause()
```
    SQL Server for xml clause
    
    Returns:
    
    SQL Server for xml clause
  - getColumnDefinitions
```
public TColumnDefinitionList getColumnDefinitions()
```
  - getTableOperatorInputAlias
```
public TAliasClause getTableOperatorInputAlias()
```
  - setTableOperatorInputAlias
```
public void setTableOperatorInputAlias(TAliasClause value)
```
  - getTableOperatorPartitionBy
```
public TPartitionClause getTableOperatorPartitionBy()
```
  - setTableOperatorPartitionBy
```
public void setTableOperatorPartitionBy(TPartitionClause value)
```
  - getTableOperatorOrderBy
```
public TOrderBy getTableOperatorOrderBy()
```
  - setTableOperatorOrderBy
```
public void setTableOperatorOrderBy(TOrderBy value)
```
  - getHashByClause
```
public THashByClause getHashByClause()
```
    Gets the HASH BY clause for Teradata table functions.
    
    Returns:
    
    the HASH BY clause, or null if not specified
  - setHashByClause
```
public void setHashByClause(THashByClause hashByClause)
```
    Sets the HASH BY clause for Teradata table functions.
    
    Parameters:
    
    hashByClause - the HASH BY clause
  - getLocalOrderBy
```
public TOrderBy getLocalOrderBy()
```
    Gets the LOCAL ORDER BY clause for Teradata table functions.
    
    Returns:
    
    the LOCAL ORDER BY clause, or null if not specified
  - setLocalOrderBy
```
public void setLocalOrderBy(TOrderBy localOrderBy)
```
    Sets the LOCAL ORDER BY clause for Teradata table functions.
    
    Parameters:
    
    localOrderBy - the LOCAL ORDER BY clause
  - setSqlEnv
```
public void setSqlEnv(TSQLEnv sqlEnv)
```
  - getSqlEnv
```
public TSQLEnv getSqlEnv()
```
  - getValueClause
```
public TValueClause getValueClause()
```
  - setValueClause
```
public void setValueClause(TValueClause valueClause)
```
  - setSourceTableOfPivot
```
public void setSourceTableOfPivot(TTable sourceTableOfPivot)
```
  - getSourceTableOfPivot
```
public TTable getSourceTableOfPivot()
```
  - setJsonTable
```
public void setJsonTable(TJsonTable jsonTable)
```
  - getJsonTable
```
public TJsonTable getJsonTable()
```
  - setPropertyFromObjectName
```
public void setPropertyFromObjectName(TObjectName objectName,
                                      ETableEffectType tableEffectType)
```
  - setTdUnpivot
```
public void setTdUnpivot(TTDUnpivot tdUnpivot)
```
  - getTdUnpivot
```
public TTDUnpivot getTdUnpivot()
```
  - setUnnestClause
```
public void setUnnestClause(TUnnestClause unnestClause)
```
  - getUnnestClause
```
public TUnnestClause getUnnestClause()
```
  - setColumnListInTempTable
```
public void setColumnListInTempTable(TResultColumnList columnListInTempTable)
```
  - getColumnListInTempTable
```
public TResultColumnList getColumnListInTempTable()
```
  - setPxGranule
```
public void setPxGranule(TPxGranule pxGranule)
```
  - getPxGranule
```
public TPxGranule getPxGranule()
```
  - setFlashback
```
public void setFlashback(TFlashback flashback)
```
  - getFlashback
```
public TFlashback getFlashback()
```
  - getPointInTime
```
public TExpression getPointInTime()
```
    The expression that picks the point in time a table is read at: AS OF <expr> (Oracle flashback, Teradata temporal tables) or AT | BEFORE (TIMESTAMP | OFFSET => <expr>) (Snowflake time travel).
    
    Returns:
    
    the expression, or null when the table is read as it is now
  - getArrayIndexAlias
```
public TObjectName getArrayIndexAlias()
```
  - setArrayIndexAlias
```
public void setArrayIndexAlias(TObjectName arrayIndexAlias)
```
  - isSuperUnpivot
```
public boolean isSuperUnpivot()
```
  - setSuperUnpivot
```
public void setSuperUnpivot(boolean superUnpivot)
```
  - setNPathOnClauseTable
```
public void setNPathOnClauseTable(boolean npathOnClauseTable)
```
    Marks this table as coming from a Teradata NPath function's ON clause. This is used for data lineage to trace back to the source table inside NPath.
  - isNPathOnClauseTable
```
public boolean isNPathOnClauseTable()
```
    Returns true if this table comes from a Teradata NPath function's ON clause.
  - setTableKeyword
```
public void setTableKeyword(boolean tableKeyword)
```
  - setOnlyKeyword
```
public void setOnlyKeyword(boolean onlyKeyword)
```
  - isTableKeyword
```
public boolean isTableKeyword()
```
  - isOnlyKeyword
```
public boolean isOnlyKeyword()
```
  - setParenthesisCount
```
public void setParenthesisCount(int parenthesisCount)
```
  - setParenthesisAfterAliasCount
```
public void setParenthesisAfterAliasCount(int parenthesisAfterAliasCount)
```
  - getParenthesisCount
```
public int getParenthesisCount()
```
  - getParenthesisAfterAliasCount
```
public int getParenthesisAfterAliasCount()
```
  - setOutputMerge
```
public void setOutputMerge(TMergeSqlStatement outputMerge)
```
  - getOutputMerge
```
public TMergeSqlStatement getOutputMerge()
```
  - setPivotedTable
```
public void setPivotedTable(TPivotedTable pivotedTable)
```
  - getPivotedTable
```
public TPivotedTable getPivotedTable()
```
  - setEffectType
```
public void setEffectType(ETableEffectType effectType)
```
  - getEffectType
```
public ETableEffectType getEffectType()
```
  - setLinkTable
```
public void setLinkTable(TTable linkTable)
```
  - getLinkTable
```
public TTable getLinkTable()
```
  - isLinkTable
```
public boolean isLinkTable()
```
  - setLinkTable
```
public void setLinkTable(boolean isLinkTable)
```
    Deprecated. As of v1.8.4.6, set in setLinkTable(gudusoft.gsqlparser.nodes.TTable)
  - getAliasName
```
public String getAliasName()
```
  - equalByName
```
public boolean equalByName(String pTableName)
```
  - setTableProperties
```
public void setTableProperties(TPTNodeList<THiveKeyValueProperty> tableProperties)
```
  - getTableProperties
```
public TPTNodeList<THiveKeyValueProperty> getTableProperties()
```
    Returns:
    
    hive table property list
  - setLateralViewList
```
public void setLateralViewList(ArrayList<TLateralView> lateralViewList)
```
  - getLateralView
```
public TLateralView getLateralView()
```
    The LATERAL VIEW this table stands for when it is the relation a Hive-family LATERAL VIEW adds to its SELECT (TLateralView.createATable(gudusoft.gsqlparser.TCustomSqlStatement)); null for any other table.
  - setLateralView
```
public void setLateralView(TLateralView lateralView)
```
  - getLateralViewList
```
public ArrayList<TLateralView> getLateralViewList()
```
  - getLateralColumnNames
```
public List<String> getLateralColumnNames()
```
    The columns this FROM item's call generates, in order (a built-in table function, UNNEST, a Hive-family LATERAL VIEW generator), by the rule resolver2 resolves their names with (TableFunctionLayout); null when the rule does not settle the call's columns. An element is null for a column the vendor leaves without a name a query can use.
    
    Since:
    
    4.2.17
  - getLateralColumnInputs
```
public List<String> getLateralColumnInputs()
```
    Per column of getLateralColumnNames(), the indexes in getLateralArguments() of the arguments whose values make it ("0,1"), or the empty string for a column computed over the generated rows (an ordinal); null when the arguments are not settled.
    
    Since:
    
    4.2.17
  - getLateralRowInputs
```
public String getLateralRowInputs()
```
    The indexes in getLateralArguments() of the arguments whose values decide the rows the call generates ("0,1"; empty when none, as for an array literal), or null when the rule does not settle the rows. The rows can be settled while the columns are not (getLateralColumnNames() null).
    
    Since:
    
    4.2.17
  - isLateralLayoutClosed
```
public boolean isLateralLayoutClosed()
```
    Whether getLateralColumnNames() are all the call's columns (false for an array of unknown element type, whose STRUCT or ROW fields would be columns of their own).
    
    Since:
    
    4.2.17
  - getLateralArguments
```
public List<TParseTreeNode> getLateralArguments()
```
    The arguments getLateralColumnInputs() index: the call's argument expressions (a named argument's value), or the arrays of an UNNEST (an expression, or the column name of its legacy form); null when the call has no layout.
    
    Since:
    
    4.2.17
  - getDeclaredFunctionColumns
```
public List<String> getDeclaredFunctionColumns()
```
    The columns of the user table function this FROM item calls, as the catalog declares them (a CREATE FUNCTION of the input registered before the call, or catalog metadata): recorded by resolver2 when it resolves the call, so that getLateralColumnNames() and resolver2 read one layout. Null when none is known.
    
    Since:
    
    4.2.17
  - setDeclaredFunctionColumns
```
public void setDeclaredFunctionColumns(List<String> columns)
```
    Sets the declared columns of the user table function this FROM item calls (see getDeclaredFunctionColumns()).
    
    Since:
    
    4.2.17
  - setTableSample
```
public void setTableSample(TTableSample tableSample)
```
  - getTableSample
```
public TTableSample getTableSample()
```
  - setPartitionExtensionClause
```
public void setPartitionExtensionClause(TPartitionExtensionClause partitionExtensionClause)
```
  - getPartitionExtensionClause
```
public TPartitionExtensionClause getPartitionExtensionClause()
```
  - setOuterClause
```
public void setOuterClause(TInformixOuterClause outerClause)
```
  - getOuterClause
```
public TInformixOuterClause getOuterClause()
```
  - setFromTableList
```
public void setFromTableList(TFromTableList fromTableList)
```
  - getFromTableList
```
public TFromTableList getFromTableList()
```
  - getXmlTable
```
public TXmlTable getXmlTable()
```
  - setXmlTable
```
public void setXmlTable(TXmlTable xmlTable)
```
  - setTableHintList
```
public void setTableHintList(TPTNodeList<TTableHint> tableHintList)
```
  - getTableHintList
```
public TPTNodeList<TTableHint> getTableHintList()
```
  - getOpenquery
```
public TOpenQuery getOpenquery()
```
  - getSubquery
```
public TSelectSqlStatement getSubquery()
```
  - setOpenquery
```
public void setOpenquery(TOpenQuery openquery)
```
  - setOpenDatasource
```
public void setOpenDatasource(TOpenDatasource openDatasource)
```
  - getOpenDatasource
```
public TOpenDatasource getOpenDatasource()
```
    Valid when tableType is ftt_opendatasource.
    
    Returns:
  - setOpenXML
```
public void setOpenXML(TOpenXML openXML)
```
  - getOpenXML
```
public TOpenXML getOpenXML()
```
  - getOpenRowSet
```
public TOpenRowSet getOpenRowSet()
```
  - setOpenRowSet
```
public void setOpenRowSet(TOpenRowSet openRowSet)
```
  - getContainsTable
```
public TContainsTable getContainsTable()
```
  - setContainsTable
```
public void setContainsTable(TContainsTable containsTable)
```
  - getFuncCall
```
public TFunctionCall getFuncCall()
```
  - setFuncCall
```
public void setFuncCall(TFunctionCall funcCall)
```
  - getRowList
```
public TMultiTargetList getRowList()
```
    Deprecated. As of v2.3.6.9, please use getValueClause() instead row constructor like this: '(' RW_VALUES MultiTargets ')'
    
    Returns:
    
    TMultiTargetList
  - isBaseTable
```
public boolean isBaseTable()
```
  - setCteColomnReferences
```
public void setCteColomnReferences(TObjectNameList cteColomnReferences)
```
  - getCteColomnReferences
```
public TObjectNameList getCteColomnReferences()
```
  - setObjectNameReferences
```
public void setObjectNameReferences(TObjectNameList objectNameReferences)
```
  - setCTE
```
public boolean setCTE(TCTE pCTE)
```
  - getCTE
```
public TCTE getCTE()
```
  - isCTEName
```
public boolean isCTEName()
```
  - setCTEName
```
public void setCTEName(boolean CTEName)
```
  - setHiveFromQuery
```
public void setHiveFromQuery(THiveFromQuery hiveFromQuery)
```
  - getHiveFromQuery
```
public THiveFromQuery getHiveFromQuery()
```
    Deprecated. As of v2.1.0.0, please use getSubquery()
    
    Returns:
  - getTableExpr
```
public TExpression getTableExpr()
```
  - setTableExpr
```
public void setTableExpr(TExpression tableExpr)
```
  - setTableType
```
public void setTableType(ETableSource tableType)
```
  - getTableType
```
public ETableSource getTableType()
```
    Returns:
    what's kind of type this table is.
    
    ETableSource.objectname, in from clause, a simple table/view name, reference: tableName
    
    ETableSource.subquery, is a subquery that retrieves rows from the database, also known as derived table. reference: subquery
    
    ETableSource.tableExpr,it's usually a table-valued expression., reference: tableExpr
    
    ETableSource.function, it's usually a table-valued function., reference: funcCall
    
    ETableSource.rowList, it's constructed rows, reference: rowList
    
    ETableSource.containsTable, CONTAINSTABLE clause of sql server. reference: containsTable, type of TContainsTable
    
    ETableSource.freetextTable, FREETEXTTABLE clause of sql server. reference: containsTable, type of TContainsTable
    
    ETableSource.openrowset, OPENROWSET clause of sql server. reference: openRowSet, type of TOpenRowSet
    
    ETableSource.openxml, OPENXML clause of sql server. reference: openXML, type of TOpenXML
    
    ETableSource.opendatasource, OPENDATASOURCE clause of sql server. reference: openDatasource, type of TOpenDatasource
    
    ETableSource.openquery, OPENQUERY clause of sql server. reference: openquery, type of (@link TOpenQuery)
  - setTableName
```
public void setTableName(TObjectName tableName)
```
  - getTableName
```
public TObjectName getTableName()
```
  - getName
```
public String getName()
```
  - getPrefixServer
```
public String getPrefixServer()
```
  - getPrefixDatabase
```
public String getPrefixDatabase()
```
  - getPrefixSchema
```
public String getPrefixSchema()
```
  - isIncludeColumnAlias
```
public boolean isIncludeColumnAlias()
```
  - searchColumnInAlias
```
public int searchColumnInAlias(TObjectName pColumn)
```
  - checkTableByName
```
public boolean checkTableByName(String pTablename)
```
  - searchColumn
```
public boolean searchColumn(TSelectSqlStatement select,
                            String tableName,
                            TObjectName pColumn,
                            boolean pMustIn)
```
  - getLinkedColumns
```
public TObjectNameList getLinkedColumns()
```
    Deprecated. , this method is deprecated since version 3.3.1.0, don't use it in TSQLResolver2
    
    Returns:
  - getFullNameWithAliasString
```
public String getFullNameWithAliasString()
```
  - getFullName
```
public String getFullName()
```
  - getObjectNameReferences
```
public TObjectNameList getObjectNameReferences()
```
    Deprecated. As of v1.6.0.1, use getLinkedColumns() instead
    
    Returns:
    
    column name related to this table.
  - setPivotClause
```
public void setPivotClause(TPivotClause pivotClause)
```
  - getPivotClause
```
public TPivotClause getPivotClause()
```
    Deprecated. As of v1.6.2.4, replaced by TPivotedTable
    
    Returns:
  - setDatachangeTable
```
public void setDatachangeTable(TDataChangeTable datachangeTable)
```
  - getDatachangeTable
```
public TDataChangeTable getDatachangeTable()
```
    DB2 data change
    
    Returns:
  - isTableRefBelongToThisTable
```
public boolean isTableRefBelongToThisTable(TTableReference tableref)
```
  - 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
  - setColumnDefinitions
```
public void setColumnDefinitions(TColumnDefinitionList columnDefinitions)
```
  - acceptChildren
```
public void acceptChildren(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor to iterate this class and sub-nodes of this class
    
    Specified by:
    
    acceptChildren in interface Visitable
    
    Overrides:
    
    acceptChildren in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - setRowList
```
public void setRowList(TMultiTargetList rowList)
```
  - setSubquery
```
public void setSubquery(TSelectSqlStatement subquery)
```
  - setLinkedColumns
```
public void setLinkedColumns(TObjectNameList linkedColumns)
```
  - setTablerefs
```
public void setTablerefs(TTableReferenceList tablerefs)
```
  - getExpandedStarColumns
```
public ArrayList<String> getExpandedStarColumns()
```
    If a star column is linked to this table, use this method to returns all underlying columns that represented by the star column.
    
    The returned column always prefixed with
    1. the table alias.
    2. the table name
    3. the alias of query (if the table is a subquery)
    4. empty if the no alias is specified for a subquery
    
    Returns:
    
    a list of columns
  - toString
```
public String toString()
```
    Description copied from class: TNodeWithAliasClause
    
    Tf there is no alias clause of this node, then toString() is the same as TParseTreeNode
    Otherwise, return text of node only, don't include text of alias clause.
    If this node was modified by TParseTreeNode.setString(String), then node text including alias node text was replaced by new string.
    
    Overrides:
    
    toString in class TNodeWithAliasClause
    
    Returns:
    
    节点对应的SQL字符串。

Class TTable

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TNodeWithAliasClause

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class Object

Methods inherited from interface Iterator

Field Detail

PIVOT_CLAUSE_ALIAS

UNPIVOT_CLAUSE_ALIAS

TABLE_COLLECTION_ALIAS

subquery

tablerefs

Constructor Detail

TTable

TTable

Method Detail

getAttributes

getRelationName

size

setStageReference

getStageReference

setTimeTravelClause

getTimeTravelClause

setCaseJoin

getCaseJoin

getStageName

initStarAttribute

initAttributeForXMLTable

initAttributeForTableFunction

initAttributeForRowList

initAttributesFromCTE

initAttributesFromSubquery

getDisplayName

getDisplayName

initAttributesForPivotTable

initAttributesForJoin

initAttributesForUnnest

addAttribute

getAttributesReferenceToThisRelation

setResolvedTable

getCatalogStatus

setCatalogStatus

setResolved

getResolvedTable

isResolved

getColumnsFromSQLEnv

setJoinExpr

getJoinExpr

setForXMLClause

getForXMLClause

getColumnDefinitions

getTableOperatorInputAlias

setTableOperatorInputAlias

getTableOperatorPartitionBy

setTableOperatorPartitionBy

getTableOperatorOrderBy

setTableOperatorOrderBy

getHashByClause

setHashByClause

getLocalOrderBy

setLocalOrderBy

setSqlEnv

getSqlEnv

getValueClause

setValueClause

setSourceTableOfPivot

getSourceTableOfPivot

setJsonTable

getJsonTable

setPropertyFromObjectName

setTdUnpivot

getTdUnpivot

setUnnestClause

getUnnestClause

setColumnListInTempTable

getColumnListInTempTable

setPxGranule