From f621f899ba8c1d425d3f0cdfee41f27424e8cddd Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Mon, 18 May 2026 10:34:07 +0300 Subject: [PATCH 1/3] Update API vignette --- vignettes/api.Rmd | 38 +++++++++++++++++++++++++++++++------- vignettes/src/_api.Rmd | 4 ++-- 2 files changed, 33 insertions(+), 9 deletions(-) diff --git a/vignettes/api.Rmd b/vignettes/api.Rmd index 536e217..81830db 100644 --- a/vignettes/api.Rmd +++ b/vignettes/api.Rmd @@ -1,6 +1,6 @@ --- title: API Usage -date: "2026-04-20" +date: "2026-05-18" vignette: > %\VignetteIndexEntry{API Usage} %\VignetteEngine{litedown::vignette} @@ -31,7 +31,7 @@ sto2 <- storr::storr(dr) The first approach generates a `TileDBStorr` object that represents the storr interface optimised for TileDB storage and provides additional functionality. The latter is the standard `storr` object. -## API Usage +## API Examples ### 1. get, set, del @@ -114,15 +114,39 @@ sto$set("bb", 1, expires_at = Sys.time() + 1) Or update/retrieve with `$set_keymeta()` and `$get_keymeta()` methods: -```r + +``` r # Retrieve key metadata sto$get_keymeta("aa", use_cache = FALSE) +# $expires_at +# [1] "2026-05-18 10:36:50 EEST" +# +# $notes +# [1] "{\"name\":\"John\",\"id\":12345}" sto$mget_keymeta(c("aa", "bb"), use_cache = TRUE) +# [[1]] +# [[1]]$expires_at +# [1] "2026-05-18 10:36:50 EEST" +# +# [[1]]$notes +# [1] "{\"name\":\"John\",\"id\":12345}" +# +# +# [[2]] +# [[2]]$expires_at +# [1] "2026-05-18 10:31:51 EEST" +# +# [[2]]$notes +# [1] NA # Update key metadata sto$set_keymeta("bb", notes = "Updated Note") sto$get_keymeta("bb") - +# $expires_at +# [1] "2026-05-18 10:31:51 EEST" +# +# $notes +# [1] "Updated Note" ``` **Expiration management** @@ -132,8 +156,8 @@ sto$get_keymeta("bb") sto$keys_with_expiration() # namespace key expires_at # -# 1: objects aa 2026-04-20 10:55:26 -# 2: objects bb 2026-04-20 10:50:27 +# 1: objects aa 2026-05-18 10:36:50 +# 2: objects bb 2026-05-18 10:31:51 Sys.sleep(1) @@ -141,7 +165,7 @@ Sys.sleep(1) sto$expired_keys() # namespace key expires_at # -# 1: objects bb 2026-04-20 10:50:27 +# 1: objects bb 2026-05-18 10:31:51 # Remove expired keys sto$clear_expired_keys() diff --git a/vignettes/src/_api.Rmd b/vignettes/src/_api.Rmd index 3737f74..d4c6b79 100644 --- a/vignettes/src/_api.Rmd +++ b/vignettes/src/_api.Rmd @@ -35,7 +35,7 @@ sto2 <- storr::storr(dr) The first approach generates a `TileDBStorr` object that represents the storr interface optimised for TileDB storage and provides additional functionality. The latter is the standard `storr` object. -## API Usage +## API Examples ### 1. get, set, del ```{r} @@ -96,7 +96,7 @@ sto$set("bb", 1, expires_at = Sys.time() + 1) Or update/retrieve with `$set_keymeta()` and `$get_keymeta()` methods: -```r +```{r} # Retrieve key metadata sto$get_keymeta("aa", use_cache = FALSE) sto$mget_keymeta(c("aa", "bb"), use_cache = TRUE) From 3e3f29686cdffdf497d4d0c725739dde7cab376b Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Mon, 18 May 2026 10:35:15 +0300 Subject: [PATCH 2/3] Docs - add missing methods --- R/driver_tiledb.R | 6 ++++-- man/driver_tiledb.Rd | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/R/driver_tiledb.R b/R/driver_tiledb.R index 850aebf..a236cea 100644 --- a/R/driver_tiledb.R +++ b/R/driver_tiledb.R @@ -49,8 +49,10 @@ #' #' **Key-Namespace Metadata** #' -#' - **`get_keymeta()`**, **`set_keymeta()`**, and **`mset_keymeta()`** - Manage metadata such as -#' expiry times and notes for key-namespace pairs +#' - **`get_keymeta()`** and **`set_keymeta()`** - Manage metadata such as +#' expiry times and notes for single key-namespace pairs +#' - **`mget_keymeta()`** and **`mset_keymeta()`** - Manage metadata such as +#' expiry times and notes for multiple key-namespace pairs #' #' **Expiration Management** #' diff --git a/man/driver_tiledb.Rd b/man/driver_tiledb.Rd index 6175c35..ea191b8 100644 --- a/man/driver_tiledb.Rd +++ b/man/driver_tiledb.Rd @@ -85,8 +85,10 @@ parent class \link{CAS}. \strong{Key-Namespace Metadata} \itemize{ -\item \strong{\code{get_keymeta()}}, \strong{\code{set_keymeta()}}, and \strong{\code{mset_keymeta()}} - Manage metadata such as -expiry times and notes for key-namespace pairs +\item \strong{\code{get_keymeta()}} and \strong{\code{set_keymeta()}} - Manage metadata such as +expiry times and notes for single key-namespace pairs +\item \strong{\code{mget_keymeta()}} and \strong{\code{mset_keymeta()}} - Manage metadata such as +expiry times and notes for multiple key-namespace pairs } \strong{Expiration Management} From 056e283f979e086683db2deeb561907e0c760c54 Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Mon, 18 May 2026 10:36:03 +0300 Subject: [PATCH 3/3] Update NEWS.md and DESCRIPTION --- DESCRIPTION | 4 ++-- NEWS.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index f4715bb..009ba75 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: storr.tiledb Title: A TileDB Storage Driver for Storr -Version: 0.0.37 -Date: 2026-05-03 +Version: 0.0.38 +Date: 2026-05-18 Authors@R: person("Constantinos", "Giachalis", , "xx@github.com", role = c("aut", "cre")) Maintainer: Constantinos Giachalis diff --git a/NEWS.md b/NEWS.md index e603c6e..cb29f4d 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,3 @@ -# storr.tiledb 0.0.37 +# storr.tiledb 0.0.38 * Initial GitHub release.