io.cdap.cdap.api.data.batch

Interface RecordScannable<RECORD>

Type Parameters:

RECORD - the type of objects that represents a single record

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ObjectMappedTable<T>, Table

All Known Implementing Classes:

IndexedTable, KeyValueTable

@Beta
public interface RecordScannable<RECORD>
extends Closeable

Represents data sets that can be processed in batches, as series of records (as apposed to key/value pairs). See BatchReadable.

Method Summary

Modifier and Type	Method and Description
RecordScanner<RECORD>	createSplitRecordScanner(Split split) Creates a reader for the split of a dataset.
Type	getRecordType() The type of records that the dataset exposes as a schema.
List<Split>	getSplits() Returns all splits of the dataset.

Methods inherited from interface java.io.Closeable

close

Method Detail

getRecordType

Type getRecordType()

The type of records that the dataset exposes as a schema. The schema will be derived from the type using reflection.

Returns:

the schema type.

getSplits

List<Split> getSplits()

Returns all splits of the dataset.

For feeding the whole dataset into a batch job.

Returns:

A list of Splits.

createSplitRecordScanner

RecordScanner<RECORD> createSplitRecordScanner(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 RecordScanner.