Serialization and IPC#

Inter-Process Communication#

ipc.new_file(sink, schema, *[, ...])

Create an Arrow columnar IPC file writer instance

ipc.open_file(source[, footer_offset, ...])

Create reader for Arrow file format.

ipc.new_stream(sink, schema, *[, ...])

Create an Arrow columnar IPC stream writer instance

ipc.open_stream(source, *[, options, ...])

Create reader for Arrow streaming format.


Read length-prefixed message from file or buffer-like object

ipc.read_record_batch(obj, Schema schema, ...)

Read RecordBatch from message, given a known schema.

ipc.get_record_batch_size(RecordBatch batch)

Return total size of serialized RecordBatch including metadata and padding.


Read pyarrow.Tensor from pyarrow.NativeFile object from current position.

ipc.write_tensor(Tensor tensor, NativeFile dest)

Write pyarrow.Tensor to pyarrow.NativeFile object its current position.

ipc.get_tensor_size(Tensor tensor)

Return total size of serialized Tensor including metadata and padding.


Serialization options for reading IPC format.

ipc.IpcWriteOptions([metadata_version, ...])

Serialization options for the IPC format.


Container for an Arrow IPC message with metadata and optional body


Interface for reading Message objects from some source (like an InputStream)

ipc.RecordBatchFileReader(source[, ...])

Class for reading Arrow record batch data from the Arrow binary file format

ipc.RecordBatchFileWriter(sink, schema, *[, ...])

Writer to create the Arrow binary file format

ipc.RecordBatchStreamReader(source, *[, ...])

Reader for the Arrow streaming binary format.

ipc.RecordBatchStreamWriter(sink, schema, *)

Writer for the Arrow streaming binary format