org.apache.spark.sql.connector.catalog

Interface SupportsRead

All Superinterfaces:

Table

@Evolving
public interface SupportsRead
extends Table

A mix-in interface of Table, to indicate that it's readable. This adds newScanBuilder(CaseInsensitiveStringMap) that is used to create a scan for batch, micro-batch, or continuous processing.

Since:

3.0.0

Method Summary

Modifier and Type	Method and Description
ScanBuilder	newScanBuilder(CaseInsensitiveStringMap options) Returns a ScanBuilder which can be used to build a Scan.

Methods inherited from interface org.apache.spark.sql.connector.catalog.Table

capabilities, columns, name, partitioning, properties, schema

Method Detail

newScanBuilder

ScanBuilder newScanBuilder(CaseInsensitiveStringMap options)

Returns a ScanBuilder which can be used to build a Scan. Spark will call this method to configure each data source scan.

Parameters:

options - The options for reading, which is an immutable case-insensitive string-to-string map.