public interface RewriteFiles extends SnapshotUpdate<RewriteFiles>
This API accumulates file additions and deletions, produces a new Snapshot
of the
changes, and commits that snapshot as the current.
When committing, these changes will be applied to the latest table snapshot. Commit conflicts
will be resolved by applying the changes to the new latest snapshot and reattempting the commit.
If any of the deleted files are no longer in the latest snapshot when reattempting, the commit
will throw a ValidationException
.
Note that the new state of the table after each rewrite must be logically equivalent to the original table state.
Modifier and Type | Method and Description |
---|---|
default RewriteFiles |
addFile(DataFile dataFile)
Add a new data file.
|
default RewriteFiles |
addFile(DeleteFile deleteFile)
Add a new delete file.
|
default RewriteFiles |
addFile(DeleteFile deleteFile,
long dataSequenceNumber)
Add a new delete file with the given data sequence number.
|
default RewriteFiles |
dataSequenceNumber(long sequenceNumber)
Configure the data sequence number for this rewrite operation.
|
default RewriteFiles |
deleteFile(DataFile dataFile)
Remove a data file from the current table state.
|
default RewriteFiles |
deleteFile(DeleteFile deleteFile)
Remove a delete file from the table state.
|
default RewriteFiles |
rewriteFiles(java.util.Set<DataFile> filesToDelete,
java.util.Set<DataFile> filesToAdd)
Deprecated.
since 1.3.0, will be removed in 2.0.0
|
RewriteFiles |
rewriteFiles(java.util.Set<DataFile> filesToDelete,
java.util.Set<DataFile> filesToAdd,
long sequenceNumber)
Deprecated.
since 1.3.0, will be removed in 2.0.0
|
RewriteFiles |
rewriteFiles(java.util.Set<DataFile> dataFilesToReplace,
java.util.Set<DeleteFile> deleteFilesToReplace,
java.util.Set<DataFile> dataFilesToAdd,
java.util.Set<DeleteFile> deleteFilesToAdd)
Deprecated.
since 1.3.0, will be removed in 2.0.0
|
RewriteFiles |
validateFromSnapshot(long snapshotId)
Set the snapshot ID used in any reads for this operation.
|
deleteWith, scanManifestsWith, set, stageOnly, toBranch
apply, commit, updateEvent
default RewriteFiles deleteFile(DataFile dataFile)
This rewrite operation may change the size or layout of the data files. When applicable, it is also recommended to discard already deleted records while rewriting data files. However, the set of live data records must never change.
dataFile
- a rewritten data filedefault RewriteFiles deleteFile(DeleteFile deleteFile)
This rewrite operation may change the size or layout of the delete files. When applicable, it is also recommended to discard delete records for files that are no longer part of the table state. However, the set of applicable delete records must never change.
deleteFile
- a rewritten delete filedefault RewriteFiles addFile(DataFile dataFile)
This rewrite operation may change the size or layout of the data files. When applicable, it is also recommended to discard already deleted records while rewriting data files. However, the set of live data records must never change.
dataFile
- a new data filedefault RewriteFiles addFile(DeleteFile deleteFile)
This rewrite operation may change the size or layout of the delete files. When applicable, it is also recommended to discard delete records for files that are no longer part of the table state. However, the set of applicable delete records must never change.
deleteFile
- a new delete filedefault RewriteFiles addFile(DeleteFile deleteFile, long dataSequenceNumber)
This rewrite operation may change the size or layout of the delete files. When applicable, it is also recommended to discard delete records for files that are no longer part of the table state. However, the set of applicable delete records must never change.
To ensure equivalence in the set of applicable delete records, the sequence number of the delete file must be the max sequence number of the delete files that it is replacing. Rewriting equality deletes that belong to different sequence numbers is not allowed.
deleteFile
- a new delete filedataSequenceNumber
- data sequence number to append on the filedefault RewriteFiles dataSequenceNumber(long sequenceNumber)
sequenceNumber
- a data sequence number@Deprecated default RewriteFiles rewriteFiles(java.util.Set<DataFile> filesToDelete, java.util.Set<DataFile> filesToAdd)
filesToDelete
- files that will be replaced (deleted), cannot be null or empty.filesToAdd
- files that will be added, cannot be null or empty.@Deprecated RewriteFiles rewriteFiles(java.util.Set<DataFile> filesToDelete, java.util.Set<DataFile> filesToAdd, long sequenceNumber)
filesToDelete
- files that will be replaced (deleted), cannot be null or empty.filesToAdd
- files that will be added, cannot be null or empty.sequenceNumber
- sequence number to use for all data files added@Deprecated RewriteFiles rewriteFiles(java.util.Set<DataFile> dataFilesToReplace, java.util.Set<DeleteFile> deleteFilesToReplace, java.util.Set<DataFile> dataFilesToAdd, java.util.Set<DeleteFile> deleteFilesToAdd)
dataFilesToReplace
- data files that will be replaced (deleted).deleteFilesToReplace
- delete files that will be replaced (deleted).dataFilesToAdd
- data files that will be added.deleteFilesToAdd
- delete files that will be added.RewriteFiles validateFromSnapshot(long snapshotId)
Validations will check changes after this snapshot ID. If this is not called, all ancestor snapshots through the table's initial snapshot are validated.
snapshotId
- a snapshot ID