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

Class TableChange.UpdateColumnComment

Object

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

All Implemented Interfaces:

TableChange, TableChange.ColumnChange

Enclosing interface:

TableChange

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

A TableChange to update the comment 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()
String	newComment()	Returns the new comment of the column, or null to remove the existing comment (making the comment genuinely absent, as opposed to setting it to an empty string).
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

fieldNames

public String[] fieldNames()

Specified by:

fieldNames in interface TableChange.ColumnChange

newComment

@Nullable
public String newComment()

Returns the new comment of the column, or null to remove the existing comment (making the comment genuinely absent, as opposed to setting it to an empty string).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object