File: JsonFileFormat.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 (39 lines) | stat: -rw-r--r-- 1,255 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
33
34
35
36
37
38
39
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/dataset-format.R
\name{JsonFileFormat}
\alias{JsonFileFormat}
\title{JSON dataset file format}
\value{
A \code{JsonFileFormat} object
}
\description{
A \code{JsonFileFormat} is a \link{FileFormat} subclass which holds information about how to
read and parse the files included in a JSON \code{Dataset}.
}
\section{Factory}{

\code{JsonFileFormat$create()} can take options in the form of lists passed through as \code{parse_options},
or \code{read_options} parameters.

Available \code{read_options} parameters:
\itemize{
\item \code{use_threads}: Whether to use the global CPU thread pool. Default \code{TRUE}. If \code{FALSE}, JSON input must end with an
empty line.
\item \code{block_size}: Block size we request from the IO layer; also determines size of chunks when \code{use_threads}
is \code{TRUE}.
}

Available \code{parse_options} parameters:
\itemize{
\item \code{newlines_in_values}:Logical: are values allowed to contain CR (\code{0x0d} or \verb{\\r}) and LF (\code{0x0a} or \verb{\\n})
characters? (default \code{FALSE})
}
}

\examples{
\dontshow{if (arrow_with_dataset()) withAutoprint(\{ # examplesIf}
\dontshow{\}) # examplesIf}
}
\seealso{
\link{FileFormat}
}