io.delta.kernel.client

Interface FileSystemClient

public interface FileSystemClient

Provides file system related functionalities to Delta Kernel. Delta Kernel uses this client whenever it needs to access the underlying file system where the Delta table is present. Connector implementation of this interface can hide filesystem specific details from Delta Kernel.

Method Summary

Modifier and Type	Method and Description
CloseableIterator<FileStatus>	listFrom(java.lang.String filePath) List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given `path`.
CloseableIterator<java.io.ByteArrayInputStream>	readFiles(CloseableIterator<Tuple2<java.lang.String,Tuple2<java.lang.Integer,java.lang.Integer>>> iter) Read data specified by the start and end offset from the file.

Method Detail

listFrom

CloseableIterator<FileStatus> listFrom(java.lang.String filePath)
                                throws java.io.FileNotFoundException

List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given `path`. The result should also be sorted by the file name.

Parameters:

filePath - Fully qualified path to a file

Returns:

Closeable iterator of files. It is the responsibility of the caller to close the iterator.

Throws:

java.io.FileNotFoundException - if the file at the given path is not found

readFiles

CloseableIterator<java.io.ByteArrayInputStream> readFiles(CloseableIterator<Tuple2<java.lang.String,Tuple2<java.lang.Integer,java.lang.Integer>>> iter)
                                                   throws java.io.IOException

Read data specified by the start and end offset from the file. It is the responsibility of the caller close each returned stream.

Parameters:

iter - Iterator for tuples (file path, range (start offset, end offset)

Returns:

Data for each range requested as one ByteArrayInputStream.

Throws:

java.io.IOException