Class Table

constructor

• new Table(): Table

• Returns Table

Readonly numBatches

Readonly schema

free

• free(): void

• Returns void

intoFFI

• intoFFI(): FFITable

• Export this Table to FFI structs according to the Arrow C Data Interface.

  This method does consume the Table, so the original Table will be inaccessible after this call. You must still call FFITable.free after you've finished using the FFITable.

  Returns FFITable

intoIPCStream

• intoIPCStream(): Uint8Array

• Consume this table and convert to an Arrow IPC Stream buffer

  Returns Uint8Array

recordBatch

• recordBatch(index): RecordBatch

• Access a RecordBatch from the Table by index.

  Parameters

  • index: number

    The positional index of the RecordBatch to retrieve.

  Returns RecordBatch

  a RecordBatch or null if out of range.

toFFI

• toFFI(): FFITable

• Export this Table to FFI structs according to the Arrow C Data Interface.

  This method does not consume the Table, so you must remember to call Table.free to release the resources. The underlying arrays are reference counted, so this method does not copy data, it only prevents the data from being released.

  Returns FFITable

Static fromIPCFile

• fromIPCFile(buf): Table

• Create a table from an Arrow IPC File buffer

  Parameters

  • buf: Uint8Array

  Returns Table

Static fromIPCStream

• fromIPCStream(buf): Table

• Create a table from an Arrow IPC Stream buffer

  Parameters

  • buf: Uint8Array

  Returns Table