Interface PqVariant

public interface PqVariant

Variant value — the top-level accessor for a Parquet column annotated with the VARIANT logical type. A Variant carries the canonical two-part binary encoding (metadata(), value()) plus a type tag (type()), and exposes tag-specific extraction through the as*() methods.

PqVariant v = row.getVariant("event");
if (v.type() == VariantType.OBJECT) {
    PqVariantObject obj = v.asObject();
    String userId = obj.getString("user_id");
}

Every nested Variant sub-value (array element, object field value) is itself a PqVariant, so navigation composes naturally.

See Also:

• Parquet Variant Encoding

Method Summary

Modifier and Type	Method	Description
PqVariantArray	asArray()	Unwrap as a Variant array view for indexed element access.
byte[]	asBinary()	Extract opaque binary bytes.
boolean	asBoolean()	Extract a boolean.
LocalDate	asDate()	Extract a date (days since Unix epoch).
BigDecimal	asDecimal()	Extract a decimal.
double	asDouble()	Extract a double.
float	asFloat()	Extract a float.
int	asInt()	Extract an int.
long	asLong()	Extract a long.
PqVariantObject	asObject()	Unwrap as a Variant object view for name-based field navigation.
String	asString()	Extract a UTF-8 string.
LocalTime	asTime()	Extract a time of day.
Instant	asTimestamp()	Extract a timestamp.
UUID	asUuid()	Extract a UUID (16 bytes, big-endian).
boolean	isNull()	True iff type() is VariantType.NULL.
byte[]	metadata()	The canonical Variant metadata bytes.
VariantType	type()	The Variant type tag decoded from the value header.
byte[]	value()	The canonical Variant value bytes.

Method Details

metadata

byte[] metadata()

The canonical Variant metadata bytes.

value

byte[] value()

The canonical Variant value bytes.

type

VariantType type()

The Variant type tag decoded from the value header.

isNull

boolean isNull()

True iff type() is VariantType.NULL.

asBoolean

boolean asBoolean()

Extract a boolean. Requires VariantType.BOOLEAN_TRUE or VariantType.BOOLEAN_FALSE.

Throws:

VariantTypeException - if the type is not a boolean

asInt

int asInt()

Extract an int. Narrows INT8/INT16/INT32 values.

Throws:

VariantTypeException - if the type is not INT8/INT16/INT32

asLong

long asLong()

Extract a long. Accepts INT8/INT16/INT32/INT64.

Throws:

VariantTypeException - if the type is not an integer

asFloat

float asFloat()

Extract a float.

Throws:

VariantTypeException - if the type is not VariantType.FLOAT

asDouble

double asDouble()

Extract a double.

Throws:

VariantTypeException - if the type is not VariantType.DOUBLE

asString

String asString()

Extract a UTF-8 string. Accepts both the short-string encoding and the primitive STRING encoding.

Throws:

VariantTypeException - if the type is not a string

asBinary

byte[] asBinary()

Extract opaque binary bytes.

Throws:

VariantTypeException - if the type is not VariantType.BINARY

asDecimal

BigDecimal asDecimal()

Extract a decimal. Accepts DECIMAL4/DECIMAL8/DECIMAL16.

Throws:

VariantTypeException - if the type is not a decimal

asDate

LocalDate asDate()

Extract a date (days since Unix epoch).

Throws:

VariantTypeException - if the type is not VariantType.DATE

asTime

LocalTime asTime()

Extract a time of day.

Throws:

VariantTypeException - if the type is not VariantType.TIME_NTZ

asTimestamp

Instant asTimestamp()

Extract a timestamp. Accepts TIMESTAMP/TIMESTAMP_NTZ (micros) and TIMESTAMP_NANOS/TIMESTAMP_NTZ_NANOS (nanos).

Throws:

VariantTypeException - if the type is not a timestamp

asUuid

UUID asUuid()

Extract a UUID (16 bytes, big-endian).

Throws:

VariantTypeException - if the type is not VariantType.UUID

asObject

PqVariantObject asObject()

Unwrap as a Variant object view for name-based field navigation.

Throws:

VariantTypeException - if the type is not VariantType.OBJECT

asArray

PqVariantArray asArray()

Unwrap as a Variant array view for indexed element access.

Throws:

VariantTypeException - if the type is not VariantType.ARRAY