org.apache.hadoop.hive.ql.plan

Class AlterTableDesc

java.lang.Object

org.apache.hadoop.hive.ql.plan.DDLDesc

org.apache.hadoop.hive.ql.plan.AlterTableDesc

All Implemented Interfaces:

Serializable, DDLDesc.DDLDescWithWriteId

public class AlterTableDesc
extends DDLDesc
implements Serializable, DDLDesc.DDLDescWithWriteId

AlterTableDesc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlterTableDesc.AlterTableTypes alterTableTypes.
static class	AlterTableDesc.ProtectModeType

Nested classes/interfaces inherited from class org.apache.hadoop.hive.ql.plan.DDLDesc

DDLDesc.DDLDescWithWriteId

Field Summary

Fields

Modifier and Type	Field and Description
static Set<AlterTableDesc.AlterTableTypes>	alterTableTypesWithPartialSpec

Constructor Summary

Constructors

Constructor and Description
AlterTableDesc()
AlterTableDesc(AlterTableDesc.AlterTableTypes alterType)
AlterTableDesc(AlterTableDesc.AlterTableTypes alterType, HashMap<String,String> partSpec, boolean expectView)
AlterTableDesc(AlterTableDesc.AlterTableTypes alterType, ReplicationSpec replicationSpec)
AlterTableDesc(String tableName, boolean sortingOff, HashMap<String,String> partSpec)
AlterTableDesc(String tableName, boolean turnOffSkewed, List<String> skewedColNames, List<List<String>> skewedColValues)
AlterTableDesc(String tableName, HashMap<String,String> partSpec, int numBuckets)
AlterTableDesc(String name, HashMap<String,String> partSpec, List<org.apache.hadoop.hive.metastore.api.FieldSchema> newCols, AlterTableDesc.AlterTableTypes alterType, boolean isCascade)
AlterTableDesc(String tblName, HashMap<String,String> partSpec, String oldColName, String newColName, String newType, String newComment, boolean first, String afterCol, boolean isCascade)
AlterTableDesc(String tblName, HashMap<String,String> partSpec, String oldColName, String newColName, String newType, String newComment, boolean first, String afterCol, boolean isCascade, List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols, List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols, List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uniqueConstraintCols, List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> notNullConstraintCols, List<org.apache.hadoop.hive.metastore.api.SQLDefaultConstraint> defaultConstraints, List<org.apache.hadoop.hive.metastore.api.SQLCheckConstraint> checkConstraints)
AlterTableDesc(String tableName, int numBuckets, List<String> bucketCols, List<org.apache.hadoop.hive.metastore.api.Order> sortCols, HashMap<String,String> partSpec)
AlterTableDesc(String tableName, List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols, List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols, List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uniqueConstraintCols, List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> notNullConstraintCols, List<org.apache.hadoop.hive.metastore.api.SQLDefaultConstraint> defaultConstraints, List<org.apache.hadoop.hive.metastore.api.SQLCheckConstraint> checkConstraints, ReplicationSpec replicationSpec)
AlterTableDesc(String tableName, List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols, List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols, List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uniqueConstraintCols, ReplicationSpec replicationSpec)
AlterTableDesc(String tableName, Map<List<String>,String> locations, HashMap<String,String> partSpec)
AlterTableDesc(String tableName, PrincipalDesc ownerPrincipal)
AlterTableDesc(String oldName, String newName, boolean expectView, ReplicationSpec replicationSpec)
AlterTableDesc(String tableName, String newLocation, HashMap<String,String> partSpec)
AlterTableDesc(String tableName, String dropConstraintName, ReplicationSpec replicationSpec)
AlterTableDesc(String name, String inputFormat, String outputFormat, String serdeName, String storageHandler, HashMap<String,String> partSpec)

Method Summary

Modifier and Type	Method and Description
static boolean	doesAlterTableTypeSupportPartialPartitionSpec(AlterTableDesc.AlterTableTypes type)
String	getAfterCol()
String	getAlterTableTypeString()
ArrayList<String>	getBucketColumns()
List<org.apache.hadoop.hive.metastore.api.SQLCheckConstraint>	getCheckConstraintCols()
String	getConstraintName()
List<org.apache.hadoop.hive.metastore.api.SQLDefaultConstraint>	getDefaultConstraintCols()
org.apache.hadoop.hive.metastore.api.EnvironmentContext	getEnvironmentContext()
boolean	getExpectView()
boolean	getFirst()
List<org.apache.hadoop.hive.metastore.api.SQLForeignKey>	getForeignKeyCols()
String	getFullTableName()
String	getInputFormat()
boolean	getIsCascade()
boolean	getIsDropIfExists()
String	getNewColComment()
String	getNewColName()
ArrayList<org.apache.hadoop.hive.metastore.api.FieldSchema>	getNewCols()
List<String>	getNewColsString()
String	getNewColType()
String	getNewLocation()
String	getNewName()
List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint>	getNotNullConstraintCols()
int	getNumberBuckets()
String	getOldColName()
String	getOldName()
AlterTableDesc.AlterTableTypes	getOp()
String	getOutputFormat()
PrincipalDesc	getOwnerPrincipal()
HashMap<String,String>	getPartSpec()
List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey>	getPrimaryKeyCols()
HashMap<String,String>	getProps()
AlterTableDesc.ProtectModeType	getProtectModeType()
ReplicationSpec	getReplicationSpec()
String	getSerdeName()
List<String>	getSkewedColNames()
List<List<String>>	getSkewedColValues()
Map<List<String>,String>	getSkewedLocations()
ArrayList<org.apache.hadoop.hive.metastore.api.Order>	getSortColumns()
String	getStorageHandler()
List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint>	getUniqueConstraintCols()
Long	getWriteId()
boolean	isProtectModeEnable()
boolean	isStoredAsSubDirectories()
boolean	isTurnOffSkewed()
boolean	isTurnOffSorting()
boolean	mayNeedWriteId()
void	setAfterCol(String afterCol)
void	setBucketColumns(ArrayList<String> bucketColumns)
void	setDropConstraintName(String constraintName)
void	setDropIfExists(boolean isDropIfExists)
void	setEnvironmentContext(org.apache.hadoop.hive.metastore.api.EnvironmentContext environmentContext)
void	setExpectView(boolean expectView)
void	setFirst(boolean first)
void	setForeignKeyCols(List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols)
void	setInputFormat(String inputFormat)
void	setIsCascade(boolean isCascade)
void	setNewColComment(String newComment)
void	setNewColName(String newColName)
void	setNewCols(ArrayList<org.apache.hadoop.hive.metastore.api.FieldSchema> newCols)
void	setNewColType(String newType)
void	setNewLocation(String newLocation)
void	setNewName(String newName)
void	setNumberBuckets(int numberBuckets)
void	setOldColName(String oldColName)
void	setOldName(String oldName)
void	setOp(AlterTableDesc.AlterTableTypes op)
void	setOutputFormat(String outputFormat)
void	setOwnerPrincipal(PrincipalDesc ownerPrincipal)
void	setPartSpec(HashMap<String,String> partSpec)
void	setPrimaryKeyCols(List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols)
void	setProps(HashMap<String,String> props)
void	setProtectModeEnable(boolean protectModeEnable)
void	setProtectModeType(AlterTableDesc.ProtectModeType protectModeType)
void	setSerdeName(String serdeName)
void	setSkewedColNames(List<String> skewedColNames)
void	setSkewedColValues(List<List<String>> skewedColValues)
void	setSkewedLocations(Map<List<String>,String> skewedLocations)
void	setSortColumns(ArrayList<org.apache.hadoop.hive.metastore.api.Order> sortColumns)
void	setStorageHandler(String storageHandler)
void	setStoredAsSubDirectories(boolean isStoredAsSubDirectories)
void	setTable(Table table)
void	setTurnOffSkewed(boolean turnOffSkewed)
void	setWriteId(long writeId)
void	validate() Validate alter table description.

Methods inherited from class java.lang.Object

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

Field Detail

alterTableTypesWithPartialSpec

public static final Set<AlterTableDesc.AlterTableTypes> alterTableTypesWithPartialSpec

Constructor Detail

AlterTableDesc

public AlterTableDesc()

AlterTableDesc

public AlterTableDesc(String tblName,
                      HashMap<String,String> partSpec,
                      String oldColName,
                      String newColName,
                      String newType,
                      String newComment,
                      boolean first,
                      String afterCol,
                      boolean isCascade)
               throws SemanticException

