TAlterTableOption (gudusoft.gsqlparser 2.0.1.0 API)

java.lang.Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.nodes.TAlterTableOption

All Implemented Interfaces:

Visitable
```
public class TAlterTableOption
extends TParseTreeNode
```
Type of alter table option, getOptionType() returns the type of various option:

Column
- EAlterTableOptionType.AddColumn, check getColumnDefinitionList() for newly added columns
- EAlterTableOptionType.AlterColumn, alter column option, getColumnName() returns the column name.
  check getAlterColumnSubType() for the subtype of alter column option.
  - EAlterColumnSubType.SetDefault, getDefaultExpr() returns default expression
  - EAlterColumnSubType.DropDefault
  - EAlterColumnSubType.DropNotNull
  - EAlterColumnSubType.SetNotNull
  - EAlterColumnSubType.SetStatistics, getStatisticsValue() returns the statistics value
  - EAlterColumnSubType.SetOptions, getAttributeOptions() returns the set options
  - EAlterColumnSubType.ResetOptions, getAttributeOptions() returns the reset options
  - EAlterColumnSubType.SetStorage, getStorageName() retuns the storage name
  - EAlterColumnSubType.SetDataType, returns the data type name
- EAlterTableOptionType.ChangeColumn, MySQL,Hive,Impala change column clause, old column name,new column definition
- EAlterTableOptionType.DropColumn, check getColumnNameList() for dropped columns. getDropRestrictType() returns drop restrict type if any.
- EAlterTableOptionType.ModifyColumn, check getColumnDefinitionList() for modified columns
- EAlterTableOptionType.RenameColumn, rename old name to new name
- EAlterTableOptionType.SetUnUsedColumn, check getColumnNameList() for unused column. Oracle set unused column.
- EAlterTableOptionType.DropUnUsedColumn, Oracle drop unused columns
- EAlterTableOptionType.DropColumnsContinue, Oracle drop columns continue
Constraint
- EAlterTableOptionType.AddConstraint, check getConstraintList() for newly added table level constraints
- EAlterTableOptionType.AddConstraintPK, primary key column list. MySQL, getConstraintName() returns the constraint name
- EAlterTableOptionType.AddConstraintUnique, unique key column list. MyQL,getConstraintName() returns the constraint name
- EAlterTableOptionType.AddConstraintFK, unique key column list, [constraint name], [referenced table name], [referenced column list],MySQL
- EAlterTableOptionType.AddConstraintIndex, check index column list, [constraint name],[index storage type] MySQL add index constraint
- EAlterTableOptionType.DropConstraint, constraint name list, [drop restrict type], Oracle/DB2/Greenplum drop constraint.
- EAlterTableOptionType.AlterConstraintFK, DB2 alter foreign key.
- EAlterTableOptionType.AlterConstraintCheck, check constraint name , DB2 alter check constraint.
- EAlterTableOptionType.DropConstraintIndex, constriant name, MySQL drop index
- EAlterTableOptionType.DropConstraintKey, constriant name, MySQL drop index
- EAlterTableOptionType.DropConstraintPK, Oracle/DB2/MySQL drop primary key.
- EAlterTableOptionType.DropConstraintFK,[constriant name], DB2/MySQL drop foreign key.
- EAlterTableOptionType.DropConstraintUnique, In Oracle, get unique column list, In DB2, get constraint name.
- EAlterTableOptionType.DropConstraintCheck, check constraint name, DB2 drop check constraint.
- EAlterTableOptionType.ModifyConstraint, check constraint name
- EAlterTableOptionType.RenameConstraint, rename old name to new name
- EAlterTableOptionType.ValidateConstraint, constraint name, greenplum/postgresql
Enable/disable
- EAlterTableOptionType.enableTrigger, trigger name, greenplum/postgresql.
- EAlterTableOptionType.enableAlwaysTrigger, trigger name, greenplum/postgresql.
- EAlterTableOptionType.enableReplicaTrigger, trigger name, greenplum/postgresql.
- EAlterTableOptionType.disableTrigger, trigger name, greenplum/postgresql.
- EAlterTableOptionType.enableRule, rule name, greenplum/postgresql.
- EAlterTableOptionType.enableAlwaysRule, rule name, greenplum/postgresql.
- EAlterTableOptionType.enableReplicaRule, rule name, greenplum/postgresql.
- EAlterTableOptionType.disableRule, rule name, greenplum.
Others
- EAlterTableOptionType.RenameTable, new table name
- EAlterTableOptionType.inherit, parent table, greenplum/postgresql.
- EAlterTableOptionType.noInherit, parent table, greenplum/postgresql.
- EAlterTableOptionType.ofAnyType, type name, greenplum/postgresql.
- EAlterTableOptionType.ownerTo, owner name, greenplum/postgresql.
- EAlterTableOptionType.setTablespace, tablespace name, greenplum/postgresql.
- EAlterTableOptionType.setSchema, schema name, greenplum.
- EAlterTableOptionType.clusterOn, index name, postgresql.

Constructor Summary

