Package org.apache.iceberg.io

Interface SupportsPrefixOperations

All Superinterfaces:

AutoCloseable, Closeable, FileIO, Serializable

All Known Subinterfaces:

DelegateFileIO

All Known Implementing Classes:

ADLSFileIO, GCSFileIO, HadoopFileIO, ResolvingFileIO, S3FileIO

public interface SupportsPrefixOperations
extends FileIO

This interface is intended as an extension for FileIO implementations to provide additional prefix based operations that may be useful in performing supporting operations.

Method Summary

Modifier and Type	Method	Description
void	deletePrefix(String prefix)	Delete all files under a prefix.
Iterable<FileInfo>	listPrefix(String prefix)	Return an iterable of all files under a prefix.

Methods inherited from interface org.apache.iceberg.io.FileIO

close, deleteFile, deleteFile, deleteFile, initialize, newInputFile, newInputFile, newInputFile, newInputFile, newInputFile, newOutputFile, properties

Method Details

listPrefix

Iterable<FileInfo> listPrefix(String prefix)

Return an iterable of all files under a prefix.

Hierarchical file systems (e.g. HDFS) may impose additional restrictions like the prefix must fully match a directory whereas key/value object stores may allow for arbitrary prefixes.

Parameters:

prefix - prefix to list

Returns:

iterable of file information

deletePrefix

void deletePrefix(String prefix)

Delete all files under a prefix.

Hierarchical file systems (e.g. HDFS) may impose additional restrictions like the prefix must fully match a directory whereas key/value object stores may allow for arbitrary prefixes.

Parameters:

prefix - prefix to delete