Class FFIRecordBatch

A representation of an Arrow RecordBatch in WebAssembly memory exposed as FFI-compatible structs through the Arrow C Data Interface.

Hierarchy

  • FFIRecordBatch

Constructors

Methods

Constructors

Methods

  • Access the pointer to the ArrowArray struct. This can be viewed or copied (without serialization) to an Arrow JS RecordBatch by using arrow-js-ffi. You can access the WebAssembly.Memory instance by using wasmMemory.

    Example:

    import { parseRecordBatch } from "arrow-js-ffi";

    const wasmRecordBatch: FFIRecordBatch = ...
    const wasmMemory: WebAssembly.Memory = wasmMemory();

    // Pass `true` to copy arrays across the boundary instead of creating views.
    const jsRecordBatch = parseRecordBatch(
    wasmMemory.buffer,
    wasmRecordBatch.arrayAddr(),
    wasmRecordBatch.schemaAddr(),
    true
    );

    Returns number

  • Returns void

  • Access the pointer to the ArrowSchema struct. This can be viewed or copied (without serialization) to an Arrow JS Field by using arrow-js-ffi. You can access the WebAssembly.Memory instance by using wasmMemory.

    Example:

    import { parseRecordBatch } from "arrow-js-ffi";

    const wasmRecordBatch: FFIRecordBatch = ...
    const wasmMemory: WebAssembly.Memory = wasmMemory();

    // Pass `true` to copy arrays across the boundary instead of creating views.
    const jsRecordBatch = parseRecordBatch(
    wasmMemory.buffer,
    wasmRecordBatch.arrayAddr(),
    wasmRecordBatch.schemaAddr(),
    true
    );

    Returns number

Generated using TypeDoc