Constructors
Constructor and Description

TAlterTableOption()

Constructors
Constructor and Description
`TAlterTableOption()`

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`	`doParse(TCustomSqlStatement psql, ESqlClause plocation)` Analyze the sub-nodes inside this node.
`EAlterColumnSubType`	`getAlterColumnSubType()` subtype of alter column.
`TObjectName`	`getAnyTypeName()` Greenplum, Postgresql,Snowflake, any name when option type is `EAlterTableOptionType.ofAnyType`
`TPTNodeList<TAttributeOption>`	`getAttributeOptions()` Greenplum,PostgreSQL,Snowflake, set/reset options when option type is `EAlterTableOptionType.AlterColumn` and subtype is `EAlterColumnSubType.SetOptions` or `EAlterColumnSubType.ResetOptions`
`TColumnDefinitionList`	`getColumnDefinitionList()` List of `TColumnDefinitionList`, valid when `getOptionType()` is:
`TObjectName`	`getColumnName()` valid when `getOptionType()` is:
`TObjectNameList`	`getColumnNameList()` List of `TObjectNameList`, valid when `getOptionType()` is:
`TExpression`	`getCommentExpr()`
`TConstraintList`	`getConstraintList()` List of `TConstraint` in add constraint clause, valid when `getOptionType()` is `EAlterTableOptionType.AddConstraint`
`TObjectName`	`getConstraintName()` valid when `getOptionType()` is:
`TObjectNameList`	`getConstraintNameList()` constraint name list when option type is: `EAlterTableOptionType.DropConstraint`
`TExpression`	`getDefaultExpr()` MySQL, PostgreSQL, expression in set default clause of alter column.
`EKeyReferenceType`	`getDropRestrictType()` drop restrict type such as: cascade, restrict
`TPartitionExtensionClause`	`getExchangePartitionSpec()` Hive,Impala, partition spec of EXCHANGE partitionSpec WITH TABLE tableName clause.
`THiveTableFileFormat`	`getFileFormat()` Hive,Impala,file format of SET FILEFORMAT clause valid when `getOptionType()` is `EAlterTableOptionType.setFileFormat`
`TPTNodeList<TColumnWithSortOrder>`	`getIndexCols()` MySQL, column list of foreign key
`TObjectName`	`getIndexName()` Greenplum, Postgresql, Snowflake, index name when option type is `EAlterTableOptionType.clusterOn`
`TPTNodeList<TMySQLIndexOption>`	`getIndexOptionList()` MySQL, index options
`TMySQLIndexStorageType`	`getMySQLIndexStorageType()` Deprecated. As of v1.7.2.4. use `getIndexOptionList()` instead.
`TSourceToken`	`getMySQLIndexTypeToken()` MySQL, unique, fulltext or spatial keyword used in add key/index clause when option type is `EAlterTableOptionType.AddConstraintIndex`
`TObjectName`	`getNewCollation()` new collation when option type is `EAlterTableOptionType.AlterColumn` and subtype is `EAlterColumnSubType.SetDataType`
`TColumnDefinition`	`getNewColumnDef()`
`TObjectName`	`getNewColumnName()` new column name valid when `getOptionType()` is `EAlterTableOptionType.RenameColumn`
`TObjectName`	`getNewConstraintName()` new constraint name valid when `getOptionType()` is `EAlterTableOptionType.RenameConstraint`
`TTypeName`	`getNewDataType()` new data type when option type is `EAlterTableOptionType.AlterColumn` and subtype is `EAlterColumnSubType.SetDataType`
`TObjectName`	`getNewOwnerName()` owner name or roleId when option type is `EAlterTableOptionType.ownerTo`
`TPartitionExtensionClause`	`getNewPartitionSpec()` Hive, Impala, new partition spec in RENAME TO clause valid when `getOptionType()` is: `EAlterTableOptionType.renamePartition`
`TObjectName`	`getNewTableName()` new table name is valid when option type is one of the following values: `EAlterTableOptionType.RenameTable`, new table in rename to clause `EAlterTableOptionType.setPrivileges`, Netezza, table name in set privileges to clause `EAlterTableOptionType.exchangePartition`,Hive, Impala, table name in exchange partition with table clause `EAlterTableOptionType.switchPartition`, SQL Server, Openedge, table name of switch partition to target_table clause
`TObjectName`	`getNewTablespaceName()` Greenplum, Postgresql, Snowflake, tablespace name when option type is `EAlterTableOptionType.setTablespace`
`TConstant`	`getNumberOfBuckets()` Hive, Impala, number of buckets of INTO BUCKETS clause valid when `getOptionType()` is: `EAlterTableOptionType.tableBuckets`
`EAlterTableOptionType`	`getOptionType()` Type of this alter table option
`TObjectName`	`getParentTable()` Greenplum, Postgresql,Snowflake, parent table when option type is `EAlterTableOptionType.inherit` or `EAlterTableOptionType.noInherit`
`TColumnDefinition`	`getPartitionColumnDef()` Hive,Impala, column of PARTITION COLUMN ( columnDef ) clause valid when `getOptionType()` is: `EAlterTableOptionType.clusteredSorted`
`TExpression`	`getPartitionExpression1()` SQL Server, source_partition_number_expression in switch partition clause
`TExpression`	`getPartitionExpression2()` SQL Server, target_partition_number_expression in switch partition clause
`TObjectName`	`getPartitionName()` partition name in PostgreSQL attached partition clause.
`TPTNodeList<TPartitionExtensionClause>`	`getPartitionSpecList()` Hive, Impala, partition spec list in unarchive clause when option type is `EAlterTableOptionType.unArchive`, `EAlterTableOptionType.archive`.
`TObjectNameList`	`getReferencedColumnList()` MySQL, referenced column list in foreign key clause.
`TObjectName`	`getReferencedObjectName()` referenced table in foreign key clause.
`TTable`	`getReferencedTable()` referenced table in foreign key clause
`TExpression`	`getRetenttionTimeInDays()`
`TObjectName`	`getRuleName()` Greenplum, Postgresql,Snowflake, rule name when option type is `EAlterTableOptionType.enableRule` or `EAlterTableOptionType.enableAlwaysRule` or `EAlterTableOptionType.enableReplicaRule` or `EAlterTableOptionType.disableRule`
`TObjectName`	`getSchemaName()` Greenplum, Schema name when option type is `EAlterTableOptionType.setSchema`
`TObjectName`	`getSerdeName()` valid when `getOptionType()` is:
`TExpressionList`	`getSkewedLocations()` Hive, Impala, skewed location of SET SKEWED LOCATION clause valid when `getOptionType()` is: `EAlterTableOptionType.skewedLocation`
`TConstant`	`getStatisticsValue()` Greenplum,PostgreSQL,Snowflake, statistics value when option type is `EAlterTableOptionType.AlterColumn` and subtype is `EAlterColumnSubType.SetStatistics`
`TObjectName`	`getStorageName()` storage name when option type is `EAlterTableOptionType.AlterColumn` and subtype is `EAlterColumnSubType.SetStorage`
`THiveTableBuckets`	`getTableBuckets()` Hive, Impala, clustered by ...
`TConstraint`	`getTableConstraint()` table constraint when option type is `EAlterTableOptionType.AddConstraint`
`TObjectName`	`getTableLocation()` Hive,Impala, file location of SET LOCATION clause valid when `getOptionType()` is: `EAlterTableOptionType.setLocation`
`TPTNodeList<THiveKeyValueProperty>`	`getTableProperties()` Hive, Impala, table properties of SET/UNSET TBLPROPERTIES clause when `getOptionType()` is `EAlterTableOptionType.setTableProperties` or `EAlterTableOptionType.unsetTableProperties` table properties of SET SERDE clause when `getOptionType()` is `EAlterTableOptionType.serde`
`THiveTableSkewed`	`getTableSkewed()` Hive, Impala, tableSkewed clause syntax like: SKEWED BY '(' columnNameList ')' ON '(' skewedValueElement ')' valid when `getOptionType()` is: `EAlterTableOptionType.tableSkewed`
`TObjectName`	`getTriggerName()` Greenplum, Postgresql,Snowflake, trigger name when option type is `EAlterTableOptionType.enableTrigger` or `EAlterTableOptionType.enableAlwaysTrigger` or `EAlterTableOptionType.enableReplicaTrigger` or `EAlterTableOptionType.disableTrigger`
`TExpression`	`getUsingExpr()` using expr when option type is `EAlterTableOptionType.AlterColumn` and subtype is `EAlterColumnSubType.SetDataType`
`void`	`init(Object arg1)` Initialize a query tree node.
`void`	`init(Object arg1, Object arg2)`
`void`	`init(Object arg1, Object arg2, Object arg3)`
`void`	`init(Object arg1, Object arg2, Object arg3, Object arg4)`
`void`	`setAnyTypeName(TObjectName anyTypeName)`
`void`	`setAttributeOptions(TPTNodeList<TAttributeOption> attributeOptions)`
`void`	`setColumnDefinitionList(TColumnDefinitionList columnDefinitionList)`
`void`	`setColumnName(TObjectName columnName)`
`void`	`setColumnNameList(TObjectNameList columnNameList)`
`void`	`setConstraintList(TConstraintList constraintList)`
`void`	`setConstraintName(TDummy pName)`
`void`	`setConstraintName(TObjectName constraintName)`
`void`	`setConstraintNameList(TObjectNameList constraintNameList)`
`void`	`setDefaultExpr(TExpression defaultExpr)`
`void`	`setDropRestrictType(EKeyReferenceType dropRestrictType)`
`void`	`setDropRestrictType(TSourceToken st)`
`void`	`setExchangePartitionSpec(TPartitionExtensionClause exchangePartitionSpec)`
`void`	`setFileFormat(THiveTableFileFormat fileFormat)`
`void`	`setIndexCols(TPTNodeList<TColumnWithSortOrder> indexCols)`
`void`	`setIndexName(TObjectName indexName)`
`void`	`setIndexOptionList(TPTNodeList<TMySQLIndexOption> indexOptionList)`
`void`	`setMySQLIndexStorageType(TMySQLIndexStorageType mySQLIndexStorageType)`
`void`	`setMySQLIndexTypeToken(TSourceToken mySQLIndexTypeToken)`
`void`	`setNewCollation(TObjectName newCollation)`
`void`	`setNewColumnDef(TColumnDefinition newColumnDef)`
`void`	`setNewColumnName(TObjectName newColumnName)`
`void`	`setNewConstraintName(TObjectName newConstraintName)`
`void`	`setNewDataType(TTypeName newDataType)`
`void`	`setNewOwnerName(TObjectName newOwnerName)`
`void`	`setNewPartitionSpec(TPartitionExtensionClause newPartitionSpec)`
`void`	`setNewTableName(TObjectName newTableName)` set new table name when option type is `EAlterTableOptionType.RenameTable`
`void`	`setNewTablespaceName(TObjectName newTablespaceName)`
`void`	`setNumberOfBuckets(TConstant numberOfBuckets)`
`void`	`setOptionType(EAlterTableOptionType optionType)`
`void`	`setParentTable(TObjectName parentTable)`
`void`	`setPartitionColumnDef(TColumnDefinition partitionColumnDef)`
`void`	`setPartitionExpression1(TExpression partitionExpression1)`
`void`	`setPartitionExpression2(TExpression partitionExpression2)`
`void`	`setPartitionSpecList(TPTNodeList<TPartitionExtensionClause> partitionSpecList)`
`void`	`setReferencedColumnList(TObjectNameList referencedColumnList)`
`void`	`setReferencedObjectName(TObjectName referencedObjectName)`
`void`	`setRuleName(TObjectName ruleName)`
`void`	`setSchemaName(TObjectName schemaName)`
`void`	`setSerdeName(TObjectName serdeName)`
`void`	`setSkewedLocations(TExpressionList skewedLocations)`
`void`	`setStatisticsValue(TConstant statisticsValue)`
`void`	`setStorageName(TObjectName storageName)`
`void`	`setTableBuckets(THiveTableBuckets tableBuckets)`
`void`	`setTableConstraint(TConstraint tableConstraint)`
`void`	`setTableLocation(TObjectName tableLocation)`
`void`	`setTableProperties(TPTNodeList<THiveKeyValueProperty> tableProperties)`
`void`	`setTableSkewed(THiveTableSkewed tableSkewed)`
`void`	`setTriggerName(TObjectName triggerName)`
`void`	`setUsingExpr(TExpression usingExpr)`

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

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

- Constructor Detail
  - TAlterTableOption
```
public TAlterTableOption()
```
- Method Detail
  - getAlterColumnSubType
```
public EAlterColumnSubType getAlterColumnSubType()
```
    subtype of alter column.
    
    Returns:
    
    subtype of alter column.
  - setIndexOptionList
```
public void setIndexOptionList(TPTNodeList<TMySQLIndexOption> indexOptionList)
```
  - getIndexOptionList
```
public TPTNodeList<TMySQLIndexOption> getIndexOptionList()
```
    MySQL, index options
    
    Returns:
    
    index options
  - setIndexCols
```
public void setIndexCols(TPTNodeList<TColumnWithSortOrder> indexCols)
```
  - getIndexCols
```
public TPTNodeList<TColumnWithSortOrder> getIndexCols()
```
    MySQL, column list of foreign key
    
    Returns:
    
    column list of foreign key
  - setDropRestrictType
```
public void setDropRestrictType(TSourceToken st)
```
  - getDropRestrictType
```
public EKeyReferenceType getDropRestrictType()
```
    drop restrict type such as: cascade, restrict
    
    Returns:
    
    drop restrict type such as: cascade, restrict
  - getOptionType
```
public EAlterTableOptionType getOptionType()
```
    Type of this alter table option
    
    Returns:
    
    Type of this alter table option
  - getReferencedTable
```
public TTable getReferencedTable()
```
    referenced table in foreign key clause
    
    Returns:
    
    referenced table in foreign key clause
  - getPartitionName
```
public TObjectName getPartitionName()
```
    partition name in PostgreSQL attached partition clause.
    
    Returns:
    
    partition name
  - getPartitionExpression2
```
public TExpression getPartitionExpression2()
```
    SQL Server, target_partition_number_expression in switch partition clause
    
    Returns:
  - getPartitionExpression1
```
public TExpression getPartitionExpression1()
```
    SQL Server, source_partition_number_expression in switch partition clause
    
    Returns:
    
    source_partition_number_expression
  - getConstraintNameList
```
public TObjectNameList getConstraintNameList()
```
    constraint name list when option type is: EAlterTableOptionType.DropConstraint
    
    Returns:
    
    constraint name list
  - getSchemaName
```
public TObjectName getSchemaName()
```
    Greenplum, Schema name when option type is EAlterTableOptionType.setSchema
    
    Returns:
    
    schema name
  - setNewTablespaceName
```
public void setNewTablespaceName(TObjectName newTablespaceName)
```
  - getNewTablespaceName
```
public TObjectName getNewTablespaceName()
```
    Greenplum, Postgresql, Snowflake, tablespace name when option type is EAlterTableOptionType.setTablespace
    
    Returns:
    
    tablespace name
  - setNewOwnerName
```
public void setNewOwnerName(TObjectName newOwnerName)
```
  - getNewOwnerName
```
public TObjectName getNewOwnerName()
```
    owner name or roleId when option type is EAlterTableOptionType.ownerTo
    
    Returns:
    
    owner name or role id
  - setAnyTypeName
```
public void setAnyTypeName(TObjectName anyTypeName)
```
  - getAnyTypeName
```
public TObjectName getAnyTypeName()
```
    Greenplum, Postgresql,Snowflake, any name when option type is EAlterTableOptionType.ofAnyType
    
    Returns:
    
    any name
  - setParentTable
```
public void setParentTable(TObjectName parentTable)
```
  - getParentTable
```
public TObjectName getParentTable()
```
    Greenplum, Postgresql,Snowflake, parent table when option type is EAlterTableOptionType.inherit or EAlterTableOptionType.noInherit
    
    Returns:
    
    parent table
  - setRuleName
```
public void setRuleName(TObjectName ruleName)
```
  - getRuleName
```
public TObjectName getRuleName()
```
    Greenplum, Postgresql,Snowflake, rule name when option type is EAlterTableOptionType.enableRule or EAlterTableOptionType.enableAlwaysRule or EAlterTableOptionType.enableReplicaRule or EAlterTableOptionType.disableRule
    
    Returns:
    
    rule name
  - setTriggerName
```
public void setTriggerName(TObjectName triggerName)
```
  - getTriggerName
```
public TObjectName getTriggerName()
```
    Greenplum, Postgresql,Snowflake, trigger name when option type is EAlterTableOptionType.enableTrigger or EAlterTableOptionType.enableAlwaysTrigger or EAlterTableOptionType.enableReplicaTrigger or EAlterTableOptionType.disableTrigger
    
    Returns:
    
    trigger name
  - setIndexName
```
public void setIndexName(TObjectName indexName)
```
  - getIndexName
```
public TObjectName getIndexName()
```
    Greenplum, Postgresql, Snowflake, index name when option type is EAlterTableOptionType.clusterOn
    
    Returns:
    
    index name
  - setTableConstraint
```
public void setTableConstraint(TConstraint tableConstraint)
```
  - getTableConstraint
```
public TConstraint getTableConstraint()
```
    table constraint when option type is EAlterTableOptionType.AddConstraint
    
    Returns:
    
    table constraint
  - setUsingExpr
```
public void setUsingExpr(TExpression usingExpr)
```
  - getUsingExpr
```
public TExpression getUsingExpr()
```
    using expr when option type is EAlterTableOptionType.AlterColumn and subtype is EAlterColumnSubType.SetDataType
    
    Returns:
    
    using expr
  - setNewCollation
```
public void setNewCollation(TObjectName newCollation)
```
  - getNewCollation
```
public TObjectName getNewCollation()
```
    new collation when option type is EAlterTableOptionType.AlterColumn and subtype is EAlterColumnSubType.SetDataType
    
    Returns:
    
    new collation
  - setNewDataType
```
public void setNewDataType(TTypeName newDataType)
```
  - getNewDataType
```
public TTypeName getNewDataType()
```
    new data type when option type is EAlterTableOptionType.AlterColumn and subtype is EAlterColumnSubType.SetDataType
    
    Returns:
    
    new data type
  - setStorageName
```
public void setStorageName(TObjectName storageName)
```
  - getStorageName
```
public TObjectName getStorageName()
```
    storage name when option type is EAlterTableOptionType.AlterColumn and subtype is EAlterColumnSubType.SetStorage
    
    Returns:
    
    storage name
  - setAttributeOptions
```
public void setAttributeOptions(TPTNodeList<TAttributeOption> attributeOptions)
```
  - getAttributeOptions
```
public TPTNodeList<TAttributeOption> getAttributeOptions()
```
    Greenplum,PostgreSQL,Snowflake, set/reset options when option type is EAlterTableOptionType.AlterColumn and subtype is EAlterColumnSubType.SetOptions or EAlterColumnSubType.ResetOptions
    
    Returns:
    
    set/reset options
  - setStatisticsValue
```
public void setStatisticsValue(TConstant statisticsValue)
```
  - getStatisticsValue
```
public TConstant getStatisticsValue()
```
    Greenplum,PostgreSQL,Snowflake, statistics value when option type is EAlterTableOptionType.AlterColumn and subtype is EAlterColumnSubType.SetStatistics
    
    Returns:
    
    statistcs value
  - setDefaultExpr
```
public void setDefaultExpr(TExpression defaultExpr)
```
  - getDefaultExpr
```
public TExpression getDefaultExpr()
```
    MySQL, PostgreSQL, expression in set default clause of alter column.
    
    Returns:
    
    expression in set default clause of alter column.
  - setMySQLIndexTypeToken
```
public void setMySQLIndexTypeToken(TSourceToken mySQLIndexTypeToken)
```
  - getMySQLIndexTypeToken
```
public TSourceToken getMySQLIndexTypeToken()
```
    MySQL, unique, fulltext or spatial keyword used in add key/index clause when option type is EAlterTableOptionType.AddConstraintIndex
    
    Returns:
    
    unique, fulltext or spatial keyword
  - setMySQLIndexStorageType
```
public void setMySQLIndexStorageType(TMySQLIndexStorageType mySQLIndexStorageType)
```
  - getMySQLIndexStorageType
```
public TMySQLIndexStorageType getMySQLIndexStorageType()
```
    Deprecated. As of v1.7.2.4. use getIndexOptionList() instead.
    
    Returns:
    
    index storage type
  - setNewTableName
```
public void setNewTableName(TObjectName newTableName)
```
    set new table name when option type is EAlterTableOptionType.RenameTable
    
    Parameters:
    
    newTableName - the new table name
  - getNewTableName
```
public TObjectName getNewTableName()
```
    new table name is valid when option type is one of the following values:
    - EAlterTableOptionType.RenameTable, new table in rename to clause
    - EAlterTableOptionType.setPrivileges, Netezza, table name in set privileges to clause
    - EAlterTableOptionType.exchangePartition,Hive, Impala, table name in exchange partition with table clause
    - EAlterTableOptionType.switchPartition, SQL Server, Openedge, table name of switch partition to target_table clause
    Returns:
    
    new table name
  - setReferencedColumnList
```
public void setReferencedColumnList(TObjectNameList referencedColumnList)
```
  - setReferencedObjectName
```
public void setReferencedObjectName(TObjectName referencedObjectName)
```
  - setColumnName
```
public void setColumnName(TObjectName columnName)
```
  - getConstraintList
```
public TConstraintList getConstraintList()
```
    List of TConstraint in add constraint clause, valid when getOptionType() is EAlterTableOptionType.AddConstraint
    
    Returns:
    
    constraint list
  - getColumnNameList
```
public TObjectNameList getColumnNameList()
```
    List of TObjectNameList, valid when getOptionType() is:
    EAlterTableOptionType.SetUnUsedColumn
    EAlterTableOptionType.DropColumn
    EAlterTableOptionType.AddConstraintIndex, columns of an index
    EAlterTableOptionType.AddConstraintPK, columns of primary key
    EAlterTableOptionType.AddConstraintUnique, columns of unique key
    EAlterTableOptionType.AddConstraintFK, columns of foreign key
    EAlterTableOptionType.DropConstraintUnique, available in Oracle
    
    Returns:
    
    column name list
  - getColumnDefinitionList
```
public TColumnDefinitionList getColumnDefinitionList()
```
    List of TColumnDefinitionList, valid when getOptionType() is:
    EAlterTableOptionType.AddColumn
    EAlterTableOptionType.ModifyColumn
    
    Returns:
    
    column definition list
  - getColumnName
```
public TObjectName getColumnName()
```
    valid when getOptionType() is:
    EAlterTableOptionType.AlterColumn
    EAlterTableOptionType.RenameColumn
    EAlterTableOptionType.ChangeColumn
    EAlterTableOptionType.AddConstraintIndex, index name, optional
    
    Returns:
    
    column name
  - getConstraintName
```
public TObjectName getConstraintName()
```
    valid when getOptionType() is:
    EAlterTableOptionType.AddConstraintPK, optional
    EAlterTableOptionType.AddConstraintUnique, optional
    EAlterTableOptionType.AddConstraintFK, optional
    EAlterTableOptionType.ModifyConstraint
    EAlterTableOptionType.RenameConstraint
    EAlterTableOptionType.DropConstraintFK
    EAlterTableOptionType.DropConstraintUnique, available in DB2
    EAlterTableOptionType.DropConstraintCheck, available in DB2
    EAlterTableOptionType.DropConstraintIndex, available in DB2
    EAlterTableOptionType.DropConstraintKey, available in DB2
    EAlterTableOptionType.AlterConstraintFK, available in DB2
    EAlterTableOptionType.AlterConstraintCheck, available in DB2
    
    Returns:
    
    constraint name
  - getNewColumnName
```
public TObjectName getNewColumnName()
```
    new column name valid when getOptionType() is EAlterTableOptionType.RenameColumn
    
    Returns:
    
    new column name
  - getNewConstraintName
```
public TObjectName getNewConstraintName()
```
    new constraint name valid when getOptionType() is EAlterTableOptionType.RenameConstraint
    
    Returns:
    
    new constraint name
  - getReferencedColumnList
```
public TObjectNameList getReferencedColumnList()
```
    MySQL, referenced column list in foreign key clause.
    
    Returns:
    
    referenced column list in foreign key clause.
  - getReferencedObjectName
```
public TObjectName getReferencedObjectName()
```
    referenced table in foreign key clause. Please use getReferencedTable() instead.
    
    Returns:
    
    referenced table in foreign key clause
  - init
```
public void init(Object arg1)
```
    Description copied from class: TParseTreeNode
    
    Initialize a query tree node. Used internally
    
    Overrides:
    
    init in class TParseTreeNode
    
    Parameters:
    
    arg1 - first argument
  - init
```
public void init(Object arg1,
                 Object arg2)
