Class Table<T>

Tables are collections of Vectors and have a Schema. Use the convenience methods makeTable or tableFromArrays to create a table in JavaScript. To create a table from the IPC format, use tableFromIPC.

Type Parameters

T extends TypeMap = any

Hierarchy

Table

Index

Constructors

constructor

new Table<T>(): Table<T>
Type Parameters
- T extends TypeMap = any
Returns Table<T>
- Defined in table.ts:71
new Table<T>(batches): Table<T>
Type Parameters
- T extends TypeMap = any
Parameters
- batches: Iterable<RecordBatch<T>>
Returns Table<T>
- Defined in table.ts:72
new Table<T>(...batches): Table<T>
Type Parameters
- T extends TypeMap = any
Parameters
- Rest ...batches: readonly RecordBatch<T>[]
Returns Table<T>
- Defined in table.ts:73
new Table<T>(...columns): Table<T>
Type Parameters
- T extends TypeMap = any
Parameters
- Rest ...columns: {
  [P in string | number | symbol]: Vector<T[P]>
  }[]
Returns Table<T>
- Defined in table.ts:74
new Table<T>(...columns): Table<T>
Type Parameters
- T extends TypeMap = any
Parameters
- Rest ...columns: {
  [P in string | number | symbol]: Data<T[P]> | DataProps<T[P]>
  }[]
Returns Table<T>
- Defined in table.ts:75
new Table<T>(schema, data?): Table<T>
Type Parameters
- T extends TypeMap = any
Parameters
- schema: Schema<T>
- Optional data: RecordBatch<T> | RecordBatch<T>[]
Returns Table<T>
- Defined in table.ts:76
new Table<T>(schema, data?, offsets?): Table<T>
Type Parameters
- T extends TypeMap = any
Parameters
- schema: Schema<T>
- Optional data: RecordBatch<T> | RecordBatch<T>[]
- Optional offsets: Uint32Array
Returns Table<T>
- Defined in table.ts:77

Properties

`Readonly` TArray

TArray: StructRowProxy<T>[]

`Readonly` TType

TType: Struct<T>

`Readonly` TValue

TValue: StructRowProxy<T>

[isConcatSpreadable]

[isConcatSpreadable]: true

See

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

`Readonly` batches

batches: RecordBatch<T>[]

The contiguous RecordBatch RecordBatch chunks of the Table rows.

`Readonly` schema

schema: Schema<T>

Accessors

data

get data(): Data<Struct<T>>[]
The contiguous RecordBatch RecordBatch chunks of the Table rows.

Returns Data<Struct<T>>[]
- Defined in table.ts:158

nullCount

get nullCount(): number
The number of null rows in this Table.

Returns number
- Defined in table.ts:175

numCols

get numCols(): number
The number of columns in this Table.

Returns number
- Defined in table.ts:163

numRows

get numRows(): number
The number of rows in this Table.

Returns number
- Defined in table.ts:168

Methods

[iterator]

[iterator](): IterableIterator<any>
Iterator for rows in this Table.

Returns IterableIterator<any>
- Defined in table.ts:226

assign

assign<R>(other): Table<T & R>
Type Parameters
- R extends TypeMap = any
Parameters
- other: Table<R>
Returns Table<T & R>
- Defined in table.ts:359

concat

concat(...others): Table<T>
Combines two or more Tables of the same schema.
Parameters
- Rest ...others: Table<T>[]
  
  Additional Tables to add to the end of this Tables.
Returns Table<T>
- Defined in table.ts:256

get

get(index): null | StructRowProxy<T>
Get an element value by position.
Parameters
- index: number
  
  The index of the element to read.
Returns null | StructRowProxy<T>
- Defined in table.ts:196

getByteLength

getByteLength(index): number
Get the size in bytes of an element by index.
Parameters
- index: number
  
  The index at which to get the byteLength.
Returns number
- Defined in table.ts:221

getChild

getChild<P>(name): null | Vector<T[P]>
Returns a child Vector by name, or null if this Vector has no child with the given name.
Type Parameters
- P extends string | number | symbol
Parameters
- name: P
  
  The name of the child to retrieve.
Returns null | Vector<T[P]>
- Defined in table.ts:280

getChildAt

getChildAt<R>(index): null | Vector<R>
Returns a child Vector by index, or null if this Vector has no child at the supplied index.
Type Parameters
- R extends DataType<Type, any, R> = any
Parameters
- index: number
  
  The index of the child to retrieve.
Returns null | Vector<R>
- Defined in table.ts:289

indexOf

indexOf(element, offset?): number
Retrieve the index of the first occurrence of a value in an Vector.
Parameters
- element: StructRowProxy<T>
  
  The value to locate in the Vector.
- Optional offset: number
  
  The index at which to begin the search. If offset is omitted, the search starts at index 0.
Returns number
- Defined in table.ts:214

isValid

isValid(index): boolean
Check whether an element is null.
Parameters
- index: number
  
  The index at which to read the validity bitmap.
