Package org.apache.spark.sql.connector.catalog

Class TableChange.UpdateColumnDefaultValue

Object

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

All Implemented Interfaces:

TableChange, TableChange.ColumnChange

Enclosing interface:

TableChange

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

A TableChange to update the default value of a field.

The field names are used to find the field to update.

If the field does not exist, 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.AddConstraint, TableChange.After, TableChange.ClusterBy, TableChange.ColumnChange, TableChange.ColumnPosition, TableChange.DeleteColumn, TableChange.DropConstraint, TableChange.First, TableChange.RemoveProperty, TableChange.RenameColumn, TableChange.SetProperty, TableChange.UpdateColumnComment, TableChange.UpdateColumnDefaultValue, TableChange.UpdateColumnNullability, TableChange.UpdateColumnPosition, TableChange.UpdateColumnType

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String[]	fieldNames()
int	hashCode()
DefaultValue	newCurrentDefault()	Returns the column default value as DefaultValue.
String	newDefaultValue()	Deprecated. Use newCurrentDefault() instead.

Methods inherited from class java.lang.Object

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

Method Details

fieldNames

public String[] fieldNames()

Specified by:

fieldNames in interface TableChange.ColumnChange

newDefaultValue

@Deprecated(since="4.1.0")
public String newDefaultValue()

Deprecated.

Use newCurrentDefault() instead.

Returns the column default value SQL string (Spark SQL dialect). The default value literal is not provided as updating column default values does not need to back-fill existing data. Empty string means dropping the column default value.

newCurrentDefault

public DefaultValue newCurrentDefault()

Returns the column default value as DefaultValue. The default value literal is not provided as updating column default values does not need to back-fill existing data. Null means dropping the column default value.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object