]> git.proxmox.com Git - ceph.git/blobdiff - ceph/src/arrow/r/man/ParquetFileWriter.Rd
import quincy 17.2.0
[ceph.git] / ceph / src / arrow / r / man / ParquetFileWriter.Rd
diff --git a/ceph/src/arrow/r/man/ParquetFileWriter.Rd b/ceph/src/arrow/r/man/ParquetFileWriter.Rd
new file mode 100644 (file)
index 0000000..f36e85a
--- /dev/null
@@ -0,0 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/parquet.R
+\docType{class}
+\name{ParquetFileWriter}
+\alias{ParquetFileWriter}
+\title{ParquetFileWriter class}
+\description{
+This class enables you to interact with Parquet files.
+}
+\section{Factory}{
+
+
+The \code{ParquetFileWriter$create()} factory method instantiates the object and
+takes the following arguments:
+\itemize{
+\item \code{schema} A \link{Schema}
+\item \code{sink} An \link[=OutputStream]{arrow::io::OutputStream}
+\item \code{properties} An instance of \link{ParquetWriterProperties}
+\item \code{arrow_properties} An instance of \code{ParquetArrowWriterProperties}
+}
+}
+
+\section{Methods}{
+
+\itemize{
+\item \code{WriteTable} Write a \link{Table} to \code{sink}
+\item \code{Close} Close the writer. Note: does not close the \code{sink}.
+\link[=OutputStream]{arrow::io::OutputStream} has its own \code{close()} method.
+}
+}
+