File: as_record_batch_reader.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 (52 lines) | stat: -rw-r--r-- 1,586 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
40
41
42
43
44
45
46
47
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/record-batch-reader.R
\name{as_record_batch_reader}
\alias{as_record_batch_reader}
\alias{as_record_batch_reader.RecordBatchReader}
\alias{as_record_batch_reader.Table}
\alias{as_record_batch_reader.RecordBatch}
\alias{as_record_batch_reader.data.frame}
\alias{as_record_batch_reader.Dataset}
\alias{as_record_batch_reader.function}
\alias{as_record_batch_reader.arrow_dplyr_query}
\alias{as_record_batch_reader.Scanner}
\title{Convert an object to an Arrow RecordBatchReader}
\usage{
as_record_batch_reader(x, ...)

\method{as_record_batch_reader}{RecordBatchReader}(x, ...)

\method{as_record_batch_reader}{Table}(x, ...)

\method{as_record_batch_reader}{RecordBatch}(x, ...)

\method{as_record_batch_reader}{data.frame}(x, ...)

\method{as_record_batch_reader}{Dataset}(x, ...)

\method{as_record_batch_reader}{`function`}(x, ..., schema)

\method{as_record_batch_reader}{arrow_dplyr_query}(x, ...)

\method{as_record_batch_reader}{Scanner}(x, ...)
}
\arguments{
\item{x}{An object to convert to a \link{RecordBatchReader}}

\item{...}{Passed to S3 methods}

\item{schema}{The \code{\link[=schema]{schema()}} that must match the schema returned by each
call to \code{x} when \code{x} is a function.}
}
\value{
A \link{RecordBatchReader}
}
\description{
Convert an object to an Arrow RecordBatchReader
}
\examples{
\dontshow{if (arrow_with_dataset()) withAutoprint(\{ # examplesIf}
reader <- as_record_batch_reader(data.frame(col1 = 1, col2 = "two"))
reader$read_next_batch()
\dontshow{\}) # examplesIf}
}