org.apache.iceberg

Class ManifestWriter<F extends org.apache.iceberg.ContentFile<F>>

java.lang.Object

org.apache.iceberg.ManifestWriter<F>

Type Parameters:

F - Java class of files written to the manifest, either DataFile or DeleteFile.

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.iceberg.io.FileAppender<F>

public abstract class ManifestWriter<F extends org.apache.iceberg.ContentFile<F>>
extends java.lang.Object
implements org.apache.iceberg.io.FileAppender<F>

Writer for manifest files.

Method Summary

Modifier and Type	Method and Description
void	add(F addedFile) Add an added entry for a file.
void	add(F addedFile, long dataSequenceNumber) Add an added entry for a file with a specific sequence number.
void	close()
protected org.apache.iceberg.ManifestContent	content()
void	delete(F deletedFile) Deprecated. since 1.1.0, will be removed in 1.2.0; use delete(ContentFile, long, Long).
void	delete(F deletedFile, long dataSequenceNumber, java.lang.Long fileSequenceNumber) Add a delete entry for a file.
void	existing(F existingFile, long fileSnapshotId, long dataSequenceNumber) Deprecated. since 1.1.0, will be removed in 1.2.0; use existing(ContentFile, long, long, Long).
void	existing(F existingFile, long fileSnapshotId, long dataSequenceNumber, java.lang.Long fileSequenceNumber) Add an existing entry for a file.
long	length()
org.apache.iceberg.Metrics	metrics()
protected abstract org.apache.iceberg.io.FileAppender<org.apache.iceberg.ManifestEntry<F>>	newAppender(org.apache.iceberg.PartitionSpec spec, org.apache.iceberg.io.OutputFile outputFile)
protected abstract org.apache.iceberg.ManifestEntry<F>	prepare(org.apache.iceberg.ManifestEntry<F> entry)
org.apache.iceberg.ManifestFile	toManifestFile()

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.io.FileAppender

addAll, addAll, splitOffsets

Method Detail

prepare

protected abstract org.apache.iceberg.ManifestEntry<F> prepare(org.apache.iceberg.ManifestEntry<F> entry)

newAppender

protected abstract org.apache.iceberg.io.FileAppender<org.apache.iceberg.ManifestEntry<F>> newAppender(org.apache.iceberg.PartitionSpec spec,
                                                                                                       org.apache.iceberg.io.OutputFile outputFile)

content

protected org.apache.iceberg.ManifestContent content()

add

public void add(F addedFile)

Add an added entry for a file.

The entry's snapshot ID will be this manifest's snapshot ID. The data and file sequence numbers will be assigned at commit.

Specified by:

add in interface org.apache.iceberg.io.FileAppender<F extends org.apache.iceberg.ContentFile<F>>

Parameters:

addedFile - a data file

add

public void add(F addedFile,
                long dataSequenceNumber)

Add an added entry for a file with a specific sequence number.

The entry's snapshot ID will be this manifest's snapshot ID. The entry's data sequence number will be the provided data sequence number. The entry's file sequence number will be assigned at commit.

Parameters:

addedFile - a data file

dataSequenceNumber - a data sequence number for the file

existing

@Deprecated
public void existing(F existingFile,
                                 long fileSnapshotId,
                                 long dataSequenceNumber)

Deprecated. since 1.1.0, will be removed in 1.2.0; use existing(ContentFile, long, long, Long).

Add an existing entry for a file.

The original data sequence number and snapshot ID, which were assigned at commit, must be preserved when adding an existing entry.

Parameters:

existingFile - a file

fileSnapshotId - snapshot ID when the data file was added to the table

dataSequenceNumber - a data sequence number of the file (assigned when the file was added)

existing

public void existing(F existingFile,
                     long fileSnapshotId,
                     long dataSequenceNumber,
                     java.lang.Long fileSequenceNumber)

Add an existing entry for a file.

The original data and file sequence numbers, snapshot ID, which were assigned at commit, must be preserved when adding an existing entry.

Parameters:

existingFile - a file

fileSnapshotId - snapshot ID when the data file was added to the table

dataSequenceNumber - a data sequence number of the file (assigned when the file was added)

fileSequenceNumber - a file sequence number (assigned when the file was added)

delete

@Deprecated
public void delete(F deletedFile)

Deprecated. since 1.1.0, will be removed in 1.2.0; use delete(ContentFile, long, Long).

Add a delete entry for a file.

This method must not be used as the original data sequence number of the file must be preserved when the file is marked as deleted.

Parameters:

deletedFile - a file

delete

public void delete(F deletedFile,
                   long dataSequenceNumber,
                   java.lang.Long fileSequenceNumber)

Add a delete entry for a file.

The entry's snapshot ID will be this manifest's snapshot ID. However, the original data and file sequence numbers of the file must be preserved when the file is marked as deleted.

Parameters:

deletedFile - a file

dataSequenceNumber - a data sequence number of the file (assigned when the file was added)

fileSequenceNumber - a file sequence number (assigned when the file was added)

metrics

public org.apache.iceberg.Metrics metrics()

Specified by:

metrics in interface org.apache.iceberg.io.FileAppender<F extends org.apache.iceberg.ContentFile<F>>

length

public long length()

Specified by:

length in interface org.apache.iceberg.io.FileAppender<F extends org.apache.iceberg.ContentFile<F>>

toManifestFile

public org.apache.iceberg.ManifestFile toManifestFile()

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException