Skip to contents

Where the repository lives. Storage objects hold no open connections and are cheap; credentials given here are never printed.

Usage

ic_storage_local(path)

ic_storage_memory()

ic_storage_http(base_url)

ic_storage_s3(
  bucket,
  prefix = NULL,
  region = NULL,
  endpoint_url = NULL,
  anonymous = FALSE,
  allow_http = FALSE,
  force_path_style = !is.null(endpoint_url),
  requester_pays = FALSE,
  credentials = NULL,
  backend = c("object_store", "aws")
)

ic_storage_gcs(bucket, prefix = NULL, anonymous = FALSE)

ic_storage_azure(account, container, prefix = NULL)

Arguments

path

directory of the repository (local).

base_url

URL of the repository root (read-only HTTP).

bucket, prefix

bucket and key prefix of the repository.

region, endpoint_url

S3 region and endpoint (for S3-compatible services such as Pawsey Acacia or data.source.coop).

anonymous

unsigned requests.

allow_http

allow http:// endpoints.

force_path_style

path-style addressing (most S3-compatible services need this).

requester_pays

requester-pays bucket.

credentials

an ic_cred_s3() spec, or NULL for icechunk's default (from the environment).

backend

"object_store" (default) or "aws" (the aws-sdk backend, only in the full build).

account, container

Azure account and container.

Value

an icechunk_storage object.

Examples

st <- ic_storage_local(file.path(tempdir(), "a-repo"))
st
#> <icechunk_storage> local: /tmp/RtmpVaRScy/a-repo 
ic_storage_memory()
#> <icechunk_storage> in-memory 
ic_storage_http("https://data.source.coop/ausantarctic/ausantarctic-scratch/oisst/oisst-v2.1-daily/icechunk")
#> <icechunk_storage> http: https://data.source.coop/ausantarctic/ausantarctic-scratch/oisst/oisst-v2.1-daily/icechunk 
if (FALSE) { # \dontrun{
# cloud object stores (the "cloud" build tier)
ic_storage_s3("my-bucket", prefix = "repo", region = "us-west-2",
              credentials = ic_cred_s3("from_env"))
ic_storage_s3("bucket", prefix = "repo", endpoint_url = "https://projects.pawsey.org.au",
              anonymous = TRUE)
ic_storage_gcs("my-bucket", prefix = "repo", anonymous = TRUE)
ic_storage_azure("account", "container", prefix = "repo")
} # }