pyarrow.ipc.IpcReadOptions

class pyarrow.ipc.IpcReadOptions(bool ensure_native_endian=True, *, Alignment ensure_alignment=Alignment.Any, bool use_threads=True, list included_fields=None)

Bases: _Weakrefable

Serialization options for reading IPC format.

Parameters:

ensure_native_endianbool, default True

Whether to convert incoming data to platform-native endianness.

ensure_alignmentAlignment, default Alignment.Any

Data is copied to aligned memory locations if mis-aligned. Some use cases might require data to have a specific alignment, for example, for the data buffer of an int32 array to be aligned on a 4-byte boundary.

use_threadsbool

Whether to use the global CPU thread pool to parallelize any computational tasks like decompression

included_fieldslist

If empty (the default), return all deserialized fields. If non-empty, the values are the indices of fields to read on the top-level schema

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

Attributes

ensure_alignment
ensure_native_endian
included_fields
use_threads

ensure_alignment

ensure_native_endian

included_fields

use_threads