Parameters:

tblName - table name

oldColName - old column name

newColName - new column name

newComment -

newType -

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tblName,
                      HashMap<String,String> partSpec,
                      String oldColName,
                      String newColName,
                      String newType,
                      String newComment,
                      boolean first,
                      String afterCol,
                      boolean isCascade,
                      List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uniqueConstraintCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> notNullConstraintCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLDefaultConstraint> defaultConstraints,
                      List<org.apache.hadoop.hive.metastore.api.SQLCheckConstraint> checkConstraints)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String oldName,
                      String newName,
                      boolean expectView,
                      ReplicationSpec replicationSpec)
               throws SemanticException

Parameters:

oldName - old name of the table

newName - new name of the table

expectView - Flag to denote if current table can be a view

replicationSpec - Replication specification with current event ID

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String name,
                      HashMap<String,String> partSpec,
                      List<org.apache.hadoop.hive.metastore.api.FieldSchema> newCols,
                      AlterTableDesc.AlterTableTypes alterType,
                      boolean isCascade)
               throws SemanticException

Parameters:

name - name of the table

newCols - new columns to be added

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(AlterTableDesc.AlterTableTypes alterType,
                      ReplicationSpec replicationSpec)

Parameters:

alterType - type of alter op

replicationSpec - Replication specification with current event ID

AlterTableDesc

public AlterTableDesc(AlterTableDesc.AlterTableTypes alterType)

Parameters:

alterType - type of alter op

AlterTableDesc

public AlterTableDesc(AlterTableDesc.AlterTableTypes alterType,
                      HashMap<String,String> partSpec,
                      boolean expectView)

Parameters:

alterType - type of alter op

expectView - Flag to denote if current table can be a view

partSpec - Partition specifier with map of key and values.

AlterTableDesc

public AlterTableDesc(String name,
                      String inputFormat,
                      String outputFormat,
                      String serdeName,
                      String storageHandler,
                      HashMap<String,String> partSpec)
               throws SemanticException

Parameters:

name - name of the table

inputFormat - new table input format

outputFormat - new table output format

partSpec -

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      int numBuckets,
                      List<String> bucketCols,
                      List<org.apache.hadoop.hive.metastore.api.Order> sortCols,
                      HashMap<String,String> partSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      boolean sortingOff,
                      HashMap<String,String> partSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      String newLocation,
                      HashMap<String,String> partSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      Map<List<String>,String> locations,
                      HashMap<String,String> partSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      boolean turnOffSkewed,
                      List<String> skewedColNames,
                      List<List<String>> skewedColValues)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      HashMap<String,String> partSpec,
                      int numBuckets)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      String dropConstraintName,
                      ReplicationSpec replicationSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uniqueConstraintCols,
                      ReplicationSpec replicationSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> uniqueConstraintCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> notNullConstraintCols,
                      List<org.apache.hadoop.hive.metastore.api.SQLDefaultConstraint> defaultConstraints,
                      List<org.apache.hadoop.hive.metastore.api.SQLCheckConstraint> checkConstraints,
                      ReplicationSpec replicationSpec)
               throws SemanticException

Throws:

SemanticException

AlterTableDesc

public AlterTableDesc(String tableName,
                      PrincipalDesc ownerPrincipal)

Method Detail

setOwnerPrincipal

public void setOwnerPrincipal(PrincipalDesc ownerPrincipal)

Parameters:

ownerPrincipal - the owner principal of the table

getOwnerPrincipal

public PrincipalDesc getOwnerPrincipal()

getNewColsString

public List<String> getNewColsString()

getAlterTableTypeString

public String getAlterTableTypeString()

getOldName

public String getOldName()

Returns:

the old name of the table

setOldName

public void setOldName(String oldName)
                throws SemanticException

Parameters:

oldName - the oldName to set

Throws:

SemanticException

getNewName

public String getNewName()

Returns:

the newName

setNewName

public void setNewName(String newName)

Parameters:

newName - the newName to set

getOp

public AlterTableDesc.AlterTableTypes getOp()

Returns:

the op

setOp

public void setOp(AlterTableDesc.AlterTableTypes op)

Parameters:

op - the op to set

getNewCols

public ArrayList<org.apache.hadoop.hive.metastore.api.FieldSchema> getNewCols()

Returns:

the newCols

setNewCols

public void setNewCols(ArrayList<org.apache.hadoop.hive.metastore.api.FieldSchema> newCols)

Parameters:

newCols - the newCols to set

getSerdeName

public String getSerdeName()

Returns:

the serdeName

setSerdeName

public void setSerdeName(String serdeName)

Parameters:

serdeName - the serdeName to set

getProps

public HashMap<String,String> getProps()

Returns:

the props

setProps

public void setProps(HashMap<String,String> props)

Parameters:

props - the props to set

getInputFormat

public String getInputFormat()

Returns:

the input format

setInputFormat

public void setInputFormat(String inputFormat)

Parameters:

inputFormat - the input format to set

getOutputFormat

public String getOutputFormat()

Returns:

the output format

setOutputFormat

public void setOutputFormat(String outputFormat)

Parameters:

outputFormat - the output format to set

getStorageHandler

public String getStorageHandler()

Returns:

the storage handler

setPrimaryKeyCols

public void setPrimaryKeyCols(List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> primaryKeyCols)

Parameters:

primaryKeyCols - the primary key cols to set

getPrimaryKeyCols

public List<org.apache.hadoop.hive.metastore.api.SQLPrimaryKey> getPrimaryKeyCols()

Returns:

the primary key cols

setForeignKeyCols

public void setForeignKeyCols(List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> foreignKeyCols)

Parameters:

foreignKeyCols - the foreign key cols to set

getForeignKeyCols

public List<org.apache.hadoop.hive.metastore.api.SQLForeignKey> getForeignKeyCols()

Returns:

the foreign key cols

getUniqueConstraintCols

public List<org.apache.hadoop.hive.metastore.api.SQLUniqueConstraint> getUniqueConstraintCols()

Returns:

the unique constraint cols

getNotNullConstraintCols

public List<org.apache.hadoop.hive.metastore.api.SQLNotNullConstraint> getNotNullConstraintCols()

Returns:

the not null constraint cols

getDefaultConstraintCols

public List<org.apache.hadoop.hive.metastore.api.SQLDefaultConstraint> getDefaultConstraintCols()

Returns:

the default constraint cols

getCheckConstraintCols

public List<org.apache.hadoop.hive.metastore.api.SQLCheckConstraint> getCheckConstraintCols()

Returns:

the check constraint cols

getConstraintName

public String getConstraintName()

Returns:

the drop constraint name of the table

setDropConstraintName

public void setDropConstraintName(String constraintName)

Parameters:

constraintName - the dropConstraintName to set

setStorageHandler

public void setStorageHandler(String storageHandler)

Parameters:

storageHandler - the storage handler to set

getNumberBuckets

public int getNumberBuckets()

Returns:

the number of buckets

setNumberBuckets

public void setNumberBuckets(int numberBuckets)

Parameters:

numberBuckets - the number of buckets to set

getBucketColumns

public ArrayList<String> getBucketColumns()

Returns:

the bucket columns

setBucketColumns

public void setBucketColumns(ArrayList<String> bucketColumns)

Parameters:

bucketColumns - the bucket columns to set

getSortColumns

public ArrayList<org.apache.hadoop.hive.metastore.api.Order> getSortColumns()

Returns:

the sort columns

setSortColumns

public void setSortColumns(ArrayList<org.apache.hadoop.hive.metastore.api.Order> sortColumns)

Parameters:

sortColumns - the sort columns to set

getOldColName

public String getOldColName()

Returns:

old column name

setOldColName

public void setOldColName(String oldColName)

Parameters:

oldColName - the old column name

getNewColName

public String getNewColName()

Returns:

new column name

setNewColName

public void setNewColName(String newColName)

Parameters:

newColName - the new column name

getNewColType

public String getNewColType()

Returns:

new column type

setNewColType

public void setNewColType(String newType)

Parameters:

newType - new column's type

getNewColComment

public String getNewColComment()

Returns:

new column's comment

setNewColComment

public void setNewColComment(String newComment)

Parameters:

newComment - new column's comment

getFirst

public boolean getFirst()

Returns:

if the column should be changed to position 0

setFirst