```
    Overrides:
    
    init in class TParseTreeNode
  - getCommentExpr
```
public TExpression getCommentExpr()
```
  - setNewConstraintName
```
public void setNewConstraintName(TObjectName newConstraintName)
```
  - setConstraintName
```
public void setConstraintName(TDummy pName)
```
  - setConstraintName
```
public void setConstraintName(TObjectName constraintName)
```
  - getNewColumnDef
```
public TColumnDefinition getNewColumnDef()
```
    Returns:
    
    TColumnDefinition, valid when getOptionType() is:
    EAlterTableOptionType.ChangeColumn
  - getSerdeName
```
public TObjectName getSerdeName()
```
    valid when getOptionType() is:
    EAlterTableOptionType.serde
    
    Returns:
    
    serde name
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3)
```
    Overrides:
    
    init in class TParseTreeNode
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3,
                 Object arg4)
```
    Overrides:
    
    init in class TParseTreeNode
  - getPartitionSpecList
```
public TPTNodeList<TPartitionExtensionClause> getPartitionSpecList()
```
    Hive, Impala, partition spec list in unarchive clause when option type is EAlterTableOptionType.unArchive, EAlterTableOptionType.archive.
    partition spec list in touch clause when option type is EAlterTableOptionType.touch,
    partition spec list in drop clause when option type is EAlterTableOptionType.dropPartitionSpecList,
    partition spec list in add clause when option type is EAlterTableOptionType.addPartitionSpecList,
    
    Returns:
    
    partition spec list
  - getTableProperties
```
public TPTNodeList<THiveKeyValueProperty> getTableProperties()
```
    Hive, Impala, table properties of SET/UNSET TBLPROPERTIES clause when getOptionType() is EAlterTableOptionType.setTableProperties or EAlterTableOptionType.unsetTableProperties
    table properties of SET SERDE clause when getOptionType() is EAlterTableOptionType.serde
    
    Returns:
    
    table properties of SET/UNSET TBLPROPERTIES/SET SERDE clause.
  - getFileFormat
```
public THiveTableFileFormat getFileFormat()
```
    Hive,Impala,file format of SET FILEFORMAT clause valid when getOptionType() is EAlterTableOptionType.setFileFormat
    
    Returns:
    
    file format of SET FILEFORMAT
  - getTableLocation
```
public TObjectName getTableLocation()
```
    Hive,Impala, file location of SET LOCATION clause valid when getOptionType() is: EAlterTableOptionType.setLocation
    
    Returns:
    
    file location of SET LOCATION clause
  - getNewPartitionSpec
```
public TPartitionExtensionClause getNewPartitionSpec()
```
    Hive, Impala, new partition spec in RENAME TO clause valid when getOptionType() is: EAlterTableOptionType.renamePartition
    
    Returns:
    
    new partition spec in RENAME TO clause
  - getNumberOfBuckets
```
public TConstant getNumberOfBuckets()
```
    Hive, Impala, number of buckets of INTO BUCKETS clause valid when getOptionType() is: EAlterTableOptionType.tableBuckets
    
    Returns:
    
    number of buckets of INTO BUCKETS clause
  - getSkewedLocations
```
public TExpressionList getSkewedLocations()
```
    Hive, Impala, skewed location of SET SKEWED LOCATION clause valid when getOptionType() is: EAlterTableOptionType.skewedLocation
    
    Returns:
    
    skewed location of SET SKEWED LOCATION clause
  - getTableBuckets
```
public THiveTableBuckets getTableBuckets()
```
    Hive, Impala, clustered by ... [sorted by ...] into number buckets valid when getOptionType() is: EAlterTableOptionType.clusteredSorted
    
    Returns:
    
    table buckets
  - getPartitionColumnDef
```
public TColumnDefinition getPartitionColumnDef()
```
    Hive,Impala, column of PARTITION COLUMN ( columnDef ) clause valid when getOptionType() is: EAlterTableOptionType.clusteredSorted
    
    Returns:
    
    column of PARTITION COLUMN ( columnDef ) clause
  - getTableSkewed
```
public THiveTableSkewed getTableSkewed()
```
    Hive, Impala, tableSkewed clause syntax like: SKEWED BY '(' columnNameList ')' ON '(' skewedValueElement ')' valid when getOptionType() is: EAlterTableOptionType.tableSkewed
    
    Returns:
    
    tableSkewed clause
  - getExchangePartitionSpec
```
public TPartitionExtensionClause getExchangePartitionSpec()
```
    Hive,Impala, partition spec of EXCHANGE partitionSpec WITH TABLE tableName clause. valid when getOptionType() is: EAlterTableOptionType.exchangePartition
    
    Returns:
    
    partition spec of EXCHANGE partitionSpec WITH TABLE tableName clause.
  - doParse
```
public void doParse(TCustomSqlStatement psql,
                    ESqlClause plocation)
