summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/copy_files.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'src/arrow/r/man/copy_files.Rd')
-rw-r--r--src/arrow/r/man/copy_files.Rd35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/arrow/r/man/copy_files.Rd b/src/arrow/r/man/copy_files.Rd
new file mode 100644
index 000000000..1b83703f1
--- /dev/null
+++ b/src/arrow/r/man/copy_files.Rd
@@ -0,0 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/filesystem.R
+\name{copy_files}
+\alias{copy_files}
+\title{Copy files between FileSystems}
+\usage{
+copy_files(from, to, chunk_size = 1024L * 1024L)
+}
+\arguments{
+\item{from}{A string path to a local directory or file, a URI, or a
+\code{SubTreeFileSystem}. Files will be copied recursively from this path.}
+
+\item{to}{A string path to a local directory or file, a URI, or a
+\code{SubTreeFileSystem}. Directories will be created as necessary}
+
+\item{chunk_size}{The maximum size of block to read before flushing
+to the destination file. A larger chunk_size will use more memory while
+copying but may help accommodate high latency FileSystems.}
+}
+\value{
+Nothing: called for side effects in the file system
+}
+\description{
+Copy files between FileSystems
+}
+\examples{
+\dontshow{if (FALSE) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
+# Copy an S3 bucket's files to a local directory:
+copy_files("s3://your-bucket-name", "local-directory")
+# Using a FileSystem object
+copy_files(s3_bucket("your-bucket-name"), "local-directory")
+# Or go the other way, from local to S3
+copy_files("local-directory", s3_bucket("your-bucket-name"))
+\dontshow{\}) # examplesIf}
+}