R: Read Arrow IPC stream format

read_arrow {arrow} | R Documentation

## Read Arrow IPC stream format

### Description

Apache Arrow defines two formats for serializing data for interprocess communication (IPC): a "stream" format and a "file" format, known as Feather. `read_ipc_stream()` and `read_feather()` read those formats, respectively.

### Usage

    read_arrow(file, ...)

    read_ipc_stream(file, as_data_frame = TRUE, ...)

### Arguments

`file` | A character file name, `raw` vector, or an Arrow input stream. If a file name, a memory-mapped Arrow InputStream will be opened and closed when finished. If an input stream is provided, it will be left open.
`...` | extra parameters passed to `read_feather()`.
`as_data_frame` | Should the function return a `data.frame` (default) or an Arrow Table?

### Details

`read_arrow()`, a wrapper around `read_ipc_stream()` and `read_feather()`, is deprecated. You should explicitly choose the function that will read the desired IPC format (stream or file) since a file or `InputStream` may contain either.

### Value

A `data.frame` if `as_data_frame` is `TRUE` (the default), or an Arrow Table otherwise

### See Also

`read_feather()` for writing IPC files. RecordBatchReader for a lower-level interface.

[Package arrow version 1.0.1 Index]