pyarrow.ipc.new_stream

pyarrow.ipc.new_stream(sink, schema, *, use_legacy_format=None, options=None)[source]

Create an Arrow columnar IPC stream writer instance

Parameters:
sinkstr, pyarrow.NativeFile, or file-like Python object

Either a file path, or a writable file object.

schemapyarrow.Schema

The Arrow schema for data to be written to the file.

use_legacy_formatbool, default None

Deprecated in favor of setting options. Cannot be provided with options.

If None, False will be used unless this default is overridden by setting the environment variable ARROW_PRE_0_15_IPC_FORMAT=1

optionspyarrow.ipc.IpcWriteOptions

Options for IPC serialization.

If None, default values will be used: the legacy format will not be used unless overridden by setting the environment variable ARROW_PRE_0_15_IPC_FORMAT=1, and the V5 metadata version will be used unless overridden by setting the environment variable ARROW_PRE_1_0_METADATA_VERSION=1.

Returns:
writerRecordBatchStreamWriter