Interface: TypedArrowTable\<TRow\>

Typed Arrow Table - preserves row type information for type inference. At runtime this is just a regular Arrow Table, but TypeScript knows the row schema.

Example

type MyTable = TypedArrowTable<{ id: string; value: number }>;
// Can access table.getChild("id") knowing it exists

Extends

Table

Type Parameters

TRow

TRow extends Record<string, unknown> = Record<string, unknown>

Properties

__rowType?

readonly optional __rowType?: TRow

Phantom type marker for row schema. Not used at runtime - only for TypeScript type inference.

_nullCount

protected _nullCount: number

Inherited from

Table._nullCount

_offsets

protected _offsets: Uint32Array<ArrayBufferLike> | number[]

Inherited from

Table._offsets

[isConcatSpreadable]

[isConcatSpreadable]: true

See

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/isConcatSpreadable

Inherited from

Table.[isConcatSpreadable]

batches

readonly batches: RecordBatch<any>[]

The contiguous RecordBatch `RecordBatch` chunks of the Table rows.

Inherited from

Table.batches

schema

readonly schema: Schema<any>

Inherited from

Table.schema

TArray

readonly TArray: StructRowProxy<any>[]

Inherited from

Table.TArray

TType

readonly TType: Struct<any>

Inherited from

Table.TType

TValue

readonly TValue: StructRowProxy<any>

Inherited from

Table.TValue

Accessors

data

Get Signature

get data(): Data<Struct<T>>[]

The contiguous RecordBatch `RecordBatch` chunks of the Table rows.

Returns

Data<Struct<T>>[]

Inherited from

Table.data

nullCount

Get Signature

get nullCount(): number

The number of null rows in this Table.

Returns

number

Inherited from

Table.nullCount

numCols

Get Signature

get numCols(): number

The number of columns in this Table.

Returns

number

Inherited from

Table.numCols

numRows

Get Signature

get numRows(): number

The number of rows in this Table.

Returns

number

Inherited from

Table.numRows

Methods

[iterator]()

[iterator](): IterableIterator<any>

Iterator for rows in this Table.

Returns

IterableIterator<any>

Inherited from

Table.[iterator]

assign()

assign<R>(other): Table<any>

Type Parameters

R

R extends TypeMap = any

Parameters

other

Table<R>

Returns

Table<any>

Inherited from

Table.assign

at()

at(index): StructRowProxy<any> | null

Get an element value by position.

Parameters

index

number

The index of the element to read. A negative index will count back from the last element.

Returns

StructRowProxy<any> | null

Inherited from

Table.at

concat()

concat(…others): Table<any>

Combines two or more Tables of the same schema.

Parameters

others

…Table<any>[]

Additional Tables to add to the end of this Tables.

Returns

Table<any>

Inherited from

Table.concat

get()

get(index): StructRowProxy<any> | null

Get an element value by position.

Parameters

index

number

The index of the element to read.

Returns

StructRowProxy<any> | null

Inherited from

Table.get

getChild()

getChild<P>(name): Vector<any> | null

Returns a child Vector by name, or null if this Vector has no child with the given name.

Type Parameters

P

P extends string | number | symbol

Parameters

name

P

The name of the child to retrieve.

Returns

Vector<any> | null

Inherited from

Table.getChild

getChildAt()

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

Returns a child Vector by index, or null if this Vector has no child at the supplied index.

Type Parameters

R

R extends any = any

Parameters

index

number

The index of the child to retrieve.

Returns

Vector<R> | null

Inherited from

Table.getChildAt

indexOf()

indexOf(element, offset?): number

Retrieve the index of the first occurrence of a value in an Vector.

Parameters

element

StructRowProxy<any>

The value to locate in the Vector.

offset?

number

The index at which to begin the search. If offset is omitted, the search starts at index 0.

Returns

number

Inherited from

Table.indexOf

isValid()

isValid(index): boolean

Check whether an element is null.

Parameters

index

number

The index at which to read the validity bitmap.

Returns

boolean

Inherited from

Table.isValid

select()

select<K>(columnNames): Table<{[key: string]: any; }>

Construct a new Table containing only specified columns.

Type Parameters

K

K extends string | number | symbol = any

Parameters

columnNames

K[]

Names of columns to keep.

Returns

Table<{[key: string]: any; }>

A new Table of columns matching the specified names.

Inherited from

Table.select

selectAt()

selectAt<K>(columnIndices): Table<{[key: string]: K; }>

Construct a new Table containing only columns at the specified indices.

Type Parameters

K

K extends any = any

Parameters

columnIndices

number[]

Indices of columns to keep.

Returns

Table<{[key: string]: K; }>

A new Table of columns at the specified indices.

Inherited from

Table.selectAt

set()

set(index, value): void

Set an element value by position.

Parameters

index

number

The index of the element to write.

value

StructRowProxy<any> | null

The value to set.

Returns

void

Inherited from

Table.set

setChild()

setChild<P, R>(name, child): Table<any>

Sets a child Vector by name.

Type Parameters

P

P extends string | number | symbol

R

R extends DataType<Type, any>

Parameters

name

P

The name of the child to overwrite.

child

Vector<R>

Returns

Table<any>

A new Table with the supplied child for the specified name.

Inherited from

Table.setChild

setChildAt()

Call Signature

setChildAt(index, child?): Table

Sets a child Vector by index.

Parameters

index

number

The index of the child to overwrite.

child?

null

Returns

Table

A new Table with the supplied child at the specified index.

Inherited from

Table.setChildAt

Call Signature

setChildAt<R>(index, child): Table

Sets a child Vector by index.

Type Parameters

R

R extends DataType<Type, any> = any

Parameters

index

number

The index of the child to overwrite.

child

Vector<R>

Returns

Table

A new Table with the supplied child at the specified index.

Inherited from

Table.setChildAt

slice()

slice(begin?, end?): Table<any>

Return a zero-copy sub-section of this Table.

Parameters

begin?

number

The beginning of the specified portion of the Table.

end?

number

The end of the specified portion of the Table. This is exclusive of the element at the index ‘end’.

Returns

Table<any>

Inherited from

Table.slice

toArray()

toArray(): any[]

Return a JavaScript Array of the Table rows.

Returns

any[]

An Array of Table rows.

Inherited from

Table.toArray

toString()

toString(): string

Returns a string representation of the Table rows.

Returns

string

A string representation of the Table rows.

Inherited from

Table.toString