Package org.apache.iceberg

Interface UpdateProperties

All Superinterfaces:
PendingUpdate<Map<String,String>>
public interface UpdateProperties extends PendingUpdate<Map<String,String>>
API for updating table properties.

Apply returns the updated table properties as a map for validation.

When committing, these changes will be applied to the current table metadata. Commit conflicts will be resolved by applying the pending changes to the new table metadata.

  • Method Details

    • set

      UpdateProperties set(String key, String value)
      Add a key/value property to the table.
      Parameters:
      key - a String key
      value - a String value
      Returns:
      this for method chaining
      Throws:
      NullPointerException - If either the key or value is null

    • remove

      UpdateProperties remove(String key)
      Remove the given property key from the table.
      Parameters:
      key - a String key
      Returns:
      this for method chaining
      Throws:
      NullPointerException - If the key is null

    • defaultFormat

      UpdateProperties defaultFormat(FileFormat format)
      Set the default file format for the table.
      Parameters:
      format - a file format
      Returns:
      this