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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      UpdateComment updateColumnDoc​(java.lang.String name, java.lang.String newDoc)
      Update the comment of a column in the schema.

      • Methods inherited from interface org.apache.iceberg.PendingUpdate

        apply, commit, updateEvent

    • Method Detail

      • updateColumnDoc

        UpdateComment updateColumnDoc​(java.lang.String name,
                              java.lang.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:
        java.lang.IllegalArgumentException - If name doesn't identify a column in the schema.