S3Store Class

Thin store wrapper for S3 URLs. All I/O is delegated to the zarrs Rust backend via object_store. Requires the s3 compiled feature (r-universe tier).

Format

R6::R6Class

Details

S3 Store for Zarr (zarrs backend)

See also

Other Store classes: DirectoryStore, GcsStore, HttpStore, MemoryStore, Store

Super class

pizzarr::Store -> S3Store

Methods

Public methods

• S3Store$new()

• S3Store$get_store_identifier()

• S3Store$print()

• S3Store$clone()

Inherited methods

• pizzarr::Store$close()
• pizzarr::Store$contains_item()
• pizzarr::Store$delete_item()
• pizzarr::Store$get_consolidated_metadata()
• pizzarr::Store$get_item()
• pizzarr::Store$is_erasable()
• pizzarr::Store$is_listable()
• pizzarr::Store$is_readable()
• pizzarr::Store$is_writeable()
• pizzarr::Store$listdir()
• pizzarr::Store$rename()
• pizzarr::Store$rmdir()
• pizzarr::Store$set_item()

---

Method new()

Create an S3Store.

Usage

S3Store$new(url)

Arguments

url

Character. S3 URL (e.g., "s3://bucket/prefix").

---

Method get_store_identifier()

Return the S3 URL for zarrs dispatch.

Usage

S3Store$get_store_identifier()

Returns

A character string.

---

Method print()

Print a human-readable summary of the store.

Usage

S3Store$print(...)

Arguments

...

Ignored.

Returns

self (invisibly).

---

Method clone()

The objects of this class are cloneable with this method.

Usage

S3Store$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.