org.apache.iceberg

Class ManifestWriter

java.lang.Object

org.apache.iceberg.ManifestWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, FileAppender<DataFile>

public abstract class ManifestWriter
extends java.lang.Object
implements FileAppender<DataFile>

Writer for manifest files.

Method Summary

Modifier and Type	Method and Description
void	add(DataFile addedFile) Add an added entry for a data file.
void	close()
void	delete(DataFile deletedFile) Add a delete entry for a data file.
void	existing(DataFile existingFile, long fileSnapshotId, long sequenceNumber) Add an existing entry for a data file.
long	length()
Metrics	metrics()
protected abstract FileAppender<org.apache.iceberg.ManifestEntry>	newAppender(PartitionSpec spec, OutputFile outputFile)
protected abstract org.apache.iceberg.ManifestEntry	prepare(org.apache.iceberg.ManifestEntry entry)
ManifestFile	toManifestFile()
static ManifestWriter	write(PartitionSpec spec, OutputFile outputFile) Deprecated. will be removed in 0.9.0; use ManifestFiles.write(PartitionSpec, OutputFile) instead.

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

write

@Deprecated
public static ManifestWriter write(PartitionSpec spec,
                                               OutputFile outputFile)

Deprecated. will be removed in 0.9.0; use ManifestFiles.write(PartitionSpec, OutputFile) instead.

Create a new ManifestWriter.

Manifests created by this writer have all entry snapshot IDs set to null. All entries will inherit the snapshot ID that will be assigned to the manifest on commit.

Parameters:

spec - PartitionSpec used to produce DataFile partition tuples

outputFile - the destination file location

Returns:

a manifest writer

prepare

protected abstract org.apache.iceberg.ManifestEntry prepare(org.apache.iceberg.ManifestEntry entry)

newAppender

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

add

public void add(DataFile addedFile)

Add an added entry for a data file.

The entry's snapshot ID will be this manifest's snapshot ID.

Specified by:

add in interface FileAppender<DataFile>

Parameters:

addedFile - a data file

existing

public void existing(DataFile existingFile,
                     long fileSnapshotId,
                     long sequenceNumber)

Add an existing entry for a data file.

Parameters:

existingFile - a data file

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

sequenceNumber - sequence number for the data file

delete

public void delete(DataFile deletedFile)

Add a delete entry for a data file.

The entry's snapshot ID will be this manifest's snapshot ID.

Parameters:

deletedFile - a data file

metrics

public Metrics metrics()

Specified by:

metrics in interface FileAppender<DataFile>

Returns:

Metrics for this file. Only valid after the file is closed.

length

public long length()

Specified by:

length in interface FileAppender<DataFile>

Returns:

the length of this file.

toManifestFile

public 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