diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/r/man/read_ipc_stream.Rd | |
parent | Initial commit. (diff) | |
download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/arrow/r/man/read_ipc_stream.Rd')
-rw-r--r-- | src/arrow/r/man/read_ipc_stream.Rd | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/src/arrow/r/man/read_ipc_stream.Rd b/src/arrow/r/man/read_ipc_stream.Rd new file mode 100644 index 000000000..d4dd78314 --- /dev/null +++ b/src/arrow/r/man/read_ipc_stream.Rd @@ -0,0 +1,42 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/deprecated.R, R/ipc_stream.R +\name{read_arrow} +\alias{read_arrow} +\alias{read_ipc_stream} +\title{Read Arrow IPC stream format} +\usage{ +read_arrow(file, ...) + +read_ipc_stream(file, as_data_frame = TRUE, ...) +} +\arguments{ +\item{file}{A character file name or URI, \code{raw} vector, an Arrow input stream, +or a \code{FileSystem} with path (\code{SubTreeFileSystem}). +If a file name or URI, an Arrow \link{InputStream} will be opened and +closed when finished. If an input stream is provided, it will be left +open.} + +\item{...}{extra parameters passed to \code{read_feather()}.} + +\item{as_data_frame}{Should the function return a \code{data.frame} (default) or +an Arrow \link{Table}?} +} +\value{ +A \code{data.frame} if \code{as_data_frame} is \code{TRUE} (the default), or an +Arrow \link{Table} otherwise +} +\description{ +Apache Arrow defines two formats for \href{https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc}{serializing data for interprocess communication (IPC)}: +a "stream" format and a "file" format, known as Feather. \code{read_ipc_stream()} +and \code{\link[=read_feather]{read_feather()}} read those formats, respectively. +} +\details{ +\code{read_arrow()}, a wrapper around \code{read_ipc_stream()} and \code{read_feather()}, +is deprecated. You should explicitly choose +the function that will read the desired IPC format (stream or file) since +a file or \code{InputStream} may contain either. +} +\seealso{ +\code{\link[=read_feather]{read_feather()}} for writing IPC files. \link{RecordBatchReader} for a +lower-level interface. +} |