Package org.elasticsearch.xpack.esql.datasources.spi

Interface TableCatalog

All Superinterfaces:

AutoCloseable, Closeable, ExternalSourceFactory

public interface TableCatalog
extends ExternalSourceFactory, Closeable

Connects to table catalog systems like Iceberg, Delta Lake, or Hudi. Provides metadata resolution and scan planning for table-based data sources.

Unlike FormatReader which reads individual files, TableCatalog understands table structure including partitioning, snapshots, and metadata management. It returns the same SourceMetadata type as FormatReader for consistency in schema discovery.

Table-based sources differ from file-based sources in that the schema is defined at the TABLE level, separate from data files. The native schema (e.g., Iceberg Schema) must be preserved in SourceMetadata.sourceMetadata() to avoid re-resolving the table during execution.

Implementations typically reuse a FormatReader (e.g., ParquetFormatReader) for actual data reading after planning which files to read.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TableCatalog.DataFile

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(String path)
String	catalogType()
default FilterPushdownSupport	filterPushdownSupport()
SourceMetadata	metadata(String tablePath, Map<String,Object> config)
default SourceOperatorFactoryProvider	operatorFactory()
List<TableCatalog.DataFile>	planScan(String tablePath, Map<String,Object> config, List<Object> predicates)
default SourceMetadata	resolveMetadata(String location, Map<String,Object> config)
default String	type()

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.elasticsearch.xpack.esql.datasources.spi.ExternalSourceFactory

splitProvider

Method Details

catalogType

String catalogType()

canHandle

boolean canHandle(String path)

Specified by:

canHandle in interface ExternalSourceFactory

metadata

SourceMetadata metadata(String tablePath,
 Map<String,Object> config)
                 throws IOException

Throws:

IOException

planScan

List<TableCatalog.DataFile> planScan(String tablePath,
 Map<String,Object> config,
 List<Object> predicates)
                              throws IOException

Throws:

IOException

type

default String type()

Specified by:

type in interface ExternalSourceFactory

resolveMetadata

default SourceMetadata resolveMetadata(String location,
 Map<String,Object> config)

Specified by:

resolveMetadata in interface ExternalSourceFactory

filterPushdownSupport

default FilterPushdownSupport filterPushdownSupport()

Specified by:

filterPushdownSupport in interface ExternalSourceFactory

operatorFactory

default SourceOperatorFactoryProvider operatorFactory()

Specified by:

operatorFactory in interface ExternalSourceFactory