Returns boolean
- Defined in table.ts:188

select

select<K>(columnNames): Table<{
[key: string]: K;
}>
Construct a new Table containing only specified columns.
Type Parameters
- K extends string | number | symbol = any
Parameters
- columnNames: K[]
  
  Names of columns to keep.
Returns Table<{
[key: string]: K;
}>
A new Table of columns matching the specified names.
- Defined in table.ts:342

selectAt

selectAt<K>(columnIndices): Table<{
[key: string]: K;
}>
Construct a new Table containing only columns at the specified indices.
Type Parameters
- K extends DataType<Type, any, K> = any
Parameters
- columnIndices: number[]
  
  Indices of columns to keep.
Returns Table<{
[key: string]: K;
}>
A new Table of columns at the specified indices.
- Defined in table.ts:353

set

set(index, value): void
Set an element value by position.
Parameters
- index: number
  
  The index of the element to write.
- value: null | StructRowProxy<T>
  
  The value to set.
Returns void
- Defined in table.ts:205

setChild

setChild<P, R>(name, child): Table<T & {
[K in string | number | symbol]: R
}>
Sets a child Vector by name.
Type Parameters
- P extends string | number | symbol
- R extends DataType<Type, any, R>
Parameters
- name: P
  
  The name of the child to overwrite.
- child: Vector<R>
Returns Table<T & {
[K in string | number | symbol]: R
}>
A new Table with the supplied child for the specified name.
- Defined in table.ts:308

setChildAt

setChildAt(index, child?): Table<any>
Sets a child Vector by index.
Parameters
- index: number
  
  The index of the child to overwrite.
- Optional child: null
Returns Table<any>
A new Table with the supplied child at the specified index.
- Defined in table.ts:318
setChildAt<R>(index, child): Table<any>
Type Parameters
- R extends DataType<Type, any, R> = any
Parameters
- index: number
- child: Vector<R>
Returns Table<any>
- Defined in table.ts:319

slice

slice(begin?, end?): Table<T>
Return a zero-copy sub-section of this Table.
Parameters
- Optional begin: number
  
  The beginning of the specified portion of the Table.
- Optional end: number
  
  The end of the specified portion of the Table. This is exclusive of the element at the index 'end'.
Returns Table<T>
- Defined in table.ts:268

toArray

toArray(): any[]
Return a JavaScript Array of the Table rows.

Returns any[]
An Array of Table rows.
- Defined in table.ts:238

toString

toString(): string
Returns a string representation of the Table rows.

Returns string
A string representation of the Table rows.
- Defined in table.ts:247

Class Table<T>

Type Parameters

T extends TypeMap = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends TypeMap = any

Returns Table<T>

Type Parameters

T extends TypeMap = any

Parameters

batches: Iterable<RecordBatch<T>>

Returns Table<T>

Type Parameters

T extends TypeMap = any

Parameters

Rest ...batches: readonly RecordBatch<T>[]

Returns Table<T>

Type Parameters

T extends TypeMap = any

Parameters

Rest ...columns: { [P in string | number | symbol]: Vector<T[P]>}[]

Returns Table<T>

Type Parameters

T extends TypeMap = any

Parameters

Rest ...columns: { [P in string | number | symbol]: Data<T[P]> | DataProps<T[P]>}[]

Returns Table<T>

Type Parameters

T extends TypeMap = any

Parameters

schema: Schema<T>

Optional data: RecordBatch<T> | RecordBatch<T>[]

Returns Table<T>

Type Parameters

T extends TypeMap = any

Parameters

schema: Schema<T>

Optional data: RecordBatch<T> | RecordBatch<T>[]

Optional offsets: Uint32Array

Returns Table<T>

Properties

Readonly TArray

Readonly TType

Readonly TValue

[isConcatSpreadable]

See

Readonly batches

Readonly schema

Accessors

data

Returns Data<Struct<T>>[]

nullCount

Returns number

numCols

Returns number

numRows

Returns number

Methods

[iterator]

Returns IterableIterator<any>

assign

Type Parameters

R extends TypeMap = any

Parameters

other: Table<R>

Returns Table<T & R>

concat

Parameters

Rest ...others: Table<T>[]

Returns Table<T>

get

Parameters

index: number

`Rest` ...batches: readonly RecordBatch<T>[]

`Rest` ...columns: {
[P in string | number | symbol]: Vector<T[P]>
}[]

`Rest` ...columns: {
[P in string | number | symbol]: Data<T[P]> | DataProps<T[P]>
}[]

`Optional` data: RecordBatch<T> | RecordBatch<T>[]

`Optional` data: RecordBatch<T> | RecordBatch<T>[]

`Optional` offsets: Uint32Array

`Readonly` TArray

`Readonly` TType

`Readonly` TValue

`Readonly` batches

`Readonly` schema

`Rest` ...others: Table<T>[]

`Optional` offset: number

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

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

Returns Table<T & {
[K in string | number | symbol]: R
}>

`Optional` child: null

`Optional` begin: number

`Optional` end: number