BaseRowDelta

java.lang.Object
- org.apache.iceberg.BaseRowDelta

All Implemented Interfaces:

PendingUpdate<Snapshot>, RowDelta, SnapshotUpdate<RowDelta>
```
public class BaseRowDelta
extends java.lang.Object
implements RowDelta
```

Constructor Summary

Constructors
Constructor and Description

BaseRowDelta(java.lang.String tableName, TableOperations ops)

Constructors
Constructor and Description
`BaseRowDelta(java.lang.String tableName, TableOperations ops)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`add(DataFile file)` Add a data file to the new snapshot.
`protected void`	`add(DeleteFile file)` Add a delete file to the new snapshot.
`protected void`	`add(ManifestFile manifest)` Add all files in a manifest to the new snapshot.
`RowDelta`	`addDeletes(DeleteFile deletes)` Add a `DeleteFile` to the table.
`protected java.util.List<DataFile>`	`addedFiles()`
`RowDelta`	`addRows(DataFile inserts)` Add a `DataFile` to the table.
`Snapshot`	`apply()` Apply the pending changes and return the uncommitted changes for validation.
`java.util.List<ManifestFile>`	`apply(TableMetadata base)` Apply the update's changes to the base table metadata and return the new manifest list.
`protected void`	`cleanAll()`
`protected void`	`cleanUncommitted(java.util.Set<ManifestFile> committed)` Clean up any uncommitted manifests that were created.
`void`	`commit()` Apply the pending changes and commit.
`protected TableMetadata`	`current()`
`protected void`	`delete(java.lang.CharSequence path)` Add a specific data path to be deleted in the new snapshot.
`protected void`	`delete(DataFile file)` Add a specific data file to be deleted in the new snapshot.
`protected void`	`delete(DeleteFile file)` Add a specific delete file to be deleted in the new snapshot.
`protected void`	`deleteByRowFilter(Expression expr)` Add a filter to match files to delete.
`protected void`	`deleteFile(java.lang.String path)`
`ThisT`	`deleteWith(java.util.function.Consumer<java.lang.String> deleteCallback)` Set a callback to delete files instead of the table's default.
`protected void`	`dropPartition(StructLike partition)` Add a partition tuple to drop from the table during the delete phase.
`protected void`	`failAnyDelete()`
`protected void`	`failMissingDeletePaths()`
`protected OutputFile`	`manifestListPath()`
`protected ManifestReader<DeleteFile>`	`newDeleteManifestReader(ManifestFile manifest)`
`protected ManifestWriter<DeleteFile>`	`newDeleteManifestWriter(PartitionSpec spec)`
`protected OutputFile`	`newManifestOutput()`
`protected ManifestReader<DataFile>`	`newManifestReader(ManifestFile manifest)`
`protected ManifestWriter<DataFile>`	`newManifestWriter(PartitionSpec spec)`
`protected java.lang.String`	`operation()` A string that describes the action that produced the new snapshot.
`protected TableMetadata`	`refresh()`
`protected Expression`	`rowFilter()`
`protected BaseRowDelta`	`self()`
`ThisT`	`set(java.lang.String property, java.lang.String value)` Set a summary property in the snapshot produced by this update.
`protected long`	`snapshotId()`
`ThisT`	`stageOnly()` Called to stage a snapshot in table metadata, but not update the current snapshot id.
`protected java.util.Map<java.lang.String,java.lang.String>`	`summary()`
`java.lang.Object`	`updateEvent()` Generates update event to notify about metadata changes
`protected PartitionSpec`	`writeSpec()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.iceberg.SnapshotUpdate
deleteWith, set, stageOnly

Methods inherited from interface org.apache.iceberg.PendingUpdate
apply, commit, updateEvent

- Constructor Detail
  - BaseRowDelta
```
public BaseRowDelta(java.lang.String tableName,
                    TableOperations ops)
```
- Method Detail
  - self
```
protected BaseRowDelta self()
```
  - operation
```
protected java.lang.String operation()
```
    A string that describes the action that produced the new snapshot.
    
    Returns:
    
    a string operation
  - addRows
```
public RowDelta addRows(DataFile inserts)
```
    Description copied from interface: RowDelta
    
    Add a DataFile to the table.
    
    Specified by:
    
    addRows in interface RowDelta
    
    Parameters:
    
    inserts - a data file of rows to insert
    
    Returns:
    
    this for method chaining
  - addDeletes
```
public RowDelta addDeletes(DeleteFile deletes)
```
    Description copied from interface: RowDelta
    
    Add a DeleteFile to the table.
    
    Specified by:
    
    addDeletes in interface RowDelta
    
    Parameters:
    
    deletes - a delete file of rows to delete
    
    Returns:
    
    this for method chaining
  - set
```
public ThisT set(java.lang.String property,
                 java.lang.String value)
```
    Description copied from interface: SnapshotUpdate
    
    Set a summary property in the snapshot produced by this update.
    
    Parameters:
    
    property - a String property name
    
    value - a String property value
    
    Returns:
    
    this for method chaining
  - writeSpec
```
protected PartitionSpec writeSpec()
```
  - rowFilter
```
protected Expression rowFilter()
```
  - addedFiles
```
protected java.util.List<DataFile> addedFiles()
```
  - failAnyDelete
```
protected void failAnyDelete()
```
  - failMissingDeletePaths
```
protected void failMissingDeletePaths()
```
  - deleteByRowFilter
```
protected void deleteByRowFilter(Expression expr)
```
    Add a filter to match files to delete. A file will be deleted if all of the rows it contains match this or any other filter passed to this method.
    
    Parameters:
    
    expr - an expression to match rows.
  - dropPartition
```
protected void dropPartition(StructLike partition)
```
    Add a partition tuple to drop from the table during the delete phase.
  - delete
```
protected void delete(DataFile file)
```
    Add a specific data file to be deleted in the new snapshot.
  - delete
```
protected void delete(DeleteFile file)
```
    Add a specific delete file to be deleted in the new snapshot.
  - delete
```
protected void delete(java.lang.CharSequence path)
```
    Add a specific data path to be deleted in the new snapshot.
  - add
```
protected void add(DataFile file)
```
    Add a data file to the new snapshot.
  - add
```
protected void add(DeleteFile file)
```
    Add a delete file to the new snapshot.
  - add
```
protected void add(ManifestFile manifest)
```
    Add all files in a manifest to the new snapshot.
  - summary
```
protected java.util.Map<java.lang.String,java.lang.String> summary()
```
  - apply
```
public java.util.List<ManifestFile> apply(TableMetadata base)
```
    Apply the update's changes to the base table metadata and return the new manifest list.
    
    Parameters:
    
    base - the base table metadata to apply changes to
    
    Returns:
    
    a manifest list for the new snapshot.
  - updateEvent
```
public java.lang.Object updateEvent()
```
    Description copied from interface: PendingUpdate
    
    Generates update event to notify about metadata changes
    
    Returns:
    
    the generated event
  - cleanUncommitted
```
protected void cleanUncommitted(java.util.Set<ManifestFile> committed)
```
    Clean up any uncommitted manifests that were created.
    Manifests may not be committed if apply is called more because a commit conflict has occurred. Implementations may keep around manifests because the same changes will be made by both apply calls. This method instructs the implementation to clean up those manifests and passes the paths of the manifests that were actually committed.
    
    Parameters:
    
    committed - a set of manifest paths that were actually committed
  - stageOnly
```
public ThisT stageOnly()
```
    Description copied from interface: SnapshotUpdate
    
    Called to stage a snapshot in table metadata, but not update the current snapshot id.
    
    Specified by:
    
    stageOnly in interface SnapshotUpdate<ThisT>
    
    Returns:
    
    this for method chaining
  - deleteWith
```
public ThisT deleteWith(java.util.function.Consumer<java.lang.String> deleteCallback)
```
    Description copied from interface: SnapshotUpdate
    
    Set a callback to delete files instead of the table's default.
    
    Specified by:
    
    deleteWith in interface SnapshotUpdate<ThisT>
    
    Parameters:
    
    deleteCallback - a String consumer used to delete locations.
    
    Returns:
    
    this for method chaining
  - apply
```
public Snapshot apply()
```
    Description copied from interface: PendingUpdate
    
    Apply the pending changes and return the uncommitted changes for validation.
    This does not result in a permanent update.
    
    Specified by:
    
    apply in interface PendingUpdate<Snapshot>
    
    Returns:
    
    the uncommitted changes that would be committed by calling PendingUpdate.commit()
  - current
```
protected TableMetadata current()
```
  - refresh
```
protected TableMetadata refresh()
```
  - commit
```
public void commit()
```
    Description copied from interface: PendingUpdate
    
    Apply the pending changes and commit.
    Changes are committed by calling the underlying table's commit method.
    Once the commit is successful, the updated table will be refreshed.
    
    Specified by:
    
    commit in interface PendingUpdate<Snapshot>
  - cleanAll
```
protected void cleanAll()
```
  - deleteFile
```
protected void deleteFile(java.lang.String path)
```
  - manifestListPath
```
protected OutputFile manifestListPath()
```
  - newManifestOutput
```
protected OutputFile newManifestOutput()
```
  - newManifestWriter
```
protected ManifestWriter<DataFile> newManifestWriter(PartitionSpec spec)
```
  - newDeleteManifestWriter
```
protected ManifestWriter<DeleteFile> newDeleteManifestWriter(PartitionSpec spec)
```
  - newManifestReader
```
protected ManifestReader<DataFile> newManifestReader(ManifestFile manifest)
```
  - newDeleteManifestReader
```
protected ManifestReader<DeleteFile> newDeleteManifestReader(ManifestFile manifest)
```
  - snapshotId
```
protected long snapshotId()
```

Class BaseRowDelta

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.iceberg.SnapshotUpdate

Methods inherited from interface org.apache.iceberg.PendingUpdate

Constructor Detail

BaseRowDelta

Method Detail

self

operation

addRows

addDeletes

set

writeSpec

rowFilter

addedFiles

failAnyDelete

failMissingDeletePaths

deleteByRowFilter

dropPartition

delete

delete

delete

add

add

add

summary

apply

updateEvent

cleanUncommitted

stageOnly

deleteWith

apply

current

refresh

commit

cleanAll

deleteFile

manifestListPath

newManifestOutput

newManifestWriter

newDeleteManifestWriter

newManifestReader

newDeleteManifestReader

snapshotId