Index

Modules: nimarrow/arrays, nimarrow/bitarray, nimarrow/parquet, nimarrow/tables.

API symbols

`$`:

• arrays: `$`[T](arr: ArrowArray[T]): string
• arrays: `$`[T](chunkedArray: ArrowChunkedArray[T]): string
• bitarray: `$`[T](b: BitVector[T]): string
• tables: `$`(table: ArrowTable): string

`==`:

• arrays: `==`[T](a, b: ArrowChunkedArray[T]): bool
• bitarray: `==`(x, y: BitVector): bool
• tables: `==`(table, other: ArrowTable): bool

`=destroy`:

• arrays: `=destroy`[T](x: var ArrowArrayObj[T])
• arrays: `=destroy`[T](x: var ArrowChunkedArrayObj[T])
• arrays: `=destroy`[T](x: var WrappedBufferObj[T])
• parquet: `=destroy`(x: var ParquetReaderObj)
• parquet: `=destroy`(x: var ParquetWriterObj)
• parquet: `=destroy`(x: var ParquetWriterPropsObj)
• tables: `=destroy`(x: var ArrowFieldObj)
• tables: `=destroy`(x: var ArrowSchemaObj)
• tables: `=destroy`(x: var ArrowTableObj)

`@`:

• arrays: `@`[T](arr: ArrowArray[T]): seq[T]
• arrays: `@`[T](chunkedArray: ArrowChunkedArray[T]): seq[T]

`[]=`:

• bitarray: `[]=`[T](b: var BitVector[T]; i: int; value: Bit)

`[]`:

• arrays: `[]`[T](arr: ArrowArray[T]; i: int): T
• arrays: `[]`[T](arr: ArrowArray[T]; i: int64): T
• arrays: `[]`[T](arr: ArrowArray[T]; slice: Slice[int64]): ArrowArray[T]
• arrays: `[]`[T](arr: ArrowArray[T]; slice: Slice[int]): ArrowArray[T]
• arrays: `[]`[T](chunkedArray: ArrowChunkedArray[T]; i: int64): T
• bitarray: `[]`[T](b: BitVector[T]; i: int): Bit

add:

• arrays: add[T](builder: ArrowArrayBuilder[T]; x: Option[T])
• arrays: add[T](builder: ArrowArrayBuilder[T]; x: T)
• bitarray: add[T](b: var BitVector[T]; value: Bit)
• parquet: add(w: ParquetWriter; table: ArrowTable)
• parquet: add[T](w: TypedParquetWriter[T]; x: T)
• tables: add[T](b: ArrowTableBuilder; arr: ArrowArray[T])
• tables: add[T](typedBuilder: TypedBuilder[T]; ts: openArray[T])

ArrowArray:

• arrays: ArrowArray

ArrowArrayBuilder:

• arrays: ArrowArrayBuilder

ArrowChunkedArray:

• arrays: ArrowChunkedArray

ArrowField:

• tables: ArrowField

ArrowSchema:

• tables: ArrowSchema

ArrowTable:

• tables: ArrowTable

ArrowTableBuilder:

• tables: ArrowTableBuilder

BitVector:

• bitarray: BitVector

build:

• arrays: build[T](builder: ArrowArrayBuilder[T]): ArrowArray[T]
• tables: build(b: ArrowTableBuilder): ArrowTable

Bytes:

• arrays: Bytes

cap:

• bitarray: cap[T](b: BitVector[T]): int

chunk:

• arrays: chunk[T](chunkedArray: ArrowChunkedArray[T]; i: uint): ArrowArray[T]

chunks:

• arrays: chunks[T](chunkedArray: ArrowChunkedArray[T]): uint

close:

• parquet: close(w: ParquetWriter)
• parquet: close[T](w: TypedParquetWriter[T])

col:

• tables: col(table: ArrowTable; T: typedesc; i: int): ArrowChunkedArray[T]
• tables: col(table: ArrowTable; T: typedesc; name: string): ArrowChunkedArray[T]

combine:

• arrays: combine[T](chunkedArray: ArrowChunkedArray[T]): ArrowArray[T]

fromParquet:

• parquet: fromParquet(path: string): ArrowTable

getDataType:

• arrays: getDataType(tag`gensym7: TypeTag[bool]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym25: TypeTag[float32]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym27: TypeTag[float64]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym29: TypeTag[string]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym32: TypeTag[Bytes]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym9: TypeTag[int8]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym11: TypeTag[uint8]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym13: TypeTag[int16]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym15: TypeTag[uint16]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym17: TypeTag[int32]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym19: TypeTag[uint32]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym21: TypeTag[int64]): GArrowDataTypePtr
• arrays: getDataType(tag`gensym23: TypeTag[uint64]): GArrowDataTypePtr

