org.apache.spark.sql.connector.catalog

Class TableChange.AddColumn

Object

org.apache.spark.sql.connector.catalog.TableChange.AddColumn

All Implemented Interfaces:

TableChange, TableChange.ColumnChange

Enclosing interface:

TableChange

public static final class TableChange.AddColumn
extends Object
implements TableChange.ColumnChange

A TableChange to add a field. The implementation may need to back-fill all the existing data to add this new column, or remember the column default value specified here and let the reader fill the column value when reading existing data that do not have this new column.

If the field already exists, the change must result in an IllegalArgumentException. If the new field is nested and its parent does not exist or is not a struct, the change must result in an IllegalArgumentException.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.spark.sql.connector.catalog.TableChange

TableChange.AddColumn, TableChange.After, TableChange.ColumnChange, TableChange.ColumnPosition, TableChange.DeleteColumn, TableChange.First, TableChange.RemoveProperty, TableChange.RenameColumn, TableChange.SetProperty, TableChange.UpdateColumnComment, TableChange.UpdateColumnDefaultValue, TableChange.UpdateColumnNullability, TableChange.UpdateColumnPosition, TableChange.UpdateColumnType

Method Summary

Modifier and Type	Method and Description
String	comment()
DataType	dataType()
ColumnDefaultValue	defaultValue()
boolean	equals(Object o)
String[]	fieldNames()
int	hashCode()
boolean	isNullable()
TableChange.ColumnPosition	position()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.sql.connector.catalog.TableChange

addColumn, addColumn, addColumn, addColumn, deleteColumn, removeProperty, renameColumn, setProperty, updateColumnComment, updateColumnDefaultValue, updateColumnNullability, updateColumnPosition, updateColumnType

Method Detail

fieldNames

public String[] fieldNames()

Specified by:

fieldNames in interface TableChange.ColumnChange

dataType

public DataType dataType()

isNullable

public boolean isNullable()

comment

@Nullable
public String comment()

position

@Nullable
public TableChange.ColumnPosition position()

defaultValue

@Nullable
public ColumnDefaultValue defaultValue()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object