Scan¶

Scan is an abstraction of logical scans over data sources.

Contract¶

Description¶

String description()

Used when DataSourceV2ScanExecBase physical operator is requested for a simpleString

readSchema¶

StructType readSchema()

Used when...FIXME

toBatch¶

Batch toBatch()

By default, toBatch throws an UnsupportedOperationException (with 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 BatchScanExec physical operator is requested for batch.

toContinuousStream¶

ContinuousStream toContinuousStream(
    String checkpointLocation)

Used when...FIXME

toMicroBatchStream¶

MicroBatchStream toMicroBatchStream(
    String checkpointLocation)

Used when...FIXME

Implementations¶

• FileScan
• KafkaScan
• MemoryStreamScanBuilder
• SupportsReportPartitioning
• SupportsReportStatistics
• V1Scan
• V1ScanWrapper