Arrow IPC¶

arro3.io.read_ipc ¶

read_ipc(file: IO[bytes] | Path | str) -> RecordBatchReader

Read an Arrow IPC file into memory

Parameters:

file (IO[bytes] | Path | str) –

The input Arrow IPC file path or buffer.

Returns:

RecordBatchReader –

An arrow RecordBatchReader.

arro3.io.read_ipc_stream ¶

read_ipc_stream(file: IO[bytes] | Path | str) -> RecordBatchReader

Read an Arrow IPC stream into memory

Parameters:

file (IO[bytes] | Path | str) –

The input Arrow IPC stream path or buffer.

Returns:

RecordBatchReader –

An arrow RecordBatchReader.

arro3.io.write_ipc ¶

write_ipc(
    data: ArrowStreamExportable | ArrowArrayExportable,
    file: IO[bytes] | Path | str,
    *,
    compression: Literal["LZ4", "lz4", "ZSTD", "zstd"] | None = None
) -> None

Write Arrow data to an Arrow IPC file

Parameters:

data (ArrowStreamExportable | ArrowArrayExportable) –

the Arrow Table, RecordBatchReader, or RecordBatch to write.
file (IO[bytes] | Path | str) –

the output file or buffer to write to

Other Parameters:

compression (Literal['LZ4', 'lz4', 'ZSTD', 'zstd'] | None) –

Compression to apply to file.

arro3.io.write_ipc_stream ¶

write_ipc_stream(
    data: ArrowStreamExportable | ArrowArrayExportable,
    file: IO[bytes] | Path | str,
    *,
    compression: Literal["LZ4", "lz4", "ZSTD", "zstd"] | None = None
) -> None

Write Arrow data to an Arrow IPC stream

Parameters:

data (ArrowStreamExportable | ArrowArrayExportable) –

the Arrow Table, RecordBatchReader, or RecordBatch to write.
file (IO[bytes] | Path | str) –

the output file or buffer to write to

Other Parameters:

compression (Literal['LZ4', 'lz4', 'ZSTD', 'zstd'] | None) –

Compression to apply to file.