Table (General SQL Parser Java Library Core 4.2.19 API)

Object
- gudusoft.gsqlparser.dlineage.dataflow.model.Table

Direct Known Subclasses:

Database, Schema, Variable
```
public class Table
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Set<String>`	`alias`
`protected String`	`database`
`protected String`	`displayName`
`protected Pair3<Long,Long,String>`	`endPosition`
`protected String`	`fullName`
`protected String`	`name`
`protected String`	`parent`
`protected Set<Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>>`	`positions`
`protected String`	`schema`
`protected String`	`server`
`protected Pair3<Long,Long,String>`	`startPosition`

Constructor Summary

Constructors
Constructor and Description
`Table(String tableName)`
`Table(TCustomSqlStatement stmt, TObjectName viewName)`
`Table(TObjectName tableName)`
`Table(TTable table)`
`Table(TTable table, String tableName)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addColumn(TableColumn column)`
`void`	`addColumnsFromSQLEnv()`
`void`	`addProcess(Process process)`
`void`	`clearDynamicTemplate()` Withdraws a dynamic-template mark.
`void`	`endFieldDeclaration()` Ends the declaration `openFieldDeclaration(long, long)` started.
`TableColumn`	`findColumn(String columnName)`
`FieldDeclaration`	`getActiveFieldDeclaration()` The declaration a read of the statement being analyzed is validated against; null when there is none.
`String`	`getAlias()`
`Set<String>`	`getAliasList()`
`Object`	`getBindingKey()` Binding identity, separate from legacy display getters: the table's identity under the analysis's identifier rules (`getCanonicalIdentity()`) with the legacy folded name bound alongside, or the legacy name alone for a table the rules give no identity.
`List<String>`	`getCandidateTables()`
`QualifiedCanonKey`	`getCanonicalIdentity()` The table's identity under the analysis's identifier rules: BigQuery's captured key, else a key minted from the composed name's segments, each read in the form it arrived in.
`QualifiedCanonKey`	`getCanonicalIdentityAs(ESQLDataObjectType role)` The table's identity read in another object role of the same level (`dotSynonyms` for a name that may name a synonym): the same segments, forms and rules as `getCanonicalIdentity()`, the last segment under that role's rules.
`List<TableColumn>`	`getColumns()`
`List<TableColumn>`	`getColumnsWithFieldPaths()` The columns as the output lists them: each column followed by the field path nodes below it.
`String`	`getCurrentAlias()`
`String`	`getDatabase()`
`String`	`getDataSourceName()` The external data source a file path is read through (BULK INSERT ...
`protected String`	`getDefaultDatabase()`
`protected String`	`getDefaultSchema()`
`protected String`	`getDefaultServer()`
`String`	`getDisplayName()`
`EndpointIntroduction`	`getEndpointIntroduction()`
`EndpointKind`	`getEndpointKind()`
`Pair3<Long,Long,String>`	`getEndPosition()`
`List<TableColumn>`	`getFieldPathColumns()` The field path nodes, read-only: they are added by the field-path constructor only, which keeps the index.
`TableColumn`	`getFieldPathNode(FieldNodeKey key)` The field path node with identity `key`, or null.
`String`	`getFileFormat()`
`String`	`getFileType()`
`String`	`getFullName()`
`long`	`getId()`
`QualifiedCanonKey`	`getIdentifierKey()`
`TableColumn`	`getLoadColumn()`
`String`	`getLocation()`
`String`	`getName()`
`String`	`getNormalizedName()` Delimiter-normalized, dialect-aware form of `getName()` (brackets / quotes stripped per identifier segment).
`String`	`getParent()`
`String`	`getPathUri()` The URI of a file path when it differs from its name: the data source's LOCATION joined with the path the statement names; null when the URI is the name.
`Set<Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>>`	`getPositions()`
`String`	`getProcedureId()`
`List<Process>`	`getProcesses()`
`TableRelationRows`	`getRelationRows()`
`String`	`getSchema()`
`String`	`getServer()`
`TCustomSqlStatement`	`getSqlStatement()`
`String`	`getStarStmt()`
`Pair3<Long,Long,String>`	`getStartPosition()`
`SubType`	`getSubType()`
`TTable`	`getTableObject()`
`String`	`getTemplatedParts()` Which identifier segments of `getName()` were assembled at runtime, pipe-joined outermost-first (`"db"`, `"db\|name"`, ...); `null` when this endpoint is not runtime-templated.
`boolean`	`hasSQLEnv()`
`boolean`	`hasSubquery()`
`boolean`	`isAmbiguousUnqualifiedTable()`
`boolean`	`isArrayRelation()`
`boolean`	`isConstant()`
`boolean`	`isCreatedInSql()` Whether this endpoint is created by the analyzed SQL.
`boolean`	`isCreateTable()`
`boolean`	`isCursor()`
`boolean`	`isDatabase()`
`boolean`	`isDataSource()`
`boolean`	`isDetermined()`
`boolean`	`isDynamicTemplate()` True when this endpoint's identifier was assembled at runtime by a dynamic-SQL fold.
`boolean`	`isExternal()`
`boolean`	`isFromDDL()`
`boolean`	`isPath()`
`boolean`	`isPseudo()`
`boolean`	`isResolved()` Existing schema/model resolution state, exposed under the endpoint-classification name.
`boolean`	`isSchema()`
`boolean`	`isSequence()`
`boolean`	`isStage()`
`boolean`	`isStream()`
`boolean`	`isTarget()`
`static boolean`	`isTsqlFamilyVendor(EDbVendor vendor)` Authoritative `EndpointKind`, computed on access from the current (raw) name and the active dialect.
`boolean`	`isVariable()`
`boolean`	`isView()`
`void`	`markDynamicTemplate(String parts, boolean identityTemplated)` Records that this endpoint's identifier was assembled at runtime by a dynamic-SQL fold.
`FieldDeclaration`	`openFieldDeclaration(long created, long dropped)` Starts the declaration of the CREATE TABLE statement `created`, which the DROP TABLE `dropped` ends (`FieldDeclaration.NEVER_DROPPED` when none does).
`void`	`removeColumn(String columnName)`
`void`	`removeColumn(TableColumn column)`
`void`	`removeProcess(Process process)`
`void`	`setAlias(String alias)`
`void`	`setArrayRelation(boolean arrayRelation)`
`void`	`setConstant(boolean isConstant)`
`void`	`setCreatedInSql(boolean createdInSql)`
`void`	`setCreateTable(boolean isCreateTable)`
`void`	`setCreateTable(boolean isCreateTable, boolean fromDDL)`
`void`	`setCurrentAlias(String currentAlias)`
`void`	`setDatabase(boolean isDatabase)`
`void`	`setDatabase(String database)`
`void`	`setDataSource(boolean dataSource)`
`void`	`setDataSourceName(String dataSourceName)`
`void`	`setDetermined(boolean isDetermined)`
`void`	`setDisplayName(String displayName)`
`void`	`setEndpointIntroduction(EndpointIntroduction endpointIntroduction)` Records how the endpoint was introduced.
`void`	`setExternal(boolean isExternal)`
`void`	`setFileFormat(String fileFormat)`
`void`	`setFileType(String fileType)`
`void`	`setFromDDL(boolean fromDDL)`
`void`	`setHasSQLEnv(boolean hasSQLEnv)`
`void`	`setLoadColumn(TableColumn column)` Makes `column` the table's load column rather than one of its columns.
`void`	`setLocation(String location)`
`void`	`setName(String name)`
`void`	`setParent(String parent)`
`void`	`setPath(boolean isPath)`
`void`	`setPath(boolean isPath, boolean defaultQualifiers)` Marks a file path.
`void`	`setPathUri(String pathUri)`
`Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>`	`setPosition(TCustomSqlStatement stmt)`
`Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>`	`setPosition(TObjectName tableName)`
`Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>`	`setPosition(TTable table)`
`void`	`setProcedureId(String procedureId)`
`void`	`setPseudo(boolean isPseudo)`
`void`	`setSchema(boolean isSchema)`
`void`	`setSequence(boolean sequence)`
`void`	`setStage(boolean isStage)`
`void`	`setStarStmt(String starStmt)`
`void`	`setStream(boolean isStream)`
`void`	`setSubType(SubType subType)`
`void`	`setTarget(boolean isTarget)`
`void`	`setVariable(boolean isVariable)`
`void`	`setView(boolean isView)`
`protected void`	`updateTableName(boolean supportCatalog, boolean supportSchema)`

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

- Field Detail
  - server
```
protected String server
```
  - database
```
protected String database
```
  - schema
```
protected String schema
```
  - name
```
protected String name
```
  - displayName
```
protected String displayName
```
  - fullName
```
protected String fullName
```
  - alias
```
protected Set<String> alias
```
  - positions
```
protected Set<Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>> positions
```
  - parent
```
protected String parent
```
  - startPosition
```
protected Pair3<Long,Long,String> startPosition
```
  - endPosition
```
protected Pair3<Long,Long,String> endPosition
```
- Constructor Detail
  - Table
```
public Table(TCustomSqlStatement stmt,
             TObjectName viewName)
```
  - Table
```
public Table(TTable table,
             String tableName)
```
  - Table
```
public Table(TTable table)
```
  - Table
```
public Table(TObjectName tableName)
```
  - Table
```
public Table(String tableName)
```
- Method Detail
  - getIdentifierKey
```
public QualifiedCanonKey getIdentifierKey()
```
  - getBindingKey
```
public Object getBindingKey()
```
    Binding identity, separate from legacy display getters: the table's identity under the analysis's identifier rules (getCanonicalIdentity()) with the legacy folded name bound alongside, or the legacy name alone for a table the rules give no identity.
  - getCanonicalIdentity
```
public QualifiedCanonKey getCanonicalIdentity()
```
    The table's identity under the analysis's identifier rules: BigQuery's captured key, else a key minted from the composed name's segments, each read in the form it arrived in. Levels the reference spelled, and levels a SQL spelling supplied, are read as SQL; a level the catalog supplied is read as the stored name it is. Minted during analysis and kept until the name changes, so the output merge sees the identity the model was bound under. Null for a name the rules give no identity: a database link, a shape the vendor's hierarchy cannot split, or a segment that is not an identifier.
  - getCanonicalIdentityAs
```
public QualifiedCanonKey getCanonicalIdentityAs(ESQLDataObjectType role)
```
    The table's identity read in another object role of the same level (dotSynonyms for a name that may name a synonym): the same segments, forms and rules as getCanonicalIdentity(), the last segment under that role's rules. A per-object profile may give synonyms rules of their own, so a synonym is matched in its own role. Null when the rules give the name no identity.
  - getSqlStatement
```
public TCustomSqlStatement getSqlStatement()
```
  - addColumnsFromSQLEnv
```
public void addColumnsFromSQLEnv()
```
  - getDefaultServer
```
protected String getDefaultServer()
```
  - getDefaultSchema
```
protected String getDefaultSchema()
```
  - getDefaultDatabase
```
protected String getDefaultDatabase()
```
  - isAmbiguousUnqualifiedTable
```
public boolean isAmbiguousUnqualifiedTable()
```
    Returns:
    
    true when this one-part reference is ambiguous across two or more schemas and was intentionally left unqualified (no default schema stamped). The candidates are available via getCandidateTables().
  - getCandidateTables
```
public List<String> getCandidateTables()
```
    Returns:
    
    the qualified candidate table names (e.g. testdb.s1.orders, testdb.s2.orders) when this reference is ambiguous across schemas, or null when the reference resolved normally.
  - updateTableName
```
protected void updateTableName(boolean supportCatalog,
                               boolean supportSchema)
```
  - getId
```
public long getId()
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getStartPosition
```
public Pair3<Long,Long,String> getStartPosition()
```
  - getEndPosition
```
public Pair3<Long,Long,String> getEndPosition()
```
  - getColumns
```
public List<TableColumn> getColumns()
```
  - addColumn
```
public void addColumn(TableColumn column)
```
  - getFieldPathColumns
```
public List<TableColumn> getFieldPathColumns()
```
    The field path nodes, read-only: they are added by the field-path constructor only, which keeps the index.
  - isArrayRelation
```
public boolean isArrayRelation()
```
  - setArrayRelation
```
public void setArrayRelation(boolean arrayRelation)
```
  - getFieldPathNode
```
public TableColumn getFieldPathNode(FieldNodeKey key)
```
    The field path node with identity key, or null.
  - openFieldDeclaration
```
public FieldDeclaration openFieldDeclaration(long created,
                                             long dropped)
```
    Starts the declaration of the CREATE TABLE statement created, which the DROP TABLE dropped ends (FieldDeclaration.NEVER_DROPPED when none does). Until endFieldDeclaration(), the declared fields recorded are this declaration's.
  - endFieldDeclaration
```
public void endFieldDeclaration()
```
    Ends the declaration openFieldDeclaration(long, long) started.
  - getActiveFieldDeclaration
```
public FieldDeclaration getActiveFieldDeclaration()
```
    The declaration a read of the statement being analyzed is validated against; null when there is none.
  - getColumnsWithFieldPaths
```
public List<TableColumn> getColumnsWithFieldPaths()
```
    The columns as the output lists them: each column followed by the field path nodes below it.
  - getLoadColumn
```
public TableColumn getLoadColumn()
```
  - setLoadColumn
```
public void setLoadColumn(TableColumn column)
```
    Makes column the table's load column rather than one of its columns.
  - getTableObject
```
public TTable getTableObject()
```
  - getAlias
```
public String getAlias()
```
  - setAlias
```
public void setAlias(String alias)
```
  - getFullName
```
public String getFullName()
```
  - hasSubquery
```
public boolean hasSubquery()
```
  - getParent
```
public String getParent()
```
  - setParent
```
public void setParent(String parent)
```
  - getDatabase
```
public String getDatabase()
```
  - getSchema
```
public String getSchema()
```
  - getRelationRows
```
public TableRelationRows getRelationRows()
```
  - isCreateTable
```
public boolean isCreateTable()
```
  - setCreateTable
```
public void setCreateTable(boolean isCreateTable,
                           boolean fromDDL)
```
  - setCreateTable
```
public void setCreateTable(boolean isCreateTable)
```
  - isView
```
public boolean isView()
```
  - setView
```
public void setView(boolean isView)
```
  - isPseudo
```
public boolean isPseudo()
```
  - setPseudo
```
public void setPseudo(boolean isPseudo)
```
  - isExternal
```
public boolean isExternal()
```
  - setExternal
```
public void setExternal(boolean isExternal)
```
  - isStage
```
public boolean isStage()
```
  - setStage
```
public void setStage(boolean isStage)
```
  - isSequence
```
public boolean isSequence()
```
  - setSequence
```
public void setSequence(boolean sequence)
```
  - isVariable
```
public boolean isVariable()
```
  - setVariable
```
public void setVariable(boolean isVariable)
```
  - isConstant
```
public boolean isConstant()
```
  - setConstant
```
public void setConstant(boolean isConstant)
```
  - isTarget
```
public boolean isTarget()
```
  - setTarget
```
public void setTarget(boolean isTarget)
```
  - getProcedureId
```
public String getProcedureId()
```
  - setProcedureId
```
public void setProcedureId(String procedureId)
```
  - isPath
```
public boolean isPath()
```
  - setPath
```
public void setPath(boolean isPath)
```
  - setPath
```
public void setPath(boolean isPath,
                    boolean defaultQualifiers)
```
    Marks a file path. With defaultQualifiers false the analysis defaults (the database and schema a USE or an Option sets) stay off it, since a file is no object of a database (SQL Server BULK INSERT, Mantis 4962); the file-path database and schema options still apply.
  - isCursor
```
public boolean isCursor()
```
  - getLocation
```
public String getLocation()
```
  - setLocation
```
public void setLocation(String location)
```
  - getDataSourceName
```
public String getDataSourceName()
```
    The external data source a file path is read through (BULK INSERT ... WITH (DATA_SOURCE = ...)), or null.
  - setDataSourceName
```
public void setDataSourceName(String dataSourceName)
```
  - getPathUri
```
public String getPathUri()
```
    The URI of a file path when it differs from its name: the data source's LOCATION joined with the path the statement names; null when the URI is the name.
  - setPathUri
```
public void setPathUri(String pathUri)
```
  - getFileType
```
public String getFileType()
```
  - setFileType
```
public void setFileType(String fileType)
```
  - getDisplayName
```
public String getDisplayName()
```
  - setDisplayName
```
public void setDisplayName(String displayName)
```
  - getFileFormat
```
public String getFileFormat()
```
  - setFileFormat
```
public void setFileFormat(String fileFormat)
```
  - getProcesses
```
public List<Process> getProcesses()
```
  - addProcess
```
public void addProcess(Process process)
```
  - removeProcess
```
public void removeProcess(Process process)
```
  - setSubType
```
public void setSubType(SubType subType)
```
  - getSubType
```
public SubType getSubType()
```
  - isStream
```
public boolean isStream()
```
  - setStream
```
public void setStream(boolean isStream)
```
  - isSchema
```
public boolean isSchema()
```
  - setSchema
```
public void setSchema(boolean isSchema)
```
  - setDatabase
```
public void setDatabase(String database)
```
  - isDatabase
```
public boolean isDatabase()
```
  - setDatabase
```
public void setDatabase(boolean isDatabase)
```
  - isDataSource
```
public boolean isDataSource()
```
  - setDataSource
```
public void setDataSource(boolean dataSource)
```
  - getStarStmt
```
public String getStarStmt()
```
  - setStarStmt
```
public void setStarStmt(String starStmt)
```
  - setHasSQLEnv
```
public void setHasSQLEnv(boolean hasSQLEnv)
```
  - hasSQLEnv
```
public boolean hasSQLEnv()
```
  - getCurrentAlias
```
public String getCurrentAlias()
```
  - setCurrentAlias
```
public void setCurrentAlias(String currentAlias)
```
  - getAliasList
```
public Set<String> getAliasList()
```
  - getServer
```
public String getServer()
```
  - isDetermined
```
public boolean isDetermined()
```
  - setDetermined
```
public void setDetermined(boolean isDetermined)
```
  - isFromDDL
```
public boolean isFromDDL()
```
  - setFromDDL
```
public void setFromDDL(boolean fromDDL)
```
  - isCreatedInSql
```
public boolean isCreatedInSql()
```
    Whether this endpoint is created by the analyzed SQL. A parse fact, NOT gated on isDetermined(); true for CREATE TABLE / SELECT INTO / CTAS / clone targets even when the defining query's schema could not be resolved.
  - setCreatedInSql
```
public void setCreatedInSql(boolean createdInSql)
```
  - getEndpointIntroduction
```
public EndpointIntroduction getEndpointIntroduction()
```
  - setEndpointIntroduction
```
public void setEndpointIntroduction(EndpointIntroduction endpointIntroduction)
```
    Records how the endpoint was introduced. First non-UNKNOWN writer wins, so the structural creation site (set early at build time) is not later clobbered.
  - isResolved
```
public boolean isResolved()
```
    Existing schema/model resolution state, exposed under the endpoint-classification name. Mirrors isDetermined() exactly; introduces no new resolution logic.
  - getNormalizedName
```
public String getNormalizedName()
```
    Delimiter-normalized, dialect-aware form of getName() (brackets / quotes stripped per identifier segment). Computed on access from the current name; does NOT mutate getName(), which stays raw. Returns the raw name when no normalization is possible (e.g. no global vendor context).
  - markDynamicTemplate
```
public void markDynamicTemplate(String parts,
                                boolean identityTemplated)
```
    Records that this endpoint's identifier was assembled at runtime by a dynamic-SQL fold. parts is the outermost-first, pipe-joined set of affected name segments; identityTemplated says the hole reaches the leading character of the object-name segment (so a #/@ prefix there is fold text, not a real temp / table-variable marker). Additive across repeated marks: parts union, identity ORs — one folded statement can reach the same endpoint twice.
    Callers MUST only invoke this from inside a dynamic-fold context; see EndpointKind.DYNAMIC_TEMPLATE.
  - getTemplatedParts
```
public String getTemplatedParts()
```
    Which identifier segments of getName() were assembled at runtime, pipe-joined outermost-first ("db", "db|name", ...); null when this endpoint is not runtime-templated. Lets a consumer match a templated skeleton against a later-resolved concrete name without re-parsing the name text.
  - isDynamicTemplate
```
public boolean isDynamicTemplate()
```
    True when this endpoint's identifier was assembled at runtime by a dynamic-SQL fold.
  - clearDynamicTemplate
```
public void clearDynamicTemplate()
```
    Withdraws a dynamic-template mark. Used when the SAME node turns out to also be referenced by a STATIC statement (by-name model reuse): the static reference provably names a real object, so publishing the template claim on the shared node would make that reference wrong — see the shared-node contract in docs/tmp/dynamic-template-endpoint-provenance.md.
  - isTsqlFamilyVendor
```
public static boolean isTsqlFamilyVendor(EDbVendor vendor)
```
    Authoritative EndpointKind, computed on access from the current (raw) name and the active dialect. Quote-robust: each identifier segment is delimiter- stripped before the #/##/@/tempdb tests. This reads only the new classification; it never inspects or mutates subType.
    §5.6 minimum scope: distinguishes T-SQL temp / global-temp / table-variable / tempdb objects from plain catalog objects. CTE / derived / TVF / constant kinds are deferred and reported as EndpointKind.UNKNOWN here.
  - getEndpointKind
```
public EndpointKind getEndpointKind()
```
  - setPosition
```
public Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>> setPosition(TTable table)
```
  - setPosition
```
public Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>> setPosition(TObjectName tableName)
```
  - setPosition
```
public Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>> setPosition(TCustomSqlStatement stmt)
```
  - getPositions
```
public Set<Pair<Pair3<Long,Long,String>,Pair3<Long,Long,String>>> getPositions()
```
  - findColumn
```
public TableColumn findColumn(String columnName)
```
  - removeColumn
```
public void removeColumn(TableColumn column)
```
  - removeColumn
```
public void removeColumn(String columnName)
```

Class Table

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

server

database

schema

name

displayName

fullName

alias

positions

parent

startPosition

endPosition

Constructor Detail

Table

Table

Table

Table

Table

Method Detail

getIdentifierKey

getBindingKey

getCanonicalIdentity

getCanonicalIdentityAs

getSqlStatement

addColumnsFromSQLEnv

getDefaultServer

getDefaultSchema

getDefaultDatabase

isAmbiguousUnqualifiedTable

getCandidateTables

updateTableName

getId

getName

setName

getStartPosition

getEndPosition

getColumns

addColumn

getFieldPathColumns

isArrayRelation

setArrayRelation

getFieldPathNode

openFieldDeclaration

endFieldDeclaration

getActiveFieldDeclaration

getColumnsWithFieldPaths

getLoadColumn

setLoadColumn

getTableObject

getAlias

setAlias

getFullName

hasSubquery

getParent

setParent

getDatabase

getSchema

getRelationRows

isCreateTable

setCreateTable

setCreateTable

isView

setView

isPseudo

setPseudo

isExternal

setExternal

isStage

setStage

isSequence

setSequence

isVariable

setVariable

isConstant

setConstant