glibPtr:

• arrays: glibPtr[T](arr: ArrowArray[T]): GArrowArrayPtr
• tables: glibPtr(field: ArrowField): GArrowFieldPtr
• tables: glibPtr(schema: ArrowSchema): GArrowSchemaPtr
• tables: glibPtr(table: ArrowTable): GArrowTablePtr

isNullAt:

• arrays: isNullAt[T](arr: ArrowArray[T]; i: int64): bool

items:

• arrays: items[T](arr: ArrowArray[T]): T
• arrays: items[T](chunkedArray: ArrowChunkedArray[T]): T

iter:

• parquet: iter(r: ParquetReader; T: typedesc): T:type
• tables: iter(tbl: ArrowTable; T: typedesc): untyped

len:

• arrays: len[T](arr: ArrowArray[T]): int64
• arrays: len[T](chunkedArray: ArrowChunkedArray[T]): uint64
• bitarray: len[T](b: BitVector[T]): int
• tables: len(table: ArrowTable): uint64

newArrowArray:

• arrays: newArrowArray[T](data: openArray[Option[T]]): ArrowArray[T]
• arrays: newArrowArray[T](data: openArray[T]): ArrowArray[T]

newArrowArrayBuilder:

• arrays: newArrowArrayBuilder[T](): ArrowArrayBuilder[T]

newArrowChunkedArray:

• arrays: newArrowChunkedArray[T](glibChunkedArray: GArrowChunkedArrayPtr): ArrowChunkedArray[ T]

newArrowField:

• tables: newArrowField(name: string; T: typedesc): ArrowField

newArrowSchema:

• tables: newArrowSchema(glibSchema: GArrowSchemaPtr): ArrowSchema
• tables: newArrowSchema(fields: openArray[ArrowField]): ArrowSchema

newArrowTable:

• tables: newArrowTable(schema: ArrowSchema; glibTable: GArrowTablePtr): ArrowTable
• tables: newArrowTable(T: typedesc; ts: openArray[T:type]): ArrowTable

newArrowTableBuilder:

• tables: newArrowTableBuilder(schema: ArrowSchema): ArrowTableBuilder

newBitVector:

• bitarray: newBitVector[T](size: int; init = 0): BitVector[T]

newEmptyArrowArray:

• arrays: newEmptyArrowArray[T](): ArrowArray[T]

newParquetReader:

• parquet: newParquetReader(path: string; useThreads: bool = true): ParquetReader

newParquetWriter:

• parquet: newParquetWriter(schema: ArrowSchema; path: string; props: Option[ParquetWriterProps] = none(ParquetWriterProps)): ParquetWriter

newParquetWriterProps:

• parquet: newParquetWriterProps(compression: GArrowCompressionType = GARROW_COMPRESSION_TYPE_SNAPPY; enableDictionary: bool = true; dictionaryPageSizeLimit: Option[int64] = none(int64); batchSize: Option[int64] = none(int64); maxRowGroupLength: Option[int64] = none(int64); dataPageSize: Option[int64] = none(int64)): ParquetWriterProps

newTypedBuilder:

• tables: newTypedBuilder(T: typedesc): TypedBuilder[T]

newTypedParquetWriter:

• parquet: newTypedParquetWriter[T: TypeRegistered](path: string; props: Option[ParquetWriterProps] = none(ParquetWriterProps)): TypedParquetWriter[ T]

NullBitmap:

• arrays: NullBitmap

ParquetReader:

• parquet: ParquetReader

ParquetWriter:

• parquet: ParquetWriter

ParquetWriterProps:

• parquet: ParquetWriterProps

read:

• parquet: read(r: ParquetReader; rowGroup: int): ArrowTable

readFully:

• parquet: readFully(r: ParquetReader): ArrowTable

registerTypedTable:

• tables: registerTypedTable(typ: typedesc): untyped

rowGroups:

• parquet: rowGroups(r: ParquetReader): int

schema:

• tables: schema(table: ArrowTable): ArrowSchema

toParquet:

• parquet: toParquet(t: ArrowTable; path: string; props: Option[ParquetWriterProps] = none(ParquetWriterProps))

toSeq:

• arrays: toSeq[T](arr: ArrowArray[T]): seq[T]
• arrays: toSeq[T](chunkedArray: ArrowChunkedArray[T]): seq[T]

TypedBuilder:

• tables: TypedBuilder

TypedParquetWriter:

• parquet: TypedParquetWriter

TypeRegistered:

• tables: TypeRegistered

TypeTag:

• arrays: TypeTag

Units:

• bitarray: Units