Class RecordBatch

constructor

• new RecordBatch(): RecordBatch

• Returns RecordBatch

Readonly numColumns

Readonly numRows

Readonly schema

free

• free(): void

• Returns void

getArrayMemorySize

• getArrayMemorySize(): number

• Returns the total number of bytes of memory occupied physically by this batch.

  Returns number

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 FFIRecordBatch.

  Returns FFIRecordBatch

intoIPCStream

• intoIPCStream(): Uint8Array

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

  Returns Uint8Array

slice

• slice(offset, length): RecordBatch

• Return a new RecordBatch where each column is sliced according to offset and length

  Parameters

  • offset: number
  • length: number

  Returns RecordBatch

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

withSchema

• withSchema(schema): RecordBatch

• Override the schema of this [RecordBatch]

  Returns an error if schema is not a superset of the current schema as determined by [Schema::contains]

  Parameters

  • schema: Schema

  Returns RecordBatch