org.apache.paimon.data.variant

Interface Variant

All Known Implementing Classes:

GenericVariant

public interface Variant

A Variant represents a type that contain one of: 1) Primitive: A type and corresponding value (e.g. INT, STRING); 2) Array: An ordered list of Variant values; 3) Object: An unordered collection of string/Variant pairs (i.e. key/value pairs). An object may not contain duplicate keys.

A Variant is encoded with 2 binary values, the value and the metadata.

The Variant Binary Encoding allows representation of semi-structured data (e.g. JSON) in a form that can be efficiently queried by path. The design is intended to allow efficient access to nested data even in the presence of very wide or deep structures.

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA
static String	VALUE

Method Summary

Modifier and Type	Method and Description
Variant	copy() Returns a copy of the variant.
byte[]	metadata() Returns the variant metadata.
long	sizeInBytes() Returns the size of the variant in bytes.
String	toJson() Parses the variant to json.
byte[]	value() Returns the variant value.
Object	variantGet(String path) Extracts a sub-variant value according to a path which start with a `$`.

Field Detail

METADATA

static final String METADATA

See Also:

Constant Field Values

VALUE

static final String VALUE

See Also:

Constant Field Values

Method Detail

metadata

byte[] metadata()

Returns the variant metadata.

value

byte[] value()

Returns the variant value.

toJson

String toJson()

Parses the variant to json.

variantGet

Object variantGet(String path)

Extracts a sub-variant value according to a path which start with a `$`. e.g.

access object's field: `$.key` or `$['key']` or `$["key"]`.

access array's first elem: `$.array[0]`

sizeInBytes

long sizeInBytes()

Returns the size of the variant in bytes.

copy

Variant copy()

Returns a copy of the variant.