Package org.elasticsearch.xpack.esql.datasources

Interface ExternalSourceMetadata

All Superinterfaces:

SourceMetadata

public interface ExternalSourceMetadata
extends SourceMetadata

Extended interface for external data source metadata.

This interface extends SourceMetadata to provide a unified metadata type for all external sources (Iceberg tables, Parquet files, etc.) while maintaining backward compatibility with existing code that uses the legacy method names.

New implementations should prefer using SourceMetadata methods directly:

• location() instead of tablePath()
• schema() instead of attributes()

For table-based sources (Iceberg, Delta Lake), implementations should store native schema and source-specific data in SourceMetadata.sourceMetadata() to avoid re-resolving the table during execution.

Method Summary

Modifier and Type	Method	Description
default List<Attribute>	attributes()	Deprecated. Use schema() instead
default String	location()	Default implementation of SourceMetadata.location() that delegates to tablePath() for backward compatibility.
default List<Attribute>	schema()	Default implementation of SourceMetadata.schema() that delegates to attributes() for backward compatibility.
default String	tablePath()	Deprecated. Use location() instead

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

config, partitionColumns, sourceMetadata, sourceType, statistics

Method Details

tablePath

@Deprecated
default String tablePath()

Deprecated.

Use location() instead

Returns the path or identifier of the external source (e.g., S3 path).

Returns:

the source path

attributes

@Deprecated
default List<Attribute> attributes()

Deprecated.

Use schema() instead

Returns the list of attributes representing the schema of the external source.

Returns:

list of attributes

location

default String location()

Default implementation of SourceMetadata.location() that delegates to tablePath() for backward compatibility.

Implementations should override either this method or tablePath().

Specified by:

location in interface SourceMetadata

Returns:

the location string, never null

schema

default List<Attribute> schema()

Default implementation of SourceMetadata.schema() that delegates to attributes() for backward compatibility.

Implementations should override either this method or attributes().

Specified by:

schema in interface SourceMetadata

Returns:

list of attributes representing the schema, never null