Skip to content

Scan

Scan is an abstraction of logical scans over data sources.

Contract

Description

String description()

Human-readable description of this scan (e.g. for logging purposes).

default: the fully-qualified class name

Used when:

Read Schema

StructType readSchema()

Read schema of this scan

Used when:

Converting to Batch

Batch toBatch()

By default, toBatch throws an UnsupportedOperationException (with the description):

[description]: Batch scan are not supported

Must be implemented (overriden), if the Table that created this Scan has BATCH_READ capability (among the capabilities).


Used when:

Converting to ContinuousStream

ContinuousStream toContinuousStream(
    String checkpointLocation)

By default, toContinuousStream throws an UnsupportedOperationException (with the description):

[description]: Continuous scan are not supported

Must be implemented (overriden), if the Table that created this Scan has CONTINUOUS_READ capability (among the capabilities).


Used when:

Converting to MicroBatchStream

MicroBatchStream toMicroBatchStream(
    String checkpointLocation)

By default, toMicroBatchStream throws an UnsupportedOperationException (with the description):

[description]: Micro-batch scan are not supported

Must be implemented (overriden), if the Table that created this Scan has MICRO_BATCH_READ capability (among the capabilities).


Used when:

Implementations