Class RecordBatch<T>

Type parameters

T: {} = any

Hierarchy

StructVector<T>
- RecordBatch

Implements

Clonable<RecordBatch<T>>
Sliceable<RecordBatch<T>>
Applicative<Struct<T>, Table<T>>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RecordBatch<T>(schema: Schema<T>, length: number, children: (Data<DataType<Type, any>> | Vector<any>)[]): RecordBatch<T>
new RecordBatch<T>(schema: Schema<T>, data: Data<Struct<T>>, children?: Vector<any>[]): RecordBatch<T>

- Defined in recordbatch.ts:69
Type parameters
- T: {} = any
Parameters
- schema: Schema<T>
- length: number
- children: (Data<DataType<Type, any>> | Vector<any>)[]
Returns RecordBatch<T>
- Defined in recordbatch.ts:70
Type parameters
- T: {} = any
Parameters
- schema: Schema<T>
- data: Data<Struct<T>>
- Optional children: Vector<any>[]
Returns RecordBatch<T>

Properties

Readonly TArray

TArray: IterableArrayLike<RowLike<T>>

Readonly TType

TType: Struct

Readonly TValue

TValue: RowLike<T>

Readonly [Symbol.isConcatSpreadable]

[Symbol.isConcatSpreadable]: boolean

Readonly data

data: Data<Struct<T>>

Readonly numChildren

numChildren: number

Accessors

ArrayType

get ArrayType(): T["ArrayType"]

- Defined in vector/base.ts:58
Returns T["ArrayType"]

VectorName

get VectorName(): string

- Defined in vector/base.ts:56
Returns string

[Symbol.toStringTag]

get [Symbol.toStringTag](): string

- Defined in vector/base.ts:65
Returns string

byteLength

get byteLength(): number

- Defined in vector/base.ts:55
Returns number

dictionaries

get dictionaries(): Map<number, Vector<any>>

- Defined in recordbatch.ts:97
Returns Map<number, Vector<any>>

length

get length(): number

- Defined in vector/base.ts:51
Returns number

nullBitmap

get nullBitmap(): Uint8Array

- Defined in vector/base.ts:62
Returns Uint8Array

nullCount

get nullCount(): number

- Defined in vector/base.ts:54
Returns number

numCols

get numCols(): number

- Defined in recordbatch.ts:96
Returns number

offset

get offset(): number

- Defined in vector/base.ts:52
Returns number

schema

get schema(): Schema<any>

- Defined in recordbatch.ts:95
Returns Schema<any>

stride

get stride(): number

- Defined in vector/base.ts:53
Returns number

type

get type(): T

- Defined in vector/base.ts:49
Returns T

typeId

get typeId(): T["TType"]

- Defined in vector/base.ts:50
Returns T["TType"]

typeIds

get typeIds(): T["TArray"]

- Defined in vector/base.ts:61
Returns T["TArray"]

valueOffsets

get valueOffsets(): Int32Array

- Defined in vector/base.ts:63
Returns Int32Array

values

get values(): T["TArray"]

- Defined in vector/base.ts:60
Returns T["TArray"]

Methods

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<null | RowLike<T>>

- Defined in vector/index.ts:77
Returns IterableIterator<null | RowLike<T>>

bind

bind(index: number): RowLike<T>

- Defined in vector/struct.ts:26
Parameters
- index: number
Returns RowLike<T>

clone

clone(data: Data<Struct<T>>, children?: Vector<any>[]): RecordBatch<T>
clone(data: Data<Struct<T>>, children?: undefined | Vector<any>[]): RecordBatch<T>

- Defined in recordbatch.ts:38
Parameters
- data: Data<Struct<T>>
- Optional children: Vector<any>[]
Returns RecordBatch<T>
- Defined in recordbatch.ts:86
Parameters
- data: Data<Struct<T>>
- children: undefined | Vector<any>[] = ...
Returns RecordBatch<T>

concat

concat(...others: Vector<Struct<T>>[]): Table<T>
concat(...others: Vector<Struct<T>>[]): Table<T>

- Defined in recordbatch.ts:36
Parameters
- Rest ...others: Vector<Struct<T>>[]
Returns Table<T>
- Defined in recordbatch.ts:90
Parameters
- Rest ...others: Vector<Struct<T>>[]
Returns Table<T>

get

get(index: number): null | RowLike<T>

- Defined in vector/index.ts:72
Parameters
- index: number
Returns null | RowLike<T>

getByteWidth

getByteWidth(): number

- Defined in vector/index.ts:76
Returns number

getChildAt

getChildAt<R>(index: number): null | Vector<R>

- Defined in vector/base.ts:92
Type parameters
- R: DataType<Type, any, R> = any
Parameters
- index: number
Returns null | Vector<R>

indexOf

indexOf(value: null | RowLike<T>, fromIndex?: number): number

- Defined in vector/index.ts:74
Parameters
- value: null | RowLike<T>
- Optional fromIndex: number
Returns number

isValid

isValid(index: number): boolean

- Defined in vector/base.ts:82
Parameters
- index: number
Returns boolean

select

select<K>(...columnNames: K[]): RecordBatch<{}>

- Defined in recordbatch.ts:101
Type parameters
- K: string | number | symbol = any
Parameters
- Rest ...columnNames: K[]
Returns RecordBatch<{}>

selectAt

selectAt<K>(...columnIndices: number[]): RecordBatch<{}>

- Defined in recordbatch.ts:105
Type parameters
- K: DataType<Type, any, K> = any
Parameters
- Rest ...columnIndices: number[]
Returns RecordBatch<{}>

set

set(index: number, value: null | RowLike<T>): void

- Defined in vector/index.ts:73
Parameters
- index: number
- value: null | RowLike<T>
Returns void

slice

slice(begin?: number, end?: number): RecordBatch<T>

- Defined in recordbatch.ts:37
Parameters
- Optional begin: number
- Optional end: number
Returns RecordBatch<T>

toArray

toArray(): IterableArrayLike<RowLike<T>>

- Defined in vector/index.ts:75
Returns IterableArrayLike<RowLike<T>>

toJSON

toJSON(): (null | RowLike<T>)[]

- Defined in vector/base.ts:99
Returns (null | RowLike<T>)[]

Static from

from<T, TNull>(options: VectorBuilderOptions<Struct<T>, TNull>): Table<T>
from<T, TNull>(options: VectorBuilderOptionsAsync<Struct<T>, TNull>): Promise<Table<T>>

- Defined in recordbatch.ts:47
Type parameters
- T: {} = any
- TNull = any
Parameters
- options: VectorBuilderOptions<Struct<T>, TNull>
Returns Table<T>
- Defined in recordbatch.ts:48
Type parameters
- T: {} = any
- TNull = any
Parameters
- options: VectorBuilderOptionsAsync<Struct<T>, TNull>
Returns Promise<Table<T>>

Static new

new<T>(children: T): RecordBatch<{[ P in string | number | symbol]: T[P]["type"] }>
new<T>(children: ChildData<T>, fields?: keyof T[] | Field<T[keyof T]>[]): RecordBatch<T>

- Defined in recordbatch.ts:57
Type parameters
- T: VectorMap = any
Parameters
- children: T
Returns RecordBatch<{[ P in string | number | symbol]: T[P]["type"] }>
- Defined in recordbatch.ts:58
Type parameters
- T: {} = any
Parameters
- children: ChildData<T>
- Optional fields: keyof T[] | Field<T[keyof T]>[]
Returns RecordBatch<T>

Generated using TypeDoc