Package org.apache.iceberg
Interface UpdateProperties
-
- All Superinterfaces:
PendingUpdate<java.util.Map<java.lang.String,java.lang.String>>
public interface UpdateProperties extends PendingUpdate<java.util.Map<java.lang.String,java.lang.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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description UpdateProperties
defaultFormat(FileFormat format)
Set the default file format for the table.UpdateProperties
remove(java.lang.String key)
Remove the given property key from the table.UpdateProperties
set(java.lang.String key, java.lang.String value)
Add a key/value property to the table.-
Methods inherited from interface org.apache.iceberg.PendingUpdate
apply, commit, updateEvent
-
-
-
-
Method Detail
-
set
UpdateProperties set(java.lang.String key, java.lang.String value)
Add a key/value property to the table.- Parameters:
key
- a String keyvalue
- a String value- Returns:
- this for method chaining
- Throws:
java.lang.NullPointerException
- If either the key or value is null
-
remove
UpdateProperties remove(java.lang.String key)
Remove the given property key from the table.- Parameters:
key
- a String key- Returns:
- this for method chaining
- Throws:
java.lang.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
-
-