xtdb-api/xtdb.arrow/VectorType

VectorType

sealed class VectorType

Inheritors

Types

object Companion

data class Listy @JvmOverloads constructor(val arrowType: ArrowType, val elType: VectorType, val encoding: Encoding = Encoding.Plain) : VectorType.Mono

data class Maybe(val mono: VectorType.Mono) : VectorType

sealed class Mono : VectorType

data object Nothing : VectorType

The lattice bottom: no values seen yet, no constraint. Nothing ⊔ X = X.

data object Null : VectorType.Mono

data class Poly @JvmOverloads constructor(children: Set<VectorType.Mono>, val encoding: Encoding = Encoding.Plain) : VectorType

data class Scalar @JvmOverloads constructor(val arrowType: ArrowType, val encoding: Encoding = Encoding.Plain) : VectorType.Mono

data class Struct @JvmOverloads constructor(val children: Map<FieldName, VectorType>, val encoding: Encoding = Encoding.Plain) : VectorType.Mono

Properties

abstract val arrowType: ArrowType

The values' type, whatever their encoding.

abstract val asLegField: Field

@get:JvmName(name = "asMono")

val asMono: VectorType.Mono

abstract val encoding: Encoding

abstract val legs: Iterable<VectorType.Mono>

abstract val nullable: Boolean

abstract val unencoded: VectorType

The type of the values themselves: this type with no encoding at any depth — this, where it has none.

Functions

fun runEndEncoded(width: RunEndWidth = RunEndWidth.I32): VectorType

abstract fun toField(name: FieldName): Field

abstract fun withEncoding(encoding: Encoding): VectorType

This type with its values laid out as encoding.