diff options
Diffstat (limited to '')
-rw-r--r-- | src/arrow/r/man/read_parquet.Rd | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/src/arrow/r/man/read_parquet.Rd b/src/arrow/r/man/read_parquet.Rd new file mode 100644 index 000000000..056e86447 --- /dev/null +++ b/src/arrow/r/man/read_parquet.Rd @@ -0,0 +1,50 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/parquet.R +\name{read_parquet} +\alias{read_parquet} +\title{Read a Parquet file} +\usage{ +read_parquet( + file, + col_select = NULL, + as_data_frame = TRUE, + props = ParquetArrowReaderProperties$create(), + ... +) +} +\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{col_select}{A character vector of column names to keep, as in the +"select" argument to \code{data.table::fread()}, or a +\link[tidyselect:vars_select]{tidy selection specification} +of columns, as used in \code{dplyr::select()}.} + +\item{as_data_frame}{Should the function return a \code{data.frame} (default) or +an Arrow \link{Table}?} + +\item{props}{\link{ParquetArrowReaderProperties}} + +\item{...}{Additional arguments passed to \code{ParquetFileReader$create()}} +} +\value{ +A \link[=Table]{arrow::Table}, or a \code{data.frame} if \code{as_data_frame} is +\code{TRUE} (the default). +} +\description{ +'\href{https://parquet.apache.org/}{Parquet}' is a columnar storage file format. +This function enables you to read Parquet files into R. +} +\examples{ +\dontshow{if (arrow_with_parquet()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +tf <- tempfile() +on.exit(unlink(tf)) +write_parquet(mtcars, tf) +df <- read_parquet(tf, col_select = starts_with("d")) +head(df) +\dontshow{\}) # examplesIf} +} |