Skip to main content

Module heterogeneous

Module heterogeneous 

Source
Expand description

Existing heterogeneous Arrow wire contracts, independent of DataFusion and I/O.

Versions describe recognized layouts; they add no metadata to persisted values.

Enums§

Decoded
Selected payload stays borrowed; callers perform only their own logical-type conversion.
Layout
Descriptive versions of the three existing wire layouts.
Scalar
Only values representable by the persisted scalar layout can enter its encoder.
ValueError
Stable typed failures for supported heterogeneous value contracts.

Constants§

BOOL
Persisted field name for bool.
DYNAMIC_PREFIX
Persisted field name for dynamic prefix.
FLOAT
Persisted field name for float.
INT
Persisted field name for int.
KEY
Persisted field name for key.
LIST
Persisted field name for list.
MAP
Persisted field name for map.
MAP_KEY
Persisted field name for map key.
MAP_VALUE
Persisted field name for map value.
STR
Persisted field name for str.
TAG
Persisted field name for tag.

Functions§

constant_fields
Canonical constant-expression fields, including numeric ordering key.
contains_heterogeneous
Check nested schemas and identify whether value validation is necessary.
decode_row
Validate and select a single heterogeneous row without copying its payload.
decode_scalar
Decode one canonical stored scalar property.
dynamic_fields
Canonical per-expression payload-index fields.
encode_constant
Encode the existing constant/nested layout from neutral values.
encode_dynamic
Encode one dynamic expression list per input row, keeping tags as payload indexes.
encode_dynamic_rows
Assemble existing dynamic rows from selected payload indexes and typed columns.
encode_scalar
Encode canonical stored scalar properties, distinguishing absent and explicit null.
map_entry_fields
Canonical key/value entry fields at the given value depth.
payload_field
Name of a dynamic payload at its per-expression index.
recognize
Recognize ordinary structs separately from malformed reserved heterogeneous schemas.
scalar_fields
Canonical stored scalar fields, without an ordering key.
validate_array
Validate nested values before exposing a batch, including dynamic nested structs.