```
    Description copied from class: TParseTreeNode
    
    Analyze the sub-nodes inside this node. Such as build the relationship between table and column.
    
    Overrides:
    
    doParse in class TParseTreeNode
    
    Parameters:
    
    psql - SQL statement this node belongs to
    
    plocation - SQL clause this node belongs to
  - getRetenttionTimeInDays
```
public TExpression getRetenttionTimeInDays()
```
  - accept
```
public void accept(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor
    
    Specified by:
    
    accept in interface Visitable
    
    Overrides:
    
    accept in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - acceptChildren
```
public void acceptChildren(TParseTreeVisitor v)
```
    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
  - setSerdeName
```
public void setSerdeName(TObjectName serdeName)
```
  - setDropRestrictType
```
public void setDropRestrictType(EKeyReferenceType dropRestrictType)
```
  - setColumnDefinitionList
```
public void setColumnDefinitionList(TColumnDefinitionList columnDefinitionList)
```
  - setConstraintList
```
public void setConstraintList(TConstraintList constraintList)
```
  - setColumnNameList
```
public void setColumnNameList(TObjectNameList columnNameList)
```
  - setNewColumnName
```
public void setNewColumnName(TObjectName newColumnName)
```
  - setSchemaName
```
public void setSchemaName(TObjectName schemaName)
```
  - setConstraintNameList
```
public void setConstraintNameList(TObjectNameList constraintNameList)
```
  - setPartitionExpression1
```
public void setPartitionExpression1(TExpression partitionExpression1)
```
  - setPartitionExpression2
```
public void setPartitionExpression2(TExpression partitionExpression2)
```
  - setNewColumnDef
```
public void setNewColumnDef(TColumnDefinition newColumnDef)
```
  - setPartitionSpecList
```
public void setPartitionSpecList(TPTNodeList<TPartitionExtensionClause> partitionSpecList)
```
  - setTableProperties
```
public void setTableProperties(TPTNodeList<THiveKeyValueProperty> tableProperties)
```
  - setFileFormat
```
public void setFileFormat(THiveTableFileFormat fileFormat)
```
  - setTableLocation
```
public void setTableLocation(TObjectName tableLocation)
```
  - setNewPartitionSpec
```
public void setNewPartitionSpec(TPartitionExtensionClause newPartitionSpec)
```
  - setNumberOfBuckets
```
public void setNumberOfBuckets(TConstant numberOfBuckets)
```
  - setSkewedLocations
```
public void setSkewedLocations(TExpressionList skewedLocations)
```
  - setTableBuckets
```
public void setTableBuckets(THiveTableBuckets tableBuckets)
```
  - setPartitionColumnDef
```
public void setPartitionColumnDef(TColumnDefinition partitionColumnDef)
```
  - setTableSkewed
```
public void setTableSkewed(THiveTableSkewed tableSkewed)
```
  - setExchangePartitionSpec
```
public void setExchangePartitionSpec(TPartitionExtensionClause exchangePartitionSpec)
```
  - setOptionType
```
public void setOptionType(EAlterTableOptionType optionType)
```

Class TAlterTableOption

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class java.lang.Object

Constructor Detail

TAlterTableOption

Method Detail

getAlterColumnSubType

setIndexOptionList

getIndexOptionList

setIndexCols

getIndexCols

setDropRestrictType

getDropRestrictType

getOptionType

getReferencedTable

getPartitionName

getPartitionExpression2

getPartitionExpression1

getConstraintNameList

getSchemaName

setNewTablespaceName

getNewTablespaceName

setNewOwnerName

getNewOwnerName

setAnyTypeName

getAnyTypeName

setParentTable

getParentTable

setRuleName

getRuleName

setTriggerName

getTriggerName

setIndexName

getIndexName

setTableConstraint

getTableConstraint

setUsingExpr

getUsingExpr

setNewCollation

getNewCollation

setNewDataType

getNewDataType

setStorageName

getStorageName

setAttributeOptions

getAttributeOptions

setStatisticsValue

getStatisticsValue

setDefaultExpr

getDefaultExpr

setMySQLIndexTypeToken

getMySQLIndexTypeToken

setMySQLIndexStorageType

getMySQLIndexStorageType

setNewTableName

getNewTableName

setReferencedColumnList

setReferencedObjectName

setColumnName

getConstraintList

getColumnNameList

getColumnDefinitionList

getColumnName

getConstraintName

getNewColumnName

getNewConstraintName

getReferencedColumnList

getReferencedObjectName

init

init

getCommentExpr

setNewConstraintName

setConstraintName

setConstraintName

getNewColumnDef

getSerdeName

init

init