blob: f36e85ab6c4edd9e9a04393cec524c47db1a53de [file] [log] [blame]
% 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.
}
}