arrow: write_feather – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

write_feather

Write data in the Feather format

Description

Feather provides binary columnar serialization for data frames. It is designed to make reading and writing data frames efficient, and to make sharing data across data analysis languages easy. This function writes both the original, limited specification of the format and the version 2 specification, which is the Apache Arrow IPC file format.

Usage

write_feather(
  x,
  sink,
  version = 2,
  chunk_size = 65536L,
  compression = c("default", "lz4", "uncompressed", "zstd"),
  compression_level = NULL
)

Arguments

`x`	`data.frame`, RecordBatch, or Table
`sink`	A string file path, URI, or OutputStream, or path in a file system (`SubTreeFileSystem`)
`version`	integer Feather file version. Version 2 is the current. Version 1 is the more limited legacy format.
`chunk_size`	For V2 files, the number of rows that each chunk of data should have in the file. Use a smaller `chunk_size` when you need faster random row access. Default is 64K. This option is not supported for V1.
`compression`	Name of compression codec to use, if any. Default is "lz4" if LZ4 is available in your build of the Arrow C++ library, otherwise "uncompressed". "zstd" is the other available codec and generally has better compression ratios in exchange for slower read and write performance See `codec_is_available()`. This option is not supported for V1.
`compression_level`	If `compression` is "zstd", you may specify an integer compression level. If omitted, the compression codec's default compression level is used.

Value

The input x, invisibly. Note that if sink is an OutputStream, the stream will be left open.

Examples

tf <- tempfile()
on.exit(unlink(tf))
write_feather(mtcars, tf)

arrow

Integration to 'Apache' 'Arrow'

v4.0.0.1

Apache License (>= 2.0)

Authors

Neal Richardson [aut, cre], Ian Cook [aut], Jonathan Keane [aut], Romain François [aut] (<https://orcid.org/0000-0002-2444-4226>), Jeroen Ooms [aut], Javier Luraschi [ctb], Jeffrey Wong [ctb], Apache Arrow [aut, cph]

Initial release