Class RecordBatch

constructor

• new RecordBatch(): RecordBatch

• Returns RecordBatch

Readonly numColumns

Readonly numRows

Readonly schema

column

• column(index): Vector

• Get a column's vector by index.

  Parameters

  • index: number

  Returns Vector

column_by_name

• column_by_name(name): Vector

• Get a column's vector by name

  Parameters

  • name: string

  Returns Vector

free

• free(): void

• Returns void

intoFFI

• intoFFI(): FFIRecordBatch

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

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

  Returns FFIRecordBatch

intoIPCStream

• intoIPCStream(): Uint8Array

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

  Returns Uint8Array

toFFI

• toFFI(): FFIRecordBatch

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

  This method does not consume the RecordBatch, so you must remember to call RecordBatch.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 FFIRecordBatch