public interface OverwriteFiles extends SnapshotUpdate<OverwriteFiles>
This API accumulates file additions and produces a new Snapshot of the table by
replacing all the deleted files with the set of additions. This operation is used to implement
idempotent writes that always replace a section of a table with new data or update/delete
operations that eagerly overwrite files.
Overwrites can be validated. The default validation mode is idempotent, meaning the overwrite is correct and should be committed out regardless of other concurrent changes to the table. For example, this can be used for replacing all the data for day D with query results. Alternatively, this API can be configured for overwriting certain files with their filtered versions while ensuring no new data that would need to be filtered has been added.
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.
| Modifier and Type | Method and Description |
|---|---|
OverwriteFiles |
addFile(DataFile file)
Add a
DataFile to the table. |
OverwriteFiles |
caseSensitive(boolean caseSensitive)
Enables or disables case sensitive expression binding for validations that accept expressions.
|
OverwriteFiles |
conflictDetectionFilter(Expression conflictDetectionFilter)
Sets a conflict detection filter used to validate concurrently added data and delete files.
|
OverwriteFiles |
deleteFile(DataFile file)
Delete a
DataFile from the table. |
OverwriteFiles |
overwriteByRowFilter(Expression expr)
Delete files that match an
Expression on data rows from the table. |
OverwriteFiles |
validateAddedFilesMatchOverwriteFilter()
Signal that each file added to the table must match the overwrite expression.
|
OverwriteFiles |
validateFromSnapshot(long snapshotId)
Set the snapshot ID used in any reads for this operation.
|
OverwriteFiles |
validateNoConflictingData()
Enables validation that data added concurrently does not conflict with this commit's operation.
|
OverwriteFiles |
validateNoConflictingDeletes()
Enables validation that deletes that happened concurrently do not conflict with this commit's
operation.
|
deleteWith, scanManifestsWith, set, stageOnly, toBranchapply, commit, updateEventOverwriteFiles overwriteByRowFilter(Expression expr)
Expression on data rows from the table.
A file is selected to be deleted by the expression if it could contain any rows that match
the expression (candidate files are selected using an inclusive projection). These candidate files are deleted
if all of the rows in the file must match the expression (the partition data matches the
expression's Projections.strict(PartitionSpec) strict projection}). This guarantees
that files are deleted if and only if all rows in the file must match the expression.
Files that may contain some rows that match the expression and some rows that do not will
result in a ValidationException.
expr - an expression on rows in the tableValidationException - If a file can contain both rows that match and rows that do notOverwriteFiles addFile(DataFile file)
DataFile to the table.file - a data fileOverwriteFiles deleteFile(DataFile file)
DataFile from the table.file - a data fileOverwriteFiles validateAddedFilesMatchOverwriteFilter()
If this method is called, each added file is validated on commit to ensure that it matches the overwrite row filter. This is used to ensure that writes are idempotent: that files cannot be added during a commit that would not be removed if the operation were run a second time.
OverwriteFiles validateFromSnapshot(long snapshotId)
Validations will check changes after this snapshot ID. If the from snapshot is not set, all ancestor snapshots through the table's initial snapshot are validated.
snapshotId - a snapshot IDOverwriteFiles caseSensitive(boolean caseSensitive)
caseSensitive - whether expression binding should be case sensitiveOverwriteFiles conflictDetectionFilter(Expression conflictDetectionFilter)
conflictDetectionFilter - an expression on rows in the tableOverwriteFiles validateNoConflictingData()
This method should be called while committing non-idempotent overwrite operations. If a concurrent operation commits a new file after the data was read and that file might contain rows matching the specified conflict detection filter, the overwrite operation will detect this and fail.
Calling this method with a correct conflict detection filter is required to maintain isolation for non-idempotent overwrite operations.
Validation uses the conflict detection filter passed to conflictDetectionFilter(Expression) and applies to operations that happened after the
snapshot passed to validateFromSnapshot(long). If the conflict detection filter is not
set, any new data added concurrently will fail this overwrite operation.
OverwriteFiles validateNoConflictingDeletes()
Validating concurrent deletes is required during non-idempotent overwrite operations. If a concurrent operation deletes data in one of the files being overwritten, the overwrite operation must be aborted as it may undelete rows that were removed concurrently.
Calling this method with a correct conflict detection filter is required to maintain isolation for non-idempotent overwrite operations.
Validation uses the conflict detection filter passed to conflictDetectionFilter(Expression) and applies to operations that happened after the
snapshot passed to validateFromSnapshot(long). If the conflict detection filter is not
set, this operation will use the row filter provided in overwriteByRowFilter(Expression) to check for new delete files and will ensure there are no
conflicting deletes for data files removed via deleteFile(DataFile).