pyarrow.ipc.IpcWriteOptions#

classpyarrow.ipc.IpcWriteOptions(metadata_version=MetadataVersion.V5,*,boolallow_64bit=False,use_legacy_format=False,compression=None,booluse_threads=True,boolemit_dictionary_deltas=False,boolunify_dictionaries=False)#

Bases:_Weakrefable

Serialization options for the IPC format.

Parameters:
metadata_versionMetadataVersion, defaultMetadataVersion.V5

The metadata version to write. V5 is the current and latest,V4 is the pre-1.0 metadata version (with incompatible Union layout).

allow_64bitbool, defaultFalse

If true, allow field lengths that don’t fit in a signed 32-bit int.

use_legacy_formatbool, defaultFalse

Whether to use the pre-Arrow 0.15 IPC format.

compressionstr,Codec, orNone

compression codec to use for record batch buffers.If None then batch buffers will be uncompressed.Must be “lz4”, “zstd” or None.To specify a compression_level usepyarrow.Codec

use_threadsbool

Whether to use the global CPU thread pool to parallelize anycomputational tasks like compression.

emit_dictionary_deltasbool

Whether to emit dictionary deltas. Default is false for maximumstream compatibility.

unify_dictionariesbool

If true then calls to write_table will attempt to unify dictionariesacross all batches in the table. This can help avoid the need forreplacement dictionaries (which the file format does not support)but requires computing the unified dictionary and then remappingthe indices arrays.

This parameter is ignored when writing to the IPC stream format asthe IPC stream format can support replacement dictionaries.

__init__(*args,**kwargs)#

Methods

__init__(*args, **kwargs)

Attributes

allow_64bit#
compression#
emit_dictionary_deltas#
metadata_version#
unify_dictionaries#
use_legacy_format#
use_threads#