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)#

Methods

__init__(*args, **kwargs)

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
otherMessage
Returns
are_equalbool
metadata#
metadata_version#
serialize(self, alignment=8, memory_pool=None)#

Write message as encapsulated IPC message

Parameters
alignmentint, default 8

Byte alignment for metadata and body

memory_poolMemoryPool, default None

Uses default memory pool if not specified

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

Write message to generic OutputStream

Parameters
sinkNativeFile
alignmentint, default 8

Byte alignment for metadata and body

memory_poolMemoryPool, default None

Uses default memory pool if not specified

type#