Skip to content

ipc.rst

Latest commit

 

History

History
90 lines (65 loc) · 2.34 KB

ipc.rst

File metadata and controls

90 lines (65 loc) · 2.34 KB
.. default-domain:: cpp

Arrow IPC

IPC options

.. doxygenstruct:: arrow::ipc::IpcReadOptions
   :members:

.. doxygenstruct:: arrow::ipc::IpcWriteOptions
   :members:

Reading IPC streams and files

Blocking API

Use either of these two classes, depending on which IPC format you want to read. The file format requires a random-access file, while the stream format only requires a sequential input stream.

.. doxygenclass:: arrow::ipc::RecordBatchStreamReader
   :members:

.. doxygenclass:: arrow::ipc::RecordBatchFileReader
   :members:

Event-driven API

To read an IPC stream in event-driven fashion, you must implement a :class:`~arrow::ipc::Listener` subclass that you will pass to :class:`~arrow::ipc::StreamDecoder`.

.. doxygenclass:: arrow::ipc::Listener
   :members:

.. doxygenclass:: arrow::ipc::StreamDecoder
   :members:

Statistics

.. doxygenstruct:: arrow::ipc::ReadStats
   :members:

Writing IPC streams and files

Blocking API

The IPC stream format is only optionally terminated, whereas the IPC file format must include a terminating footer. Thus a writer of the IPC file format must be explicitly finalized with :func:`~arrow::ipc::RecordBatchWriter::Close()` or the resulting file will be corrupt.

.. doxygengroup:: record-batch-writer-factories
   :content-only:

.. doxygenclass:: arrow::ipc::RecordBatchWriter
   :members:

Statistics

.. doxygenstruct:: arrow::ipc::WriteStats
   :members: