Skip to contents

Restore files from compressed files

Usage

cas_restore(
  restore_to = NULL,
  restore_from = NULL,
  file_format = "tar.gz",
  index = FALSE,
  contents = FALSE,
  batch = NULL,
  db_connection = NULL,
  db_folder = NULL,
  ...
)

Arguments

restore_to

Path to archive directory, defaults to NULL. If NULL, path is set to the project/website/archive folder.

restore_from

Path to archive directory, defaults to NULL. If NULL, path is set to the project/website/archive folder.

file_format

Defaults to "tar.gz", to ensure cross-platform compatibility. No other formats are supported at this stage.

db_connection

Defaults to NULL. If NULL, uses local SQLite database. If given, must be a connection object or a list with relevant connection settings (see example).

...

Passed to cas_get_db_file().

Value

A path to the base folder where files are stored. Corresponds to restore_to if given, or to a temporary folder if restore_to is set to NULL.