arrow
v0.1.0

View Source arrow_ipc_file (arrow v0.1.0)

Provides records and functions to deal with the IPC File.

The IPC File[1] is an extension of the IPC Stream[2] that supports random access with the help of a footer which contains the offsets of all the messages.

[1]: https://arrow.apache.org/docs/format/Columnar.html#ipc-file-format [2]: https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format

Link to this section Summary

Functions

from_erlang(Message, RecordBatches)
Creates a file given a schema message and a list of record batch messages.
to_ipc(File)
Serializes a file into the IPC File Format

Link to this section Functions

Link to this function

from_erlang(Message, RecordBatches)

View Source 
-spec from_erlang(Schema :: #message{}, RecordBatches :: [#message{}]) -> #file{}.
Creates a file given a schema message and a list of record batch messages.
Link to this function

to_ipc(File)

View Source 
-spec to_ipc(File :: #file{}) -> SerializedFile :: binary().
Serializes a file into the IPC File Format