File: ParquetFileWriter.Rd

package info (click to toggle)
apache-arrow 23.0.1-1
  • links: PTS
  • area: main
  • in suites: sid
  • size: 76,220 kB
  • sloc: cpp: 654,608; python: 70,522; ruby: 45,964; ansic: 18,742; sh: 7,365; makefile: 669; javascript: 125; xml: 41
file content (32 lines) | stat: -rw-r--r-- 977 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
% 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{WriteBatch} Write a \link{RecordBatch} 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.
}
}