io.cdap.cdap.api.data.batch

Interface BatchReadable<KEY,VALUE>

Type Parameters:

KEY - The key type.

VALUE - The value type.

All Known Subinterfaces:

ObjectMappedTable<T>, ObjectStore<T>, Table

All Known Implementing Classes:

IndexedTable, KeyValueTable, TimeseriesTable

@Beta
public interface BatchReadable<KEY,VALUE>

Interface for datasets that can be input to a batch job.

In order to feed a dataset into a batch job, the dataset must be splittable into chunks so that it's possible to process every part of the dataset in parallel. Every chunk must be readable as a collection of {key,value} records.

Method Summary

Modifier and Type	Method and Description
SplitReader<KEY,VALUE>	createSplitReader(Split split) Creates a reader for the split of a dataset.
List<Split>	getSplits() Returns all splits of the dataset.

Method Detail

getSplits

List<Split> getSplits()

Returns all splits of the dataset.

For feeding the whole dataset into a batch job.

Returns:

A list of Splits.

createSplitReader

SplitReader<KEY,VALUE> createSplitReader(Split split)

Creates a reader for the split of a dataset.

Parameters:

split - The split to create a reader for.

Returns:

The instance of a SplitReader.