pyarrow.ipc.Message

class pyarrow.ipc.Message

Bases: pyarrow.lib._Weakrefable

Container for an Arrow IPC message with metadata and optional body

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(*args, **kwargs)	Initialize self.
equals(self, Message other)	Returns True if the message contents (metadata and body) are identical
serialize(self[, alignment, memory_pool])	Write message as encapsulated IPC message
serialize_to(self, NativeFile sink[, …])	Write message to generic OutputStream

Attributes

body
metadata
metadata_version
type

body

equals(self, Message other)

Returns True if the message contents (metadata and body) are identical

Parameters

other (Message) –

Returns

are_equal (bool)

metadata

metadata_version

serialize(self, alignment=8, memory_pool=None)

Write message as encapsulated IPC message

Parameters

• alignment (int, default 8) – Byte alignment for metadata and body

• memory_pool (MemoryPool, default None) – Uses default memory pool if not specified

Returns

serialized (Buffer)

serialize_to(self, NativeFile sink, alignment=8, memory_pool=None)

Write message to generic OutputStream

Parameters

• sink (NativeFile) –

• alignment (int, default 8) – Byte alignment for metadata and body

• memory_pool (MemoryPool, default None) – Uses default memory pool if not specified

type