summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/CsvTableReader.Rd
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/r/man/CsvTableReader.Rd
parentInitial commit. (diff)
downloadceph-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/CsvTableReader.Rd')
-rw-r--r--src/arrow/r/man/CsvTableReader.Rd32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/arrow/r/man/CsvTableReader.Rd b/src/arrow/r/man/CsvTableReader.Rd
new file mode 100644
index 000000000..1afa9d020
--- /dev/null
+++ b/src/arrow/r/man/CsvTableReader.Rd
@@ -0,0 +1,32 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/csv.R, R/json.R
+\docType{class}
+\name{CsvTableReader}
+\alias{CsvTableReader}
+\alias{JsonTableReader}
+\title{Arrow CSV and JSON table reader classes}
+\description{
+\code{CsvTableReader} and \code{JsonTableReader} wrap the Arrow C++ CSV
+and JSON table readers. See their usage in \code{\link[=read_csv_arrow]{read_csv_arrow()}} and
+\code{\link[=read_json_arrow]{read_json_arrow()}}, respectively.
+}
+\section{Factory}{
+
+
+The \code{CsvTableReader$create()} and \code{JsonTableReader$create()} factory methods
+take the following arguments:
+\itemize{
+\item \code{file} An Arrow \link{InputStream}
+\item \code{convert_options} (CSV only), \code{parse_options}, \code{read_options}: see
+\link{CsvReadOptions}
+\item \code{...} additional parameters.
+}
+}
+
+\section{Methods}{
+
+\itemize{
+\item \verb{$Read()}: returns an Arrow Table.
+}
+}
+