]>
Commit | Line | Data |
---|---|---|
1d09f67e TL |
1 | % Generated by roxygen2: do not edit by hand |
2 | % Please edit documentation in R/deprecated.R, R/ipc_stream.R | |
3 | \name{write_arrow} | |
4 | \alias{write_arrow} | |
5 | \alias{write_ipc_stream} | |
6 | \title{Write Arrow IPC stream format} | |
7 | \usage{ | |
8 | write_arrow(x, sink, ...) | |
9 | ||
10 | write_ipc_stream(x, sink, ...) | |
11 | } | |
12 | \arguments{ | |
13 | \item{x}{\code{data.frame}, \link{RecordBatch}, or \link{Table}} | |
14 | ||
15 | \item{sink}{A string file path, URI, or \link{OutputStream}, or path in a file | |
16 | system (\code{SubTreeFileSystem})} | |
17 | ||
18 | \item{...}{extra parameters passed to \code{write_feather()}.} | |
19 | } | |
20 | \value{ | |
21 | \code{x}, invisibly. | |
22 | } | |
23 | \description{ | |
24 | 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)}: | |
25 | a "stream" format and a "file" format, known as Feather. \code{write_ipc_stream()} | |
26 | and \code{\link[=write_feather]{write_feather()}} write those formats, respectively. | |
27 | } | |
28 | \details{ | |
29 | \code{write_arrow()}, a wrapper around \code{write_ipc_stream()} and \code{write_feather()} | |
30 | with some nonstandard behavior, is deprecated. You should explicitly choose | |
31 | the function that will write the desired IPC format (stream or file) since | |
32 | either can be written to a file or \code{OutputStream}. | |
33 | } | |
34 | \examples{ | |
35 | \dontshow{if (arrow_available()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} | |
36 | tf <- tempfile() | |
37 | on.exit(unlink(tf)) | |
38 | write_ipc_stream(mtcars, tf) | |
39 | \dontshow{\}) # examplesIf} | |
40 | } | |
41 | \seealso{ | |
42 | \code{\link[=write_feather]{write_feather()}} for writing IPC files. \code{\link[=write_to_raw]{write_to_raw()}} to | |
43 | serialize data to a buffer. | |
44 | \link{RecordBatchWriter} for a lower-level interface. | |
45 | } |