org.apache.paimon.fs

Interface VectoredReadable

All Known Implementing Classes:

LocalFileIO.LocalSeekableInputStream

public interface VectoredReadable

Stream that permits vectored reading.

Method Summary

Modifier and Type	Method and Description
default int	batchSizeForVectorReads() The batch size of data read by a single parallelism.
default int	minSeekForVectorReads() The smallest reasonable seek.
default int	parallelismForVectorReads() The read parallelism for vector reads.
int	pread(long position, byte[] buffer, int offset, int length) Read up to the specified number of bytes, from a given position within a file, and return the number of bytes read.
default void	preadFully(long position, byte[] buffer, int offset, int length) Read the specified number of bytes fully, from a given position within a file.
default void	readVectored(List<? extends FileRange> ranges) Read fully a list of file ranges asynchronously from this file.

Method Detail

pread

int pread(long position,
          byte[] buffer,
          int offset,
          int length)
   throws IOException

Read up to the specified number of bytes, from a given position within a file, and return the number of bytes read. This does not change the current offset of a file, and is thread-safe.

Throws:

IOException

preadFully

default void preadFully(long position,
                        byte[] buffer,
                        int offset,
                        int length)
                 throws IOException

Read the specified number of bytes fully, from a given position within a file. This does not change the current offset of a file, and is thread-safe.

Throws:

IOException

minSeekForVectorReads

default int minSeekForVectorReads()

The smallest reasonable seek.

batchSizeForVectorReads

default int batchSizeForVectorReads()

The batch size of data read by a single parallelism.

parallelismForVectorReads

default int parallelismForVectorReads()

The read parallelism for vector reads.

readVectored

default void readVectored(List<? extends FileRange> ranges)
                   throws IOException

Read fully a list of file ranges asynchronously from this file.

As a result of the call, each range will have FileRange.setData(CompletableFuture) called with a future that when complete will have a ByteBuffer with the data from the file's range.

Throws:

IOException