xtdb-api/xtdb.arrow

Package-level declarations

Types

sealed interface Encoding

How a column's values are laid out, carried by its VectorType beside its arrow type — as a FieldType carries a dictionary encoding.

typealias FieldName = String

enum RunEndWidth : Enum<RunEndWidth>

The integer type of a run-end encoded column's run-ends — Arrow allows exactly these three.

sealed class VectorType

typealias VectorTypes = Map<FieldName, VectorType>

Properties

val BOOL_TYPE: ArrowType

val F32_TYPE: ArrowType

val F64_TYPE: ArrowType

val I16_TYPE: ArrowType

val I32_TYPE: ArrowType

val I64_TYPE: ArrowType

val I8_TYPE: ArrowType

val IID_TYPE: ArrowType

val INSTANT_TYPE: ArrowType

const val LIST_ELS_NAME: String

val LIST_TYPE: ArrowType

MAP_ENTRIES_NAME

const val MAP_ENTRIES_NAME: String

const val MAP_KEYS_NAME: String

MAP_VALUES_NAME

const val MAP_VALUES_NAME: String

val NULL_TYPE: ArrowType

REE_RUN_ENDS_NAME

const val REE_RUN_ENDS_NAME: String

REE_VALUES_NAME

const val REE_VALUES_NAME: String

RUN_END_ENCODED_TYPE

val RUN_END_ENCODED_TYPE: ArrowType

val STRUCT_TYPE: ArrowType

val UNION_TYPE: ArrowType

val UTF8_TYPE: ArrowType

VAR_BINARY_TYPE

val VAR_BINARY_TYPE: ArrowType

Functions

fun schema(vararg fields: Field): Schema

fun ArrowType.toLeg(): String

fun Field.withName(name: FieldName): Field

withUnionTypeIds

fun Field.withUnionTypeIds(): Field

This field, with typeIds declared explicitly on every union in its tree — 0 until childCount.