Class ArrowTable<T>

constructor

• new ArrowTable<T extends TypeMap = TypeMap>(
      schema: Schema,
      children: Column<any>[],
      useProxy?: boolean,
  ): ArrowTable<T>

  Create a new table with the given schema and columns (children).

  Type Parameters

  • T extends TypeMap = TypeMap

  Parameters

  • schema: Schema

    The table schema.

  • children: Column<any>[]

    The table columns.

  • OptionaluseProxy: boolean

    Flag indicating if row proxy objects should be used to represent table rows (default false).

  Returns ArrowTable<T>

Readonlychildren

Readonlyfactory

Readonlynames

Readonlyschema

[toStringTag]

• get "[toStringTag]"(): string

  Provide an informative object string tag.

  Returns string

numCols

• get numCols(): number

  The number of columns in this table.

  Returns number

  The number of columns.

numRows

• get numRows(): number

  The number of rows in this table.

  Returns number

  The number of rows.

[iterator]

• "[iterator]"(): Generator<{ [P in string | number | symbol]: T[P] }, any, any>

  Return an iterator over objects representing the rows of this table.

  Returns Generator<{ [P in string | number | symbol]: T[P] }, any, any>

at

• at(index: number): { [P in string | number | symbol]: T[P] }

  Return a row object for the given index.

  Parameters

  • index: number

    The row index.

  Returns { [P in string | number | symbol]: T[P] }

  The row object.

get

• get(index: number): { [P in string | number | symbol]: T[P] }

  Return a row object for the given index. This method is the same as at() and is provided for better compatibility with Apache Arrow JS.

  Parameters

  • index: number

    The row index.

  Returns { [P in string | number | symbol]: T[P] }

  The row object.

getChild

• getChild<P extends string | number | symbol>(name: P): Column<T[P]>

  Return the first child column with the given name.

  Type Parameters

  • P extends string | number | symbol

  Parameters

  • name: P

    The column name.

  Returns Column<T[P]>

getChildAt

• getChildAt<R extends any>(index: number): Column<R>

  Return the child column at the given index position.

  Type Parameters

  • R extends any

  Parameters

  • index: number

    The column index.

  Returns Column<R>

select

• select<K extends string | number | symbol>(
      names: K[],
      as?: string[],
  ): ArrowTable<{ [key: string]: T[keyof T] }>

  Construct a new table containing only columns with the specified names. If columns have duplicate names, the first (with lowest index) is used. The order of columns in the new table matches the order of input names.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • names: K[]

    Names of columns to keep.

  • Optionalas: string[]

    Optional new names for selected columns.

  Returns ArrowTable<{ [key: string]: T[keyof T] }>

  A new table with columns matching the specified names.

selectAt

• selectAt<V extends any>(
      indices: number[],
      as?: string[],
  ): ArrowTable<{ [key: string]: V }>

  Construct a new table containing only columns at the specified indices. The order of columns in the new table matches the order of input indices.

  Type Parameters

  • V extends any

  Parameters

  • indices: number[]

    The indices of columns to keep.

  • Optionalas: string[]

    Optional new names for selected columns.

  Returns ArrowTable<{ [key: string]: V }>

  A new table with selected columns.

toArray

• toArray(): { [P in string | number | symbol]: T[P] }[]

  Return an array of objects representing the rows of this table.

  Returns { [P in string | number | symbol]: T[P] }[]

toColumns

• toColumns(): { [P in string | number | symbol]: ValueArray<T[P]> }

  Return an object mapping column names to extracted value arrays.

  Returns { [P in string | number | symbol]: ValueArray<T[P]> }