Package org.elasticsearch.xpack.esql.datasources

Class HivePartitionDetector

java.lang.Object

org.elasticsearch.xpack.esql.datasources.HivePartitionDetector

All Implemented Interfaces:

PartitionDetector

public final class HivePartitionDetector
extends Object
implements PartitionDetector

Detects Hive-style partition columns from file paths (e.g., /year=2024/month=06/file.parquet). Parses key=value segments, validates consistency across all files, and infers types using Spark-style rules: try Integer, Long, Double, Boolean, fallback to keyword.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HIVE_DEFAULT_PARTITION	Sentinel directory name written by Hive for rows whose partition column is NULL.
static final HivePartitionDetector	INSTANCE
static final String	RESERVED_RENAME_PREFIX	Prefix applied to a partition column whose name collides with a dedicated metadata name.

Method Summary

Modifier and Type	Method	Description
PartitionMetadata	detect(List<StorageEntry> files, Map<String,Object> config)
String	name()

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final HivePartitionDetector INSTANCE

HIVE_DEFAULT_PARTITION

public static final String HIVE_DEFAULT_PARTITION

Sentinel directory name written by Hive for rows whose partition column is NULL. When this token appears as a Hive-style key=value segment value, it must be surfaced as SQL NULL rather than the literal string, otherwise WHERE col IS NULL silently misses rows and STATS BY col buckets them under a phantom string key.

See Also:

• Constant Field Values

RESERVED_RENAME_PREFIX

public static final String RESERVED_RENAME_PREFIX

Prefix applied to a partition column whose name collides with a dedicated metadata name. Standard metadata (_id, _index, ...), the _file.* family, and reader-synthesized channel names are reserved: a layout author cannot claim them, or METADATA _index would silently return the partition value instead of its spec-defined meaning (the dataset name). A directory like /_index=foo/ surfaces as _partition._index — the spec name keeps its meaning, the layout's value stays queryable, and a Warning header discloses each rename. Shared by every detector; see ReservedPartitionNames.

See Also:

• Constant Field Values

Method Details

name

public String name()

Specified by:

name in interface PartitionDetector

detect

public PartitionMetadata detect(List<StorageEntry> files,
 Map<String,Object> config)

Specified by:

detect in interface PartitionDetector