org.apache.flink.connector.file.table

Class LimitableBulkFormat<T,SplitT extends FileSourceSplit>

java.lang.Object

org.apache.flink.connector.file.table.LimitableBulkFormat<T,SplitT>

All Implemented Interfaces:

Serializable, ResultTypeQueryable<T>, BulkFormat<T,SplitT>

@Internal
public class LimitableBulkFormat<T,SplitT extends FileSourceSplit>
extends Object
implements BulkFormat<T,SplitT>

A BulkFormat that can limit output record number.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.connector.file.src.reader.BulkFormat

BulkFormat.Reader<T>, BulkFormat.RecordIterator<T>

Method Summary

Modifier and Type	Method and Description
static <T,SplitT extends FileSourceSplit> BulkFormat<T,SplitT>	create(BulkFormat<T,SplitT> format, Long limit)
BulkFormat.Reader<T>	createReader(Configuration config, SplitT split) Creates a new reader that reads from the split's path starting at the split's offset and reads length bytes after the offset.
TypeInformation<T>	getProducedType() Gets the type produced by this format.
boolean	isSplittable() Checks whether this format is splittable.
BulkFormat.Reader<T>	restoreReader(Configuration config, SplitT split) Creates a new reader that reads from split.path() starting at offset and reads until length bytes after the offset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createReader

public BulkFormat.Reader<T> createReader(Configuration config,
                                         SplitT split)
                                  throws IOException

Description copied from interface: BulkFormat

Creates a new reader that reads from the split's path starting at the split's offset and reads length bytes after the offset.

Specified by:

createReader in interface BulkFormat<T,SplitT extends FileSourceSplit>

Throws:

IOException

restoreReader

public BulkFormat.Reader<T> restoreReader(Configuration config,
                                          SplitT split)
                                   throws IOException

Description copied from interface: BulkFormat

Creates a new reader that reads from split.path() starting at offset and reads until length bytes after the offset. A number of recordsToSkip records should be read and discarded after the offset. This is typically part of restoring a reader to a checkpointed position.

Specified by:

restoreReader in interface BulkFormat<T,SplitT extends FileSourceSplit>

Throws:

IOException

isSplittable

public boolean isSplittable()

Description copied from interface: BulkFormat

Checks whether this format is splittable. Splittable formats allow Flink to create multiple splits per file, so that Flink can read multiple regions of the file concurrently.

See top-level JavaDocs (section "Splitting") for details.

Specified by:

isSplittable in interface BulkFormat<T,SplitT extends FileSourceSplit>

getProducedType

public TypeInformation<T> getProducedType()

Description copied from interface: BulkFormat

Gets the type produced by this format. This type will be the type produced by the file source as a whole.

Specified by:

getProducedType in interface ResultTypeQueryable<T>

Specified by:

getProducedType in interface BulkFormat<T,SplitT extends FileSourceSplit>

Returns:

The data type produced by this function or input format.

create

public static <T,SplitT extends FileSourceSplit> BulkFormat<T,SplitT> create(BulkFormat<T,SplitT> format,
                                                                             Long limit)