Package org.apache.spark.sql.connector.catalog

Interface SessionConfigSupport

All Superinterfaces:

TableProvider

@Evolving
public interface SessionConfigSupport
extends TableProvider

A mix-in interface for TableProvider. Data sources can implement this interface to propagate session configs with the specified key-prefix to all data source operations in this session.

Since:

3.0.0

Method Summary

Modifier and Type	Method	Description
String	keyPrefix()	Key prefix of the session configs to propagate, which is usually the data source name.

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

getTable, inferPartitioning, inferSchema, supportsExternalMetadata

Method Details

keyPrefix

String keyPrefix()

Key prefix of the session configs to propagate, which is usually the data source name. Spark will extract all session configs that starts with `spark.datasource.$keyPrefix`, turn `spark.datasource.$keyPrefix.xxx -> yyy` into `xxx -> yyy`, and propagate them to all data source operations in this session.