summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/Field.Rd
blob: 3b709e8794404baa4dd3b293a7d0b7a7660a4a40 (plain)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/field.R
\docType{class}
\name{Field}
\alias{Field}
\alias{field}
\title{Field class}
\usage{
field(name, type, metadata, nullable = TRUE)
}
\arguments{
\item{name}{field name}

\item{type}{logical type, instance of \link{DataType}}

\item{metadata}{currently ignored}

\item{nullable}{TRUE if field is nullable}
}
\description{
\code{field()} lets you create an \code{arrow::Field} that maps a
\link[=data-type]{DataType} to a column name. Fields are contained in
\link[=Schema]{Schemas}.
}
\section{Methods}{

\itemize{
\item \code{f$ToString()}: convert to a string
\item \code{f$Equals(other)}: test for equality. More naturally called as \code{f == other}
}
}

\examples{
\dontshow{if (arrow_available()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
field("x", int32())
\dontshow{\}) # examplesIf}
}