public void setFirst(boolean first)

Parameters:

first - set the column to position 0

getAfterCol

public String getAfterCol()

Returns:

the column's after position

setAfterCol

public void setAfterCol(String afterCol)

Parameters:

afterCol - set the column's after position

getExpectView

public boolean getExpectView()

Returns:

whether to expect a view being altered

setExpectView

public void setExpectView(boolean expectView)

Parameters:

expectView - set whether to expect a view being altered

getPartSpec

public HashMap<String,String> getPartSpec()

Returns:

part specification

setPartSpec

public void setPartSpec(HashMap<String,String> partSpec)

Parameters:

partSpec -

getNewLocation

public String getNewLocation()

Returns:

new location

setNewLocation

public void setNewLocation(String newLocation)

Parameters:

newLocation - new location

isProtectModeEnable

public boolean isProtectModeEnable()

setProtectModeEnable

public void setProtectModeEnable(boolean protectModeEnable)

getProtectModeType

public AlterTableDesc.ProtectModeType getProtectModeType()

setProtectModeType

public void setProtectModeType(AlterTableDesc.ProtectModeType protectModeType)

getSkewedLocations

public Map<List<String>,String> getSkewedLocations()

Returns:

the skewedLocations

setSkewedLocations

public void setSkewedLocations(Map<List<String>,String> skewedLocations)

Parameters:

skewedLocations - the skewedLocations to set

isTurnOffSorting

public boolean isTurnOffSorting()

Returns:

isTurnOffSorting

isTurnOffSkewed

public boolean isTurnOffSkewed()

Returns:

the turnOffSkewed

setTurnOffSkewed

public void setTurnOffSkewed(boolean turnOffSkewed)

Parameters:

turnOffSkewed - the turnOffSkewed to set

getSkewedColNames

public List<String> getSkewedColNames()

Returns:

the skewedColNames

setSkewedColNames

public void setSkewedColNames(List<String> skewedColNames)

Parameters:

skewedColNames - the skewedColNames to set

getSkewedColValues

public List<List<String>> getSkewedColValues()

Returns:

the skewedColValues

setSkewedColValues

public void setSkewedColValues(List<List<String>> skewedColValues)

Parameters:

skewedColValues - the skewedColValues to set

validate

public void validate()
              throws SemanticException

Validate alter table description.

Throws:

SemanticException

setTable

public void setTable(Table table)

Parameters:

table - the table to set

isStoredAsSubDirectories

public boolean isStoredAsSubDirectories()

Returns:

the isStoredAsSubDirectories

setStoredAsSubDirectories

public void setStoredAsSubDirectories(boolean isStoredAsSubDirectories)

Parameters:

isStoredAsSubDirectories - the isStoredAsSubDirectories to set

setDropIfExists

public void setDropIfExists(boolean isDropIfExists)

Parameters:

isDropIfExists - the isDropIfExists to set

getIsDropIfExists

public boolean getIsDropIfExists()

Returns:

isDropIfExists

getIsCascade

public boolean getIsCascade()

Returns:

isCascade

setIsCascade

public void setIsCascade(boolean isCascade)

Parameters:

cascade - the isCascade to set

doesAlterTableTypeSupportPartialPartitionSpec

public static boolean doesAlterTableTypeSupportPartialPartitionSpec(AlterTableDesc.AlterTableTypes type)

getEnvironmentContext

public org.apache.hadoop.hive.metastore.api.EnvironmentContext getEnvironmentContext()

setEnvironmentContext

public void setEnvironmentContext(org.apache.hadoop.hive.metastore.api.EnvironmentContext environmentContext)

getReplicationSpec

public ReplicationSpec getReplicationSpec()

Returns:

what kind of replication scope this alter is running under. This can result in a "ALTER IF NEWER THAN" kind of semantic

setWriteId

public void setWriteId(long writeId)

Specified by:

setWriteId in interface DDLDesc.DDLDescWithWriteId

getFullTableName

public String getFullTableName()

Specified by:

getFullTableName in interface DDLDesc.DDLDescWithWriteId

mayNeedWriteId

public boolean mayNeedWriteId()

Specified by:

mayNeedWriteId in interface DDLDesc.DDLDescWithWriteId

getWriteId

public Long getWriteId()