connector (version 1.0.0)

upload_directory_cnt: Upload a directory

Description

Generic implementing of how to upload a directory for a connector. Mostly relevant for file storage connectors.

• ConnectorFS: Uses fs::dir_copy().

Usage

upload_directory_cnt(
  connector_object,
  src,
  dest,
  overwrite = zephyr::get_option("overwrite", "connector"),
  open = FALSE,
  ...
)
# S3 method for ConnectorFS
upload_directory_cnt(
  connector_object,
  src,
  dest,
  overwrite = zephyr::get_option("overwrite", "connector"),
  open = FALSE,
  ...
)

Value

invisible connector_object.

Arguments

connector_object

Connector The connector object to use.

src

character Path to the directory to upload

dest

character The name of the new directory to place the content in

overwrite

Overwrite existing content if it exists in the connector? See connector-options for details. Default can be set globally with options(connector.overwrite = TRUE/FALSE) or environment variable R_CONNECTOR_OVERWRITE.. Default: FALSE.

open

logical Open the directory as a new connector object.

...

Additional arguments passed to the method for the individual connector.

Examples

# Upload a directory to a file storage
folder <- withr::local_tempdir("test", .local_envir = .GlobalEnv)

cnt <- connector_fs(folder)
# Create a source directory
dir.create(file.path(folder, "src_dir"))
writeLines(
  "This is a test file.",
  file.path(folder, "src_dir", "test.txt")
)
# Upload the directory
cnt |>
  upload_directory_cnt(
    src = file.path(folder, "src_dir"),
    dest = "uploaded_dir"
  )