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/s3_bucket.Rd | |
parent | Initial commit. (diff) | |
download | ceph-b26c4052f3542036551aa9dec9caa4226e456195.tar.xz ceph-b26c4052f3542036551aa9dec9caa4226e456195.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | src/arrow/r/man/s3_bucket.Rd | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/src/arrow/r/man/s3_bucket.Rd b/src/arrow/r/man/s3_bucket.Rd new file mode 100644 index 000000000..95a086dea --- /dev/null +++ b/src/arrow/r/man/s3_bucket.Rd @@ -0,0 +1,28 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/filesystem.R +\name{s3_bucket} +\alias{s3_bucket} +\title{Connect to an AWS S3 bucket} +\usage{ +s3_bucket(bucket, ...) +} +\arguments{ +\item{bucket}{string S3 bucket name or path} + +\item{...}{Additional connection options, passed to \code{S3FileSystem$create()}} +} +\value{ +A \code{SubTreeFileSystem} containing an \code{S3FileSystem} and the bucket's +relative path. Note that this function's success does not guarantee that you +are authorized to access the bucket's contents. +} +\description{ +\code{s3_bucket()} is a convenience function to create an \code{S3FileSystem} object +that automatically detects the bucket's AWS region and holding onto the its +relative path. +} +\examples{ +\dontshow{if (arrow_with_s3()) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +bucket <- s3_bucket("ursa-labs-taxi-data") +\dontshow{\}) # examplesIf} +} |