Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -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 <xx@github.com>
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# storr.tiledb 0.0.37
# storr.tiledb 0.0.38

* Initial GitHub release.
6 changes: 4 additions & 2 deletions R/driver_tiledb.R
Original file line number Diff line number Diff line change
Expand Up @@ -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**
#'
Expand Down
6 changes: 4 additions & 2 deletions man/driver_tiledb.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 31 additions & 7 deletions vignettes/api.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: API Usage
date: "2026-04-20"
date: "2026-05-18"
vignette: >
%\VignetteIndexEntry{API Usage}
%\VignetteEngine{litedown::vignette}
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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**
Expand All @@ -132,16 +156,16 @@ sto$get_keymeta("bb")
sto$keys_with_expiration()
# namespace key expires_at
# <char> <char> <POSc>
# 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)

# Retrieve expired keys
sto$expired_keys()
# namespace key expires_at
# <char> <char> <POSc>
# 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()
Expand Down
4 changes: 2 additions & 2 deletions vignettes/src/_api.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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)
Expand Down
Loading