Package org.elasticsearch.xpack.esql.datasources

Enum Class SyntheticColumns.Kind

java.lang.Object

java.lang.Enum<SyntheticColumns.Kind>

org.elasticsearch.xpack.esql.datasources.SyntheticColumns.Kind

All Implemented Interfaces:

Serializable, Comparable<SyntheticColumns.Kind>, Constable

Enclosing class:

SyntheticColumns

public static enum SyntheticColumns.Kind
extends Enum<SyntheticColumns.Kind>

Registry of reader-synthesized internal channels. Each kind carries the canonical column name and the attribute shape (DataType + Nullability) the engine expects. Adding a new kind here is the single change that grows the registry; consumers read the shape off the member's accessors.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ROW_POSITION	Per-record token.

Method Summary

Modifier and Type	Method	Description
String	columnName()
DataType	dataType()
Nullability	nullability()
static SyntheticColumns.Kind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SyntheticColumns.Kind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ROW_POSITION

public static final SyntheticColumns.Kind ROW_POSITION

Per-record token. The substrate for _id composition (hashed with the file identity by ExternalRowIdentity) and surfaced directly as the virtual _file.record_ref column. Format-defined opaque value (file-global row index on columnar formats, file-global byte offset on text formats). Nullability is UNKNOWN, not FALSE: readers without a row-position channel (parquet-rs) null-splice this slot, so a never-null declaration would license null-aware optimizer rules to mis-fold against those sources.

Method Details

values

public static SyntheticColumns.Kind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SyntheticColumns.Kind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

columnName

public String columnName()

dataType

public DataType dataType()

nullability

public Nullability nullability()