com.foundationdb.sql.parser

Class AlterTableNode

java.lang.Object

com.foundationdb.sql.parser.QueryTreeNode

com.foundationdb.sql.parser.StatementNode

com.foundationdb.sql.parser.DDLStatementNode

com.foundationdb.sql.parser.AlterTableNode

All Implemented Interfaces:

Visitable

public class AlterTableNode
extends DDLStatementNode

A AlterTableNode represents a DDL statement that alters a table. It contains the name of the object to be created.

Field Summary

Fields

Modifier and Type	Field and Description
int	behavior
boolean	compressTable
boolean	defragment
boolean	purge
boolean	sequential
boolean	truncateEndOfTable

Fields inherited from class com.foundationdb.sql.parser.DDLStatementNode

ADD_TYPE, DROP_TYPE, LOCKING_TYPE, MODIFY_TYPE, UNKNOWN_TYPE

Fields inherited from class com.foundationdb.sql.parser.QueryTreeNode

AUTOINCREMENT_CREATE_MODIFY, AUTOINCREMENT_INC_INDEX, AUTOINCREMENT_IS_AUTOINCREMENT_INDEX, AUTOINCREMENT_START_INDEX

Constructor Summary

Constructors

Constructor and Description
AlterTableNode()

Method Summary

Methods

Modifier and Type	Method and Description
void	copyFrom(QueryTreeNode node) Fill this node with a deep copy of the given node.
int	getBehavior()
int	getChangeType()
ExistenceCheck	getExistenceCheck()
String	getIndexNameForUpdateStatistics()
TableElementList	getTableElementList()
void	init(Object objectName, Object arg2, Object existenceCheck) Initializer for a TRUNCATE TABLE or COMPRESS using temporary tables rather than inplace compress
void	init(Object objectName, Object updateStatisticsAll, Object indexName, Object existenceCheck) Initializer for a AlterTableNode for updating the statistics.
void	init(Object objectName, Object arg2, Object arg3, Object arg4, Object existenceCheck) Initializer for AlterTableNode for a) INPLACE COMPRESS b) Generic alter table actions
boolean	isCascade()
boolean	isCompressTable()
boolean	isTruncateTable()
boolean	isUpdateStatistics()
boolean	isUpdateStatisticsAll()
void	printSubNodes(int depth) Prints the sub-nodes of this object.
String	statementToString()
String	toString() Convert this object to a String.

Methods inherited from class com.foundationdb.sql.parser.DDLStatementNode

getFullName, getObjectName, getRelativeName, init, initAndCheck, isAtomic

Methods inherited from class com.foundationdb.sql.parser.QueryTreeNode

accept, convertDefaultNode, debugFlush, debugPrint, formatNodeString, getBeginOffset, getDebugOutput, getEndOffset, getNodeFactory, getNodeType, getNullNode, getParserContext, getStatementType, getUserData, init, init, init, init, init, init, init, init, init, init, isInstanceOf, makeTableName, makeTableName, nodeHeader, printLabel, setBeginOffset, setDebugOutput, setEndOffset, setNodeType, setParserContext, setUserData, stackPrint, treePrint, treePrint, treePrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

compressTable

public boolean compressTable

sequential

public boolean sequential

purge

public boolean purge

defragment

public boolean defragment

truncateEndOfTable

public boolean truncateEndOfTable

behavior

public int behavior

Constructor Detail

AlterTableNode

public AlterTableNode()

Method Detail

init

public void init(Object objectName,
        Object updateStatisticsAll,
        Object indexName,
        Object existenceCheck)
          throws StandardException

Initializer for a AlterTableNode for updating the statistics. The user can ask for update statistic of all the indexes or only a specific index

Overrides:

init in class QueryTreeNode

Parameters:

objectName - The name of the table whose index(es) will have their statistics updated.

updateStatisticsAll - If true then update the statistics of all the indexes on the table. If false, then update the statistics of only the index provided as 3rd parameter here

indexName - Only used if updateStatisticsAll is set to false.

existenceCheck - ExistenceCheck for IF EXISTS

Throws:

StandardException - Thrown on error

init

public void init(Object objectName,
        Object arg2,
        Object existenceCheck)
          throws StandardException

Initializer for a TRUNCATE TABLE or COMPRESS using temporary tables rather than inplace compress

Overrides:

init in class QueryTreeNode

Parameters:

objectName - The name of the table being altered

arg2 - int[]: Behavior CASCADE or RESTRICTED Boolean: Whether or not the COMPRESS is SEQUENTIAL

existenceCheck - ExistenceCheck for IF EXISTS

Throws:

StandardException - Thrown on error

init

public void init(Object objectName,
        Object arg2,
        Object arg3,
        Object arg4,
        Object existenceCheck)
          throws StandardException

Initializer for AlterTableNode for a) INPLACE COMPRESS b) Generic alter table actions

Overrides:

init in class QueryTreeNode

Parameters:

objectName - The name of the table being altered

arg2 - a) PURGE during INPLACE COMPRESS b) The alter table actions

arg3 - a) DEFRAGMENT during INPLACE COMPRESS b) ADD_TYPE or DROP_TYPE

arg4 - a) TRUNCATE END during INPLACE COMPRESS b) If drop is CASCADE or RESTRICTED

existenceCheck - ExistenceCheck for IF EXISTS

Throws:

StandardException - Thrown on error

copyFrom

public void copyFrom(QueryTreeNode node)
              throws StandardException

Fill this node with a deep copy of the given node.

Overrides:

copyFrom in class DDLStatementNode

Throws:

StandardException

toString

public String toString()

Convert this object to a String. See comments in QueryTreeNode.java for how this should be done for tree printing.

Overrides:

toString in class DDLStatementNode

Returns:

This object as a String

printSubNodes

public void printSubNodes(int depth)

Prints the sub-nodes of this object. See QueryTreeNode.java for how tree printing is supposed to work.

Overrides:

printSubNodes in class QueryTreeNode

Parameters:

depth - The depth to indent the sub-nodes

statementToString

public String statementToString()

Specified by:

statementToString in class StatementNode

isUpdateStatistics

public boolean isUpdateStatistics()

isUpdateStatisticsAll

public boolean isUpdateStatisticsAll()

getIndexNameForUpdateStatistics

public String getIndexNameForUpdateStatistics()

isCompressTable

public boolean isCompressTable()

isTruncateTable

public boolean isTruncateTable()

getChangeType

public int getChangeType()

getBehavior

public int getBehavior()

isCascade

public boolean isCascade()

getExistenceCheck

public ExistenceCheck getExistenceCheck()

getTableElementList

public TableElementList getTableElementList()