Package org.elasticsearch.xpack.esql.datasources

Class FileMetadataColumns

java.lang.Object

org.elasticsearch.xpack.esql.datasources.FileMetadataColumns

public final class FileMetadataColumns
extends Object

Registry of well-known file metadata virtual columns for external data sources. Uses dot-namespaced names under _file.* to avoid collisions with Hive partition columns (which cannot contain dots). Separate from MetadataAttribute.ATTRIBUTES_MAP which covers ES index metadata.

Field Summary

Fields

Modifier and Type	Field	Description
static final Map<String,DataType>	COLUMNS
static final String	DIRECTORY
static final String	MODIFIED
static final String	NAME
static final Set<String>	NAMES
static final String	PATH
static final String	RECORD_REF	Opaque, stable, per-record reference.
static final String	SIZE

Method Summary

Modifier and Type	Method	Description
static Map<String,Object>	extractValues(FileList fileList, int index)	Index-based accessor for FileList, which exposes file metadata as primitives.
static Map<String,Object>	extractValues(StoragePath path, long length, Instant lastModified)	Object-typed entry point.
static Map<String,Object>	extractValues(StorageEntry entry)	Convenience overload for callers that already hold a StorageEntry.
static boolean	isFileMetadataColumn(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PATH

public static final String PATH

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

DIRECTORY

public static final String DIRECTORY

See Also:

• Constant Field Values

SIZE

public static final String SIZE

See Also:

• Constant Field Values

MODIFIED

public static final String MODIFIED

See Also:

• Constant Field Values

RECORD_REF

public static final String RECORD_REF

Opaque, stable, per-record reference. Unlike the other _file.* columns (per-file constants via extractValues(org.elasticsearch.xpack.esql.datasources.spi.StoragePath, long, java.time.Instant)), this one varies per record and is sourced from the reader's row-position channel (ColumnExtractor.ROW_POSITION_COLUMN). Shape is format-defined and opaque to consumers — equality is the only defined relation, independent of split layout. Deliberately excluded from extractValues(org.elasticsearch.xpack.esql.datasources.spi.StoragePath, long, java.time.Instant).

See Also:

• Constant Field Values

COLUMNS

public static final Map<String,DataType> COLUMNS

NAMES

public static final Set<String> NAMES

Method Details

isFileMetadataColumn

public static boolean isFileMetadataColumn(String name)

extractValues

public static Map<String,Object> extractValues(StoragePath path,
 long length,
 Instant lastModified)

Object-typed entry point. Pass lastModified == null for SQL NULL; any non-null Instant (including Instant.EPOCH) is rendered as the corresponding epoch-millis timestamp. Callers that hold a primitive epoch-millis with 0L as the "unknown" sentinel (e.g. FileList) should normalise to null before calling this method, or use extractValues(FileList, int).

extractValues

public static Map<String,Object> extractValues(StorageEntry entry)

Convenience overload for callers that already hold a StorageEntry. Note that StorageEntry normalises a null lastModified to Instant.EPOCH at construction time, so this overload cannot distinguish "modified at the epoch" from "unknown mtime". For SQL-NULL semantics, use extractValues(FileList, int).

extractValues

public static Map<String,Object> extractValues(FileList fileList,
 int index)

Index-based accessor for FileList, which exposes file metadata as primitives. A zero value for lastModifiedMillis is treated as "unknown" and yields a null value for MODIFIED so downstream layers can render it as SQL NULL. This is the recommended overload for production paths.