diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/arrow/r/man/hive_partition.Rd | |
parent | Initial commit. (diff) | |
download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/arrow/r/man/hive_partition.Rd')
-rw-r--r-- | src/arrow/r/man/hive_partition.Rd | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/src/arrow/r/man/hive_partition.Rd b/src/arrow/r/man/hive_partition.Rd new file mode 100644 index 000000000..eef9f9157 --- /dev/null +++ b/src/arrow/r/man/hive_partition.Rd @@ -0,0 +1,35 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/dataset-partition.R +\name{hive_partition} +\alias{hive_partition} +\title{Construct Hive partitioning} +\usage{ +hive_partition(..., null_fallback = NULL, segment_encoding = "uri") +} +\arguments{ +\item{...}{named list of \link[=data-type]{data types}, passed to \code{\link[=schema]{schema()}}} + +\item{null_fallback}{character to be used in place of missing values (\code{NA} or \code{NULL}) +in partition columns. Default is \code{"__HIVE_DEFAULT_PARTITION__"}, +which is what Hive uses.} + +\item{segment_encoding}{Decode partition segments after splitting paths. +Default is \code{"uri"} (URI-decode segments). May also be \code{"none"} (leave as-is).} +} +\value{ +A \link[=Partitioning]{HivePartitioning}, or a \code{HivePartitioningFactory} if +calling \code{hive_partition()} with no arguments. +} +\description{ +Hive partitioning embeds field names and values in path segments, such as +"/year=2019/month=2/data.parquet". +} +\details{ +Because fields are named in the path segments, order of fields passed to +\code{hive_partition()} does not matter. +} +\examples{ +\dontshow{if (arrow_with_dataset()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +hive_partition(year = int16(), month = int8()) +\dontshow{\}) # examplesIf} +} |