Skip to main content

Module frame

Module frame 

Source
Expand description

Frames: a 4-byte big-endian length, then that many bytes. The first body byte is the frame type: J (0x4A) for a UTF-8 JSON control message, A (0x41) for an Arrow IPC stream holding a schema and zero or more record batches.

Enums§

Frame
FrameError

Constants§

ARROW_TAG
JSON_TAG
MAX_FRAME
Largest frame body accepted: 1 GiB. Larger result sets are split across batches.

Functions§

decode_batches
Decode an Arrow frame into its schema and batches.
encode_batch
Encode one batch as a self-contained Arrow IPC stream (schema + batch).
read_frame
write_arrow
write_json