Package org.apache.iceberg.viewdepoc

Interface UpdateComment

All Superinterfaces:
org.apache.iceberg.PendingUpdate<org.apache.iceberg.Schema>
All Known Implementing Classes:
CommentUpdate
public interface UpdateComment extends org.apache.iceberg.PendingUpdate<org.apache.iceberg.Schema>
API for Adding View Column comments

When committing, these changes will be applied to the current view metadata. Commit conflicts will not be resolved and will result in a CommitFailedException.

  • Method Summary

    Modifier and Type
    Method
    Description
    UpdateComment
    updateColumnDoc(String name, String newDoc)
    Update the comment of a column in the schema.

    Methods inherited from interface org.apache.iceberg.PendingUpdate

    apply, commit, updateEvent

  • Method Details

    • updateColumnDoc

      UpdateComment updateColumnDoc(String name, String newDoc)
      Update the comment of a column in the schema.

      The name is used to find the column to update using Schema.findField(String).

      Parameters:
      name - name of the column whose comment is being updated
      newDoc - replacement comment string for the column
      Returns:
      this for method chaining
      Throws:
      IllegalArgumentException - If name doesn't identify a column in the schema.