From e8c2e28505d05e9f8306c0e443b3b7f0c08c24ed Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Sun, 3 May 2026 14:39:29 +0300 Subject: [PATCH 1/5] Reexport tiledb/R6.tiledb functions --- NAMESPACE | 10 ++++++++++ R/reexports.R | 20 ++++++++++++++++++++ man/reexports.Rd | 22 ++++++++++++++++++++++ 3 files changed, 52 insertions(+) create mode 100644 R/reexports.R create mode 100644 man/reexports.Rd diff --git a/NAMESPACE b/NAMESPACE index c82a14b..8a5e6df 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -6,6 +6,9 @@ export(TileDBDriver) export(TileDBStorr) export(driver_tiledb) export(driver_tiledb_create) +export(get_allocation_size_preference) +export(new_context) +export(set_allocation_size_preference) export(storr_consolidate) export(storr_copy) export(storr_fragments) @@ -13,10 +16,17 @@ export(storr_move) export(storr_rename) export(storr_tiledb) export(storr_vacuum) +export(tiledb_config) +export(tiledb_ctx) importFrom(R6,R6Class) importFrom(R6.tiledb,TileDBArray) importFrom(R6.tiledb,TileDBGroup) +importFrom(R6.tiledb,new_context) importFrom(arrow,call_function) importFrom(data.table,`:=`) importFrom(stats,na.omit) importFrom(storr,join_key_namespace) +importFrom(tiledb,get_allocation_size_preference) +importFrom(tiledb,set_allocation_size_preference) +importFrom(tiledb,tiledb_config) +importFrom(tiledb,tiledb_ctx) diff --git a/R/reexports.R b/R/reexports.R new file mode 100644 index 0000000..62f2732 --- /dev/null +++ b/R/reexports.R @@ -0,0 +1,20 @@ +#' @export +#' @importFrom R6.tiledb new_context +R6.tiledb::new_context + +#' @export +#' @importFrom tiledb tiledb_config +tiledb::tiledb_config + +#' @export +#' @importFrom tiledb tiledb_ctx +tiledb::tiledb_ctx + + +#' @export +#' @importFrom tiledb set_allocation_size_preference +tiledb::set_allocation_size_preference + +#' @export +#' @importFrom tiledb get_allocation_size_preference +tiledb::get_allocation_size_preference diff --git a/man/reexports.Rd b/man/reexports.Rd new file mode 100644 index 0000000..0690000 --- /dev/null +++ b/man/reexports.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/reexports.R +\docType{import} +\name{reexports} +\alias{reexports} +\alias{new_context} +\alias{tiledb_config} +\alias{tiledb_ctx} +\alias{set_allocation_size_preference} +\alias{get_allocation_size_preference} +\title{Objects exported from other packages} +\keyword{internal} +\description{ +These objects are imported from other packages. Follow the links +below to see their documentation. + +\describe{ + \item{R6.tiledb}{\code{\link[R6.tiledb:new_context]{new_context()}}} + + \item{tiledb}{\code{\link[tiledb:get_allocation_size_preference]{get_allocation_size_preference()}}, \code{\link[tiledb:set_allocation_size_preference]{set_allocation_size_preference()}}, \code{\link[tiledb:tiledb_config]{tiledb_config()}}, \code{\link[tiledb:tiledb_ctx]{tiledb_ctx()}}} +}} + From 9b11131c1338ce862a40c4b5915f66d690ca42ae Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Sun, 3 May 2026 14:40:35 +0300 Subject: [PATCH 2/5] Upgrade to roxygen v8.0.0 --- DESCRIPTION | 2 +- man/CAS.Rd | 303 +++--- man/StorrFragments.Rd | 218 ++-- man/TileDBDriver.Rd | 1262 +++++++++++----------- man/TileDBStorr.Rd | 1996 +++++++++++++++++------------------ man/storr.tiledb-package.Rd | 5 + man/storr_copy.Rd | 6 +- man/storr_fragments.Rd | 2 +- man/storr_move.Rd | 6 +- man/storr_rename.Rd | 6 +- man/storr_tiledb.Rd | 4 +- 11 files changed, 1930 insertions(+), 1880 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a5fd4e0..ec10c2c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -42,4 +42,4 @@ Config/testthat/start-first: StorrFragments,auto* Encoding: UTF-8 Language: en-GB Roxygen: list(markdown = TRUE, old_usage = TRUE) -RoxygenNote: 7.3.3 +Config/roxygen2/version: 8.0.0 diff --git a/man/CAS.Rd b/man/CAS.Rd index 4b04411..2b855ec 100644 --- a/man/CAS.Rd +++ b/man/CAS.Rd @@ -14,205 +14,214 @@ An R6 class for creating a content addressable storage. \code{\link[R6.tiledb:TileDBObject]{R6.tiledb::TileDBObject}} -> \code{\link[R6.tiledb:TileDBGroup]{R6.tiledb::TileDBGroup}} -> \code{CAS} } \section{Active bindings}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash_algorithm}}{Hash algorithm} + \if{html}{\out{
}} + \describe{ + \item{\code{hash_algorithm}}{Hash algorithm} -\item{\code{members_instantiated}}{Have the members been instantiated?} + \item{\code{members_instantiated}}{Have the members been instantiated?} -\item{\code{size}}{Return directory size} -} -\if{html}{\out{
}} + \item{\code{size}}{Return directory size} + } + \if{html}{\out{
}} } \section{Methods}{ \subsection{Public methods}{ -\itemize{ -\item \href{#method-CAS-create}{\code{CAS$create()}} -\item \href{#method-CAS-open}{\code{CAS$open()}} -\item \href{#method-CAS-close}{\code{CAS$close()}} -\item \href{#method-CAS-destroy}{\code{CAS$destroy()}} -\item \href{#method-CAS-filter_keys}{\code{CAS$filter_keys()}} -\item \href{#method-CAS-dir_tree}{\code{CAS$dir_tree()}} -\item \href{#method-CAS-dump}{\code{CAS$dump()}} -\item \href{#method-CAS-clone}{\code{CAS$clone()}} -} -} -\if{html}{\out{ -
Inherited methods + \itemize{ + \item \href{#method-CAS-create}{\code{CAS$create()}} + \item \href{#method-CAS-open}{\code{CAS$open()}} + \item \href{#method-CAS-close}{\code{CAS$close()}} + \item \href{#method-CAS-destroy}{\code{CAS$destroy()}} + \item \href{#method-CAS-filter_keys}{\code{CAS$filter_keys()}} + \item \href{#method-CAS-dir_tree}{\code{CAS$dir_tree()}} + \item \href{#method-CAS-dump}{\code{CAS$dump()}} + \item \href{#method-CAS-clone}{\code{CAS$clone()}} + } +} +\if{html}{\out{
Inherited methods -
-}} +
}} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-create}{}}} -\subsection{Method \code{create()}}{ -Create CAS. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$create(compression_level = -7, algo = NULL, keep_open = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{compression_level}}{Set an integer value for ZSTD compression level.} - -\item{\code{algo}}{Select a hash algorithm to be used.} - -\item{\code{keep_open}}{Should \code{CAS} be kept opened after creation? Default is +\subsection{\code{CAS$create()}}{ + Create CAS. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$create(compression_level = -7, algo = NULL, keep_open = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{compression_level}}{Set an integer value for ZSTD compression level.} + \item{\code{algo}}{Select a hash algorithm to be used.} + \item{\code{keep_open}}{Should \code{CAS} be kept opened after creation? Default is \code{TRUE}; the mode will be \code{"WRITE"}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The object, invisibly + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -The object, invisibly -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-open}{}}} -\subsection{Method \code{open()}}{ -Open \code{CAS} object for read or write. +\subsection{\code{CAS$open()}}{ + Open \code{CAS} object for read or write. Setting\code{instantiate} argument to \code{TRUE}, all members will be instantiated and cached on opening. They can be accessed via \code{members} active field, i.e., using \verb{$object} element. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$open(mode = c("READ", "WRITE"), instantiate = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{mode}}{Mode to open : either \code{"READ"} or \code{"WRITE"}. Default is \code{"READ"}.} - -\item{\code{instantiate}}{Should be all members be instantiated at opening? + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$open(mode = c("READ", "WRITE"), instantiate = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{mode}}{Mode to open : either \code{"READ"} or \code{"WRITE"}. Default is \code{"READ"}.} + \item{\code{instantiate}}{Should be all members be instantiated at opening? Default is \code{FALSE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The object, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -The object, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-close}{}}} -\subsection{Method \code{close()}}{ -Close the group object. +\subsection{\code{CAS$close()}}{ + Close the group object. All instantiated group members will be closed if opened, and before closing the group object. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$close()}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$close()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + The object, invisibly. + } } -\subsection{Returns}{ -The object, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-destroy}{}}} -\subsection{Method \code{destroy()}}{ -Delete CAS. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$destroy()}\if{html}{\out{
}} +\subsection{\code{CAS$destroy()}}{ + Delete CAS. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$destroy()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + The object, invisibly. + } } -\subsection{Returns}{ -The object, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-filter_keys}{}}} -\subsection{Method \code{filter_keys()}}{ -Filter \code{tbl_keys} by key and namespace -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$filter_keys(key, namespace, attrnames = character())}\if{html}{\out{
}} +\subsection{\code{CAS$filter_keys()}}{ + Filter \code{tbl_keys} by key and namespace + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$filter_keys(key, namespace, attrnames = character())} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{attrnames}}{A character vector with tiledb attributes (columns).} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A `data.table. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{attrnames}}{A character vector with tiledb attributes (columns).} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A `data.table. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-dir_tree}{}}} -\subsection{Method \code{dir_tree()}}{ -Print directory contents. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$dir_tree(what = c("all", "keys", "data"))}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{what}}{Select directory: 'all' for storr, 'keys' for \code{tbl_keys} +\subsection{\code{CAS$dir_tree()}}{ + Print directory contents. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$dir_tree(what = c("all", "keys", "data"))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{what}}{Select directory: 'all' for storr, 'keys' for \code{tbl_keys} array and 'data' for \code{tbl_data} array.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A character vector with file paths, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -A character vector with file paths, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-dump}{}}} -\subsection{Method \code{dump()}}{ -Dump the Storr structure to string. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$dump()}\if{html}{\out{
}} +\subsection{\code{CAS$dump()}}{ + Dump the Storr structure to string. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$dump()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A \code{character} string, invisibly. + } } -\subsection{Returns}{ -A \code{character} string, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-CAS-clone}{}}} -\subsection{Method \code{clone()}}{ -The objects of this class are cloneable with this method. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{CAS$clone(deep = FALSE)}\if{html}{\out{
}} +\subsection{\code{CAS$clone()}}{ + The objects of this class are cloneable with this method. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{CAS$clone(deep = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{deep}}{Whether to make a deep clone.} + } + \if{html}{\out{
}} + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{deep}}{Whether to make a deep clone.} -} -\if{html}{\out{
}} -} -} } diff --git a/man/StorrFragments.Rd b/man/StorrFragments.Rd index fed221c..a5812c5 100644 --- a/man/StorrFragments.Rd +++ b/man/StorrFragments.Rd @@ -11,54 +11,55 @@ A class for working with Storr TileDB Fragments. } \keyword{internal} \section{Active bindings}{ -\if{html}{\out{
}} -\describe{ -\item{\code{fob_keys}}{Retrieve the \link[R6.tiledb:TileDBFragments]{R6.tiledb::TileDBFragments} instance for \code{keys} + \if{html}{\out{
}} + \describe{ + \item{\code{fob_keys}}{Retrieve the \link[R6.tiledb:TileDBFragments]{TileDBFragments} instance for \code{keys} array.} -\item{\code{fob_data}}{Retrieve the \link[R6.tiledb:TileDBFragments]{R6.tiledb::TileDBFragments} instance for \code{data} + \item{\code{fob_data}}{Retrieve the \link[R6.tiledb:TileDBFragments]{TileDBFragments} instance for \code{data} array.} -\item{\code{size}}{Return directory size.} -} -\if{html}{\out{
}} + \item{\code{size}}{Return directory size.} + } + \if{html}{\out{
}} } \section{Methods}{ \subsection{Public methods}{ -\itemize{ -\item \href{#method-StorrFragments-new}{\code{StorrFragments$new()}} -\item \href{#method-StorrFragments-consolidate}{\code{StorrFragments$consolidate()}} -\item \href{#method-StorrFragments-vacuum}{\code{StorrFragments$vacuum()}} -\item \href{#method-StorrFragments-frag_num}{\code{StorrFragments$frag_num()}} -\item \href{#method-StorrFragments-to_vacuum_num}{\code{StorrFragments$to_vacuum_num()}} -\item \href{#method-StorrFragments-reload_finfo}{\code{StorrFragments$reload_finfo()}} -\item \href{#method-StorrFragments-print}{\code{StorrFragments$print()}} -} + \itemize{ + \item \href{#method-StorrFragments-initialize}{\code{StorrFragments$new()}} + \item \href{#method-StorrFragments-consolidate}{\code{StorrFragments$consolidate()}} + \item \href{#method-StorrFragments-vacuum}{\code{StorrFragments$vacuum()}} + \item \href{#method-StorrFragments-frag_num}{\code{StorrFragments$frag_num()}} + \item \href{#method-StorrFragments-to_vacuum_num}{\code{StorrFragments$to_vacuum_num()}} + \item \href{#method-StorrFragments-reload_finfo}{\code{StorrFragments$reload_finfo()}} + \item \href{#method-StorrFragments-print}{\code{StorrFragments$print()}} + } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-StorrFragments-new}{}}} -\subsection{Method \code{new()}}{ -Create a new \code{StorrFragments} instance. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$new(uri, ctx = NULL)}\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-StorrFragments-initialize}{}}} +\subsection{\code{StorrFragments$new()}}{ + Create a new \code{StorrFragments} instance. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$new(uri, ctx = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{uri}}{URI path for TileDB Storr.} + \item{\code{ctx}}{Optional \code{\link[tiledb:tiledb_ctx]{tiledb::tiledb_ctx()}} object.} + } + \if{html}{\out{
}} + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{uri}}{URI path for TileDB Storr.} - -\item{\code{ctx}}{Optional \code{\link[tiledb:tiledb_ctx]{tiledb::tiledb_ctx()}} object.} -} -\if{html}{\out{
}} -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-StorrFragments-consolidate}{}}} -\subsection{Method \code{consolidate()}}{ -Consolidates the 'storr' fragments. +\subsection{\code{StorrFragments$consolidate()}}{ + Consolidates the 'storr' fragments. Consolidation in TileDB merges multiple array fragments into a single fragment to improve query performance by reducing the number of files that @@ -68,112 +69,119 @@ The consolidation process is not deleting the old fragments. To clear the consolidated fragments after the process, set \code{vacuum = TRUE} which will invoke the vacuum process. Alternatively, use the class method \verb{$vacuum()}. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$consolidate(what = c("all", "keys", "data"), cfg = NULL, - vacuum = FALSE, async = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{what}}{Which array should be consolidated? Defaults to \code{"all"} arrays.} - -\item{\code{cfg}}{A configuration object \code{\link[tiledb:tiledb_config]{tiledb::tiledb_config()}} to override context + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$consolidate(what = c("all", "keys", "data"), cfg = NULL, + vacuum = FALSE, async = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{what}}{Which array should be consolidated? Defaults to \code{"all"} arrays.} + \item{\code{cfg}}{A configuration object \code{\link[tiledb:tiledb_config]{tiledb::tiledb_config()}} to override context configuration. When \code{NULL} (default) the configuration parameters will be retrieved from object's context.} - -\item{\code{vacuum}}{Should the old fragments (consolidated) be deleted? Default is \code{FALSE}.} - -\item{\code{async}}{Should it consolidate asynchronously? Default is \code{FALSE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -When \code{async = FALSE}, it returns \code{TRUE} for successful consolidation. + \item{\code{vacuum}}{Should the old fragments (consolidated) be deleted? Default is \code{FALSE}.} + \item{\code{async}}{Should it consolidate asynchronously? Default is \code{FALSE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + When \code{async = FALSE}, it returns \code{TRUE} for successful consolidation. For \code{async = TRUE}, it returns a \code{\link[mirai:mirai]{mirai::mirai()}} object immediately; once resolved, it returns \code{TRUE} indicating consolidation success. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-StorrFragments-vacuum}{}}} -\subsection{Method \code{vacuum()}}{ -Vacuum Storr fragments +\subsection{\code{StorrFragments$vacuum()}}{ + Vacuum Storr fragments This operation deletes the old fragments (consolidated). -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$vacuum(what = c("all", "keys", "data"), cfg = NULL, - async = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{what}}{Which array to vacuum? Defaults to \code{"all"} arrays.} - -\item{\code{cfg}}{A configuration object \code{\link[tiledb:tiledb_config]{tiledb::tiledb_config()}} to override context + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$vacuum(what = c("all", "keys", "data"), cfg = NULL, + async = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{what}}{Which array to vacuum? Defaults to \code{"all"} arrays.} + \item{\code{cfg}}{A configuration object \code{\link[tiledb:tiledb_config]{tiledb::tiledb_config()}} to override context configuration. When \code{NULL} (default) the configuration parameters will be retrieved from object's context.} - -\item{\code{async}}{Should it vacuum asynchronously? Default is \code{FALSE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -When \code{async = FALSE}, it returns \code{TRUE} for successful vacuuming. + \item{\code{async}}{Should it vacuum asynchronously? Default is \code{FALSE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + When \code{async = FALSE}, it returns \code{TRUE} for successful vacuuming. For \code{async = TRUE}, it returns a \code{\link[mirai:mirai]{mirai::mirai()}} object immediately; once resolved, it returns \code{TRUE} indicating vacuum success. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-StorrFragments-frag_num}{}}} -\subsection{Method \code{frag_num()}}{ -Get the number of fragments. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$frag_num()}\if{html}{\out{
}} +\subsection{\code{StorrFragments$frag_num()}}{ + Get the number of fragments. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$frag_num()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A numeric value. + } } -\subsection{Returns}{ -A numeric value. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-StorrFragments-to_vacuum_num}{}}} -\subsection{Method \code{to_vacuum_num()}}{ -Return the number of fragments to vacuum. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$to_vacuum_num()}\if{html}{\out{
}} +\subsection{\code{StorrFragments$to_vacuum_num()}}{ + Return the number of fragments to vacuum. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$to_vacuum_num()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A numeric value. + } } -\subsection{Returns}{ -A numeric value. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-StorrFragments-reload_finfo}{}}} -\subsection{Method \code{reload_finfo()}}{ -Refresh the Storr's Fragment Info objects. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$reload_finfo()}\if{html}{\out{
}} +\subsection{\code{StorrFragments$reload_finfo()}}{ + Refresh the Storr's Fragment Info objects. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$reload_finfo()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + The object, invisibly. + } } -\subsection{Returns}{ -The object, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-StorrFragments-print}{}}} -\subsection{Method \code{print()}}{ -Print Fragments class. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{StorrFragments$print()}\if{html}{\out{
}} +\subsection{\code{StorrFragments$print()}}{ + Print Fragments class. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{StorrFragments$print()} + \if{html}{\out{
}} + } } } -} diff --git a/man/TileDBDriver.Rd b/man/TileDBDriver.Rd index 75e932c..f532ebf 100644 --- a/man/TileDBDriver.Rd +++ b/man/TileDBDriver.Rd @@ -11,799 +11,835 @@ An R6 class that represents a content addressed storage driver that complies with 'storr' interface using TileDB Embedded as a back-end. -This class is intended for usage in \link[storr:storr]{storr::storr} or \link{TileDBStorr}. +This class is intended for usage in \link[storr:storr]{storr} or \link{TileDBStorr}. } \keyword{internal} \section{Super classes}{ -\code{\link[R6.tiledb:TileDBObject]{R6.tiledb::TileDBObject}} -> \code{\link[R6.tiledb:TileDBGroup]{R6.tiledb::TileDBGroup}} -> \code{\link[storr.tiledb:CAS]{storr.tiledb::CAS}} -> \code{TileDBDriver} +\code{\link[R6.tiledb:TileDBObject]{R6.tiledb::TileDBObject}} -> \code{\link[R6.tiledb:TileDBGroup]{R6.tiledb::TileDBGroup}} -> \code{\link[storr.tiledb:CAS]{CAS}} -> \code{TileDBDriver} } \section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{traits}}{Driver traits (\strong{immutable}).} + \if{html}{\out{
}} + \describe{ + \item{\code{traits}}{Driver traits (\strong{immutable}).} -\item{\code{binary}}{Binary toggle, default is \code{FALSE} (\strong{immutable}).} -} -\if{html}{\out{
}} + \item{\code{binary}}{Binary toggle, default is \code{FALSE} (\strong{immutable}).} + } + \if{html}{\out{
}} } \section{Methods}{ \subsection{Public methods}{ -\itemize{ -\item \href{#method-TileDBDriver-new}{\code{TileDBDriver$new()}} -\item \href{#method-TileDBDriver-type}{\code{TileDBDriver$type()}} -\item \href{#method-TileDBDriver-get_hash}{\code{TileDBDriver$get_hash()}} -\item \href{#method-TileDBDriver-mget_hash}{\code{TileDBDriver$mget_hash()}} -\item \href{#method-TileDBDriver-set_hash}{\code{TileDBDriver$set_hash()}} -\item \href{#method-TileDBDriver-mset_hash}{\code{TileDBDriver$mset_hash()}} -\item \href{#method-TileDBDriver-get_object}{\code{TileDBDriver$get_object()}} -\item \href{#method-TileDBDriver-mget_object}{\code{TileDBDriver$mget_object()}} -\item \href{#method-TileDBDriver-set_object}{\code{TileDBDriver$set_object()}} -\item \href{#method-TileDBDriver-mset_object}{\code{TileDBDriver$mset_object()}} -\item \href{#method-TileDBDriver-set_keymeta}{\code{TileDBDriver$set_keymeta()}} -\item \href{#method-TileDBDriver-mset_keymeta}{\code{TileDBDriver$mset_keymeta()}} -\item \href{#method-TileDBDriver-get_keymeta}{\code{TileDBDriver$get_keymeta()}} -\item \href{#method-TileDBDriver-mget_keymeta}{\code{TileDBDriver$mget_keymeta()}} -\item \href{#method-TileDBDriver-exists_hash}{\code{TileDBDriver$exists_hash()}} -\item \href{#method-TileDBDriver-exists_object}{\code{TileDBDriver$exists_object()}} -\item \href{#method-TileDBDriver-del_hash}{\code{TileDBDriver$del_hash()}} -\item \href{#method-TileDBDriver-del_object}{\code{TileDBDriver$del_object()}} -\item \href{#method-TileDBDriver-list_hashes}{\code{TileDBDriver$list_hashes()}} -\item \href{#method-TileDBDriver-list_namespaces}{\code{TileDBDriver$list_namespaces()}} -\item \href{#method-TileDBDriver-list_keys}{\code{TileDBDriver$list_keys()}} -\item \href{#method-TileDBDriver-list_unused_hashes}{\code{TileDBDriver$list_unused_hashes()}} -\item \href{#method-TileDBDriver-delete_unused_hashes}{\code{TileDBDriver$delete_unused_hashes()}} -\item \href{#method-TileDBDriver-delete_namespaces}{\code{TileDBDriver$delete_namespaces()}} -\item \href{#method-TileDBDriver-keys_with_expiration}{\code{TileDBDriver$keys_with_expiration()}} -\item \href{#method-TileDBDriver-keys_without_expiration}{\code{TileDBDriver$keys_without_expiration()}} -\item \href{#method-TileDBDriver-expired_keys}{\code{TileDBDriver$expired_keys()}} -\item \href{#method-TileDBDriver-unexpired_keys}{\code{TileDBDriver$unexpired_keys()}} -\item \href{#method-TileDBDriver-delete_expired_keys}{\code{TileDBDriver$delete_expired_keys()}} -\item \href{#method-TileDBDriver-num_expired_keys}{\code{TileDBDriver$num_expired_keys()}} -\item \href{#method-TileDBDriver-num_unexpired_keys}{\code{TileDBDriver$num_unexpired_keys()}} -\item \href{#method-TileDBDriver-has_expired_keys}{\code{TileDBDriver$has_expired_keys()}} -\item \href{#method-TileDBDriver-has_unexpired_keys}{\code{TileDBDriver$has_unexpired_keys()}} -\item \href{#method-TileDBDriver-export_tdb}{\code{TileDBDriver$export_tdb()}} -} -} -\if{html}{\out{ -
Inherited methods + \itemize{ + \item \href{#method-TileDBDriver-initialize}{\code{TileDBDriver$new()}} + \item \href{#method-TileDBDriver-type}{\code{TileDBDriver$type()}} + \item \href{#method-TileDBDriver-get_hash}{\code{TileDBDriver$get_hash()}} + \item \href{#method-TileDBDriver-mget_hash}{\code{TileDBDriver$mget_hash()}} + \item \href{#method-TileDBDriver-set_hash}{\code{TileDBDriver$set_hash()}} + \item \href{#method-TileDBDriver-mset_hash}{\code{TileDBDriver$mset_hash()}} + \item \href{#method-TileDBDriver-get_object}{\code{TileDBDriver$get_object()}} + \item \href{#method-TileDBDriver-mget_object}{\code{TileDBDriver$mget_object()}} + \item \href{#method-TileDBDriver-set_object}{\code{TileDBDriver$set_object()}} + \item \href{#method-TileDBDriver-mset_object}{\code{TileDBDriver$mset_object()}} + \item \href{#method-TileDBDriver-set_keymeta}{\code{TileDBDriver$set_keymeta()}} + \item \href{#method-TileDBDriver-mset_keymeta}{\code{TileDBDriver$mset_keymeta()}} + \item \href{#method-TileDBDriver-get_keymeta}{\code{TileDBDriver$get_keymeta()}} + \item \href{#method-TileDBDriver-mget_keymeta}{\code{TileDBDriver$mget_keymeta()}} + \item \href{#method-TileDBDriver-exists_hash}{\code{TileDBDriver$exists_hash()}} + \item \href{#method-TileDBDriver-exists_object}{\code{TileDBDriver$exists_object()}} + \item \href{#method-TileDBDriver-del_hash}{\code{TileDBDriver$del_hash()}} + \item \href{#method-TileDBDriver-del_object}{\code{TileDBDriver$del_object()}} + \item \href{#method-TileDBDriver-list_hashes}{\code{TileDBDriver$list_hashes()}} + \item \href{#method-TileDBDriver-list_namespaces}{\code{TileDBDriver$list_namespaces()}} + \item \href{#method-TileDBDriver-list_keys}{\code{TileDBDriver$list_keys()}} + \item \href{#method-TileDBDriver-list_unused_hashes}{\code{TileDBDriver$list_unused_hashes()}} + \item \href{#method-TileDBDriver-delete_unused_hashes}{\code{TileDBDriver$delete_unused_hashes()}} + \item \href{#method-TileDBDriver-delete_namespaces}{\code{TileDBDriver$delete_namespaces()}} + \item \href{#method-TileDBDriver-keys_with_expiration}{\code{TileDBDriver$keys_with_expiration()}} + \item \href{#method-TileDBDriver-keys_without_expiration}{\code{TileDBDriver$keys_without_expiration()}} + \item \href{#method-TileDBDriver-expired_keys}{\code{TileDBDriver$expired_keys()}} + \item \href{#method-TileDBDriver-unexpired_keys}{\code{TileDBDriver$unexpired_keys()}} + \item \href{#method-TileDBDriver-delete_expired_keys}{\code{TileDBDriver$delete_expired_keys()}} + \item \href{#method-TileDBDriver-num_expired_keys}{\code{TileDBDriver$num_expired_keys()}} + \item \href{#method-TileDBDriver-num_unexpired_keys}{\code{TileDBDriver$num_unexpired_keys()}} + \item \href{#method-TileDBDriver-has_expired_keys}{\code{TileDBDriver$has_expired_keys()}} + \item \href{#method-TileDBDriver-has_unexpired_keys}{\code{TileDBDriver$has_unexpired_keys()}} + \item \href{#method-TileDBDriver-export_tdb}{\code{TileDBDriver$export_tdb()}} + } +} +\if{html}{\out{
Inherited methods -
-}} -\if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-TileDBDriver-new}{}}} -\subsection{Method \code{new()}}{ -Create a new \code{TileDBDriver} object. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$new(uri, ctx = NULL)}\if{html}{\out{
}} +
}} +\if{html}{\out{
}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-TileDBDriver-initialize}{}}} +\subsection{\code{TileDBDriver$new()}}{ + Create a new \code{TileDBDriver} object. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$new(uri, ctx = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{uri}}{URI path for the \code{TileDBDriver} object.} + \item{\code{ctx}}{Optional \code{\link[tiledb:tiledb_ctx]{tiledb::tiledb_ctx()}} object.} + } + \if{html}{\out{
}} + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{uri}}{URI path for the \code{TileDBDriver} object.} - -\item{\code{ctx}}{Optional \code{\link[tiledb:tiledb_ctx]{tiledb::tiledb_ctx()}} object.} -} -\if{html}{\out{
}} -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-type}{}}} -\subsection{Method \code{type()}}{ -Driver type. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$type()}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$type()}}{ + Driver type. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$type()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A character string. + } } -\subsection{Returns}{ -A character string. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-get_hash}{}}} -\subsection{Method \code{get_hash()}}{ -Get hash values. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$get_hash(key, namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$get_hash()}}{ + Get hash values. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$get_hash(key, namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hashes. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hashes. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-mget_hash}{}}} -\subsection{Method \code{mget_hash()}}{ -Get hash values. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$mget_hash(key, namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$mget_hash()}}{ + Get hash values. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$mget_hash(key, namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hashes. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hashes. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-set_hash}{}}} -\subsection{Method \code{set_hash()}}{ -Set hash values. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$set_hash(key, namespace, hash, expires_at, notes)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$set_hash()}}{ + Set hash values. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$set_hash(key, namespace, hash, expires_at, notes)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{hash}}{A vector of hash values.} + \item{\code{expires_at}}{A vector of expiration datetimes.} + \item{\code{notes}}{A character vector of notes.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for successful operation, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{hash}}{A vector of hash values.} - -\item{\code{expires_at}}{A vector of expiration datetimes.} - -\item{\code{notes}}{A character vector of notes.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for successful operation, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-mset_hash}{}}} -\subsection{Method \code{mset_hash()}}{ -Set hash values. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$mset_hash(key, namespace, hash, expires_at, notes)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$mset_hash()}}{ + Set hash values. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$mset_hash(key, namespace, hash, expires_at, notes)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{hash}}{A vector of hash values.} + \item{\code{expires_at}}{A vector of expiration datetimes.} + \item{\code{notes}}{A character vector of notes.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for successful operation, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{hash}}{A vector of hash values.} - -\item{\code{expires_at}}{A vector of expiration datetimes.} - -\item{\code{notes}}{A character vector of notes.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for successful operation, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-get_object}{}}} -\subsection{Method \code{get_object()}}{ -Get R object given a hash. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$get_object(hash)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$get_object()}}{ + Get R object given a hash. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$get_object(hash)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A hash value.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A de-serialized R object. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A hash value.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A de-serialized R object. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-mget_object}{}}} -\subsection{Method \code{mget_object()}}{ -Get a list R objects given a hash vector. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$mget_object(hash)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$mget_object()}}{ + Get a list R objects given a hash vector. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$mget_object(hash)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A list with de-serialized R objects. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A list with de-serialized R objects. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-set_object}{}}} -\subsection{Method \code{set_object()}}{ -Store serialised R objects. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$set_object(hash, value)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$set_object()}}{ + Store serialised R objects. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$set_object(hash, value)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values.} + \item{\code{value}}{A vector with serialised values.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for successful operation, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values.} - -\item{\code{value}}{A vector with serialised values.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for successful operation, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-mset_object}{}}} -\subsection{Method \code{mset_object()}}{ -Store serialised R objects. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$mset_object(hash, value)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$mset_object()}}{ + Store serialised R objects. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$mset_object(hash, value)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values.} + \item{\code{value}}{A vector with serialised values.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for successful operation, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values.} - -\item{\code{value}}{A vector with serialised values.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for successful operation, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-set_keymeta}{}}} -\subsection{Method \code{set_keymeta()}}{ -Set key-namespace metadata. +\subsection{\code{TileDBDriver$set_keymeta()}}{ + Set key-namespace metadata. Sets a pair of expiry date-time and notes. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$set_keymeta(key, namespace, expires_at, notes)}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$set_keymeta(key, namespace, expires_at, notes)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of expiration datetimes.} + \item{\code{notes}}{A character vector of notes.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for successful operation, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of expiration datetimes.} - -\item{\code{notes}}{A character vector of notes.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for successful operation, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-mset_keymeta}{}}} -\subsection{Method \code{mset_keymeta()}}{ -Set multiple key-namespace metadata. +\subsection{\code{TileDBDriver$mset_keymeta()}}{ + Set multiple key-namespace metadata. Sets a pair of expiry date-time and notes. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$mset_keymeta(key, namespace, expires_at, notes)}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$mset_keymeta(key, namespace, expires_at, notes)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of expiration datetimes.} + \item{\code{notes}}{A character vector of notes.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for successful operation, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of expiration datetimes.} - -\item{\code{notes}}{A character vector of notes.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for successful operation, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-get_keymeta}{}}} -\subsection{Method \code{get_keymeta()}}{ -Get key-namespace metadata. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$get_keymeta(key, namespace)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A single character key.} - -\item{\code{namespace}}{A single character namespace.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A named list with key-metadata, \code{"expires_at"} +\subsection{\code{TileDBDriver$get_keymeta()}}{ + Get key-namespace metadata. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$get_keymeta(key, namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A single character key.} + \item{\code{namespace}}{A single character namespace.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A named list with key-metadata, \code{"expires_at"} and \verb{"notes".} + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-mget_keymeta}{}}} -\subsection{Method \code{mget_keymeta()}}{ -Get multiple key-namespace metadata. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$mget_keymeta(key, namespace, nomatch = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{nomatch}}{Value to fill in case of no match.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A list with key metadata for each key-namespace +\subsection{\code{TileDBDriver$mget_keymeta()}}{ + Get multiple key-namespace metadata. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$mget_keymeta(key, namespace, nomatch = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{nomatch}}{Value to fill in case of no match.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A list with key metadata for each key-namespace pair. For not found pairs will return the nomatch value. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-exists_hash}{}}} -\subsection{Method \code{exists_hash()}}{ -Check a key-namespace pair exists. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$exists_hash(key, namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$exists_hash()}}{ + Check a key-namespace pair exists. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$exists_hash(key, namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-exists_object}{}}} -\subsection{Method \code{exists_object()}}{ -Check a serialised object exists. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$exists_object(hash)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$exists_object()}}{ + Check a serialised object exists. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$exists_object(hash)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-del_hash}{}}} -\subsection{Method \code{del_hash()}}{ -Delete a key/namespace pair. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$del_hash(key, namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$del_hash()}}{ + Delete a key/namespace pair. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$del_hash(key, namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of keys.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of keys.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-del_object}{}}} -\subsection{Method \code{del_object()}}{ -Delete serialised objects. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$del_object(hash)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$del_object()}}{ + Delete serialised objects. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$del_object(hash)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-list_hashes}{}}} -\subsection{Method \code{list_hashes()}}{ -List all hash values. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$list_hashes()}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$list_hashes()}}{ + List all hash values. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$list_hashes()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hash values. + } } -\subsection{Returns}{ -A vector of hash values. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-list_namespaces}{}}} -\subsection{Method \code{list_namespaces()}}{ -List all namespace values. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$list_namespaces()}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$list_namespaces()}}{ + List all namespace values. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$list_namespaces()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of namespace values. + } } -\subsection{Returns}{ -A vector of namespace values. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-list_keys}{}}} -\subsection{Method \code{list_keys()}}{ -List keys given a namespace. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$list_keys(namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$list_keys()}}{ + List keys given a namespace. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$list_keys(namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A single character namespace.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of key values. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A single character namespace.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of key values. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-list_unused_hashes}{}}} -\subsection{Method \code{list_unused_hashes()}}{ -List unused hashes. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$list_unused_hashes()}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$list_unused_hashes()}}{ + List unused hashes. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$list_unused_hashes()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hash values. + } } -\subsection{Returns}{ -A vector of hash values. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-delete_unused_hashes}{}}} -\subsection{Method \code{delete_unused_hashes()}}{ -Delete unused hashes. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$delete_unused_hashes()}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$delete_unused_hashes()}}{ + Delete unused hashes. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$delete_unused_hashes()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of deleted hash values, invisibly. + } } -\subsection{Returns}{ -A vector of deleted hash values, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-delete_namespaces}{}}} -\subsection{Method \code{delete_namespaces()}}{ -Delete namespaces. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$delete_namespaces(ns)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{ns}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector indicating successful deletion or not. +\subsection{\code{TileDBDriver$delete_namespaces()}}{ + Delete namespaces. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$delete_namespaces(ns)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{ns}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector indicating successful deletion or not. \code{FALSE} means the namespace was not found in database. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-keys_with_expiration}{}}} -\subsection{Method \code{keys_with_expiration()}}{ -Get the key-namespace pairs with expiration timestamps. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$keys_with_expiration(namespace, datetimes = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{datetimes}}{Should the \code{expires_at} column be returned? +\subsection{\code{TileDBDriver$keys_with_expiration()}}{ + Get the key-namespace pairs with expiration timestamps. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$keys_with_expiration(namespace, datetimes = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{datetimes}}{Should the \code{expires_at} column be returned? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An \code{ArrowObject} object. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -An \code{ArrowObject} object. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-keys_without_expiration}{}}} -\subsection{Method \code{keys_without_expiration()}}{ -Get the key-namespace pairs without expiration timestamps. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$keys_without_expiration(namespace, datetimes = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{datetimes}}{Should the \code{expires_at} column be returned? +\subsection{\code{TileDBDriver$keys_without_expiration()}}{ + Get the key-namespace pairs without expiration timestamps. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$keys_without_expiration(namespace, datetimes = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{datetimes}}{Should the \code{expires_at} column be returned? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An \code{ArrowObject} object. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -An \code{ArrowObject} object. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-expired_keys}{}}} -\subsection{Method \code{expired_keys()}}{ -Get the expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$expired_keys(namespace, datetimes = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{datetimes}}{Should the \code{expires_at} column be returned? +\subsection{\code{TileDBDriver$expired_keys()}}{ + Get the expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$expired_keys(namespace, datetimes = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{datetimes}}{Should the \code{expires_at} column be returned? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An \code{ArrowObject} object. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -An \code{ArrowObject} object. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-unexpired_keys}{}}} -\subsection{Method \code{unexpired_keys()}}{ -Get the unexpired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$unexpired_keys(namespace, datetimes = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{datetimes}}{Should the \code{expires_at} column be returned? +\subsection{\code{TileDBDriver$unexpired_keys()}}{ + Get the unexpired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$unexpired_keys(namespace, datetimes = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{datetimes}}{Should the \code{expires_at} column be returned? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An \code{ArrowObject} object. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -An \code{ArrowObject} object. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-delete_expired_keys}{}}} -\subsection{Method \code{delete_expired_keys()}}{ -Get the expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$delete_expired_keys(namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$delete_expired_keys()}}{ + Get the expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$delete_expired_keys(namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A boolean value \code{TRUE} indicating success, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A boolean value \code{TRUE} indicating success, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-num_expired_keys}{}}} -\subsection{Method \code{num_expired_keys()}}{ -Get the number of expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$num_expired_keys(namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$num_expired_keys()}}{ + Get the number of expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$num_expired_keys(namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A numeric value. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A numeric value. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-num_unexpired_keys}{}}} -\subsection{Method \code{num_unexpired_keys()}}{ -Get the number of unexpired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$num_unexpired_keys(namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$num_unexpired_keys()}}{ + Get the number of unexpired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$num_unexpired_keys(namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A numeric value. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A numeric value. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-has_expired_keys}{}}} -\subsection{Method \code{has_expired_keys()}}{ -Check for expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$has_expired_keys(namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$has_expired_keys()}}{ + Check for expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$has_expired_keys(namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for expired keys, \code{FALSE} otherwise. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for expired keys, \code{FALSE} otherwise. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-has_unexpired_keys}{}}} -\subsection{Method \code{has_unexpired_keys()}}{ -Check for unexpired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$has_unexpired_keys(namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$has_unexpired_keys()}}{ + Check for unexpired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$has_unexpired_keys(namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for unexpired keys, \code{FALSE} otherwise. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for unexpired keys, \code{FALSE} otherwise. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBDriver-export_tdb}{}}} -\subsection{Method \code{export_tdb()}}{ -Export objects from storr to another TileDB storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBDriver$export_tdb(key, namespace, dest_driver)}\if{html}{\out{
}} +\subsection{\code{TileDBDriver$export_tdb()}}{ + Export objects from storr to another TileDB storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBDriver$export_tdb(key, namespace, dest_driver)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of source keys.} + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{dest_driver}}{The destination TileDB driver, See \code{\link[=driver_tiledb]{driver_tiledb()}}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical \code{TRUE} indicating successful export, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of source keys.} - -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{dest_driver}}{The destination TileDB driver, See \code{\link[=driver_tiledb]{driver_tiledb()}}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical \code{TRUE} indicating successful export, invisibly. -} -} } diff --git a/man/TileDBStorr.Rd b/man/TileDBStorr.Rd index 9f3f73b..80cb637 100644 --- a/man/TileDBStorr.Rd +++ b/man/TileDBStorr.Rd @@ -26,753 +26,731 @@ usage is through \code{\link[=storr_tiledb]{storr_tiledb()}}. } \keyword{internal} \section{Public fields}{ -\if{html}{\out{
}} -\describe{ -\item{\code{envir}}{The object hash table.} + \if{html}{\out{
}} + \describe{ + \item{\code{envir}}{The object hash table.} -\item{\code{envir_metadata}}{The key metadata hash table.} + \item{\code{envir_metadata}}{The key metadata hash table.} -\item{\code{default_namespace}}{The default namespace.} + \item{\code{default_namespace}}{The default namespace.} -\item{\code{traits}}{Driver traits.} + \item{\code{traits}}{Driver traits.} -\item{\code{hash_raw}}{The hash function.} + \item{\code{hash_raw}}{The hash function.} -\item{\code{serialize_object}}{The serialisation function.} -} -\if{html}{\out{
}} + \item{\code{serialize_object}}{The serialisation function.} + } + \if{html}{\out{
}} } \section{Active bindings}{ -\if{html}{\out{
}} -\describe{ -\item{\code{async_info}}{\code{mirai} information} + \if{html}{\out{
}} + \describe{ + \item{\code{async_info}}{\code{mirai} information} -\item{\code{size}}{Return Storr size} -} -\if{html}{\out{
}} + \item{\code{size}}{Return Storr size} + } + \if{html}{\out{
}} } \section{Methods}{ \subsection{Public methods}{ -\itemize{ -\item \href{#method-TileDBStorr-new}{\code{TileDBStorr$new()}} -\item \href{#method-TileDBStorr-destroy}{\code{TileDBStorr$destroy()}} -\item \href{#method-TileDBStorr-flush_cache}{\code{TileDBStorr$flush_cache()}} -\item \href{#method-TileDBStorr-set}{\code{TileDBStorr$set()}} -\item \href{#method-TileDBStorr-mset}{\code{TileDBStorr$mset()}} -\item \href{#method-TileDBStorr-set_async}{\code{TileDBStorr$set_async()}} -\item \href{#method-TileDBStorr-mset_async}{\code{TileDBStorr$mset_async()}} -\item \href{#method-TileDBStorr-set_by_value}{\code{TileDBStorr$set_by_value()}} -\item \href{#method-TileDBStorr-mset_by_value}{\code{TileDBStorr$mset_by_value()}} -\item \href{#method-TileDBStorr-set_by_value_async}{\code{TileDBStorr$set_by_value_async()}} -\item \href{#method-TileDBStorr-mset_by_value_async}{\code{TileDBStorr$mset_by_value_async()}} -\item \href{#method-TileDBStorr-set_value}{\code{TileDBStorr$set_value()}} -\item \href{#method-TileDBStorr-mset_value}{\code{TileDBStorr$mset_value()}} -\item \href{#method-TileDBStorr-get}{\code{TileDBStorr$get()}} -\item \href{#method-TileDBStorr-mget}{\code{TileDBStorr$mget()}} -\item \href{#method-TileDBStorr-get_hash}{\code{TileDBStorr$get_hash()}} -\item \href{#method-TileDBStorr-mget_hash}{\code{TileDBStorr$mget_hash()}} -\item \href{#method-TileDBStorr-hash_object}{\code{TileDBStorr$hash_object()}} -\item \href{#method-TileDBStorr-get_value}{\code{TileDBStorr$get_value()}} -\item \href{#method-TileDBStorr-mget_value}{\code{TileDBStorr$mget_value()}} -\item \href{#method-TileDBStorr-set_keymeta}{\code{TileDBStorr$set_keymeta()}} -\item \href{#method-TileDBStorr-mset_keymeta}{\code{TileDBStorr$mset_keymeta()}} -\item \href{#method-TileDBStorr-set_keymeta_async}{\code{TileDBStorr$set_keymeta_async()}} -\item \href{#method-TileDBStorr-mset_keymeta_async}{\code{TileDBStorr$mset_keymeta_async()}} -\item \href{#method-TileDBStorr-get_keymeta}{\code{TileDBStorr$get_keymeta()}} -\item \href{#method-TileDBStorr-mget_keymeta}{\code{TileDBStorr$mget_keymeta()}} -\item \href{#method-TileDBStorr-clr_keymeta}{\code{TileDBStorr$clr_keymeta()}} -\item \href{#method-TileDBStorr-clr_keymeta_async}{\code{TileDBStorr$clr_keymeta_async()}} -\item \href{#method-TileDBStorr-fill}{\code{TileDBStorr$fill()}} -\item \href{#method-TileDBStorr-duplicate}{\code{TileDBStorr$duplicate()}} -\item \href{#method-TileDBStorr-clear}{\code{TileDBStorr$clear()}} -\item \href{#method-TileDBStorr-exists}{\code{TileDBStorr$exists()}} -\item \href{#method-TileDBStorr-exists_object}{\code{TileDBStorr$exists_object()}} -\item \href{#method-TileDBStorr-del}{\code{TileDBStorr$del()}} -\item \href{#method-TileDBStorr-keys_with_expiration}{\code{TileDBStorr$keys_with_expiration()}} -\item \href{#method-TileDBStorr-expired_keys}{\code{TileDBStorr$expired_keys()}} -\item \href{#method-TileDBStorr-has_expired_keys}{\code{TileDBStorr$has_expired_keys()}} -\item \href{#method-TileDBStorr-clear_expired_keys}{\code{TileDBStorr$clear_expired_keys()}} -\item \href{#method-TileDBStorr-list}{\code{TileDBStorr$list()}} -\item \href{#method-TileDBStorr-list_hashes}{\code{TileDBStorr$list_hashes()}} -\item \href{#method-TileDBStorr-list_namespaces}{\code{TileDBStorr$list_namespaces()}} -\item \href{#method-TileDBStorr-gc}{\code{TileDBStorr$gc()}} -\item \href{#method-TileDBStorr-import}{\code{TileDBStorr$import()}} -\item \href{#method-TileDBStorr-export}{\code{TileDBStorr$export()}} -\item \href{#method-TileDBStorr-index_export}{\code{TileDBStorr$index_export()}} -\item \href{#method-TileDBStorr-index_import}{\code{TileDBStorr$index_import()}} -\item \href{#method-TileDBStorr-export_tdb}{\code{TileDBStorr$export_tdb()}} -} + \itemize{ + \item \href{#method-TileDBStorr-initialize}{\code{TileDBStorr$new()}} + \item \href{#method-TileDBStorr-destroy}{\code{TileDBStorr$destroy()}} + \item \href{#method-TileDBStorr-flush_cache}{\code{TileDBStorr$flush_cache()}} + \item \href{#method-TileDBStorr-set}{\code{TileDBStorr$set()}} + \item \href{#method-TileDBStorr-mset}{\code{TileDBStorr$mset()}} + \item \href{#method-TileDBStorr-set_async}{\code{TileDBStorr$set_async()}} + \item \href{#method-TileDBStorr-mset_async}{\code{TileDBStorr$mset_async()}} + \item \href{#method-TileDBStorr-set_by_value}{\code{TileDBStorr$set_by_value()}} + \item \href{#method-TileDBStorr-mset_by_value}{\code{TileDBStorr$mset_by_value()}} + \item \href{#method-TileDBStorr-set_by_value_async}{\code{TileDBStorr$set_by_value_async()}} + \item \href{#method-TileDBStorr-mset_by_value_async}{\code{TileDBStorr$mset_by_value_async()}} + \item \href{#method-TileDBStorr-set_value}{\code{TileDBStorr$set_value()}} + \item \href{#method-TileDBStorr-mset_value}{\code{TileDBStorr$mset_value()}} + \item \href{#method-TileDBStorr-get}{\code{TileDBStorr$get()}} + \item \href{#method-TileDBStorr-mget}{\code{TileDBStorr$mget()}} + \item \href{#method-TileDBStorr-get_hash}{\code{TileDBStorr$get_hash()}} + \item \href{#method-TileDBStorr-mget_hash}{\code{TileDBStorr$mget_hash()}} + \item \href{#method-TileDBStorr-hash_object}{\code{TileDBStorr$hash_object()}} + \item \href{#method-TileDBStorr-get_value}{\code{TileDBStorr$get_value()}} + \item \href{#method-TileDBStorr-mget_value}{\code{TileDBStorr$mget_value()}} + \item \href{#method-TileDBStorr-set_keymeta}{\code{TileDBStorr$set_keymeta()}} + \item \href{#method-TileDBStorr-mset_keymeta}{\code{TileDBStorr$mset_keymeta()}} + \item \href{#method-TileDBStorr-set_keymeta_async}{\code{TileDBStorr$set_keymeta_async()}} + \item \href{#method-TileDBStorr-mset_keymeta_async}{\code{TileDBStorr$mset_keymeta_async()}} + \item \href{#method-TileDBStorr-get_keymeta}{\code{TileDBStorr$get_keymeta()}} + \item \href{#method-TileDBStorr-mget_keymeta}{\code{TileDBStorr$mget_keymeta()}} + \item \href{#method-TileDBStorr-clr_keymeta}{\code{TileDBStorr$clr_keymeta()}} + \item \href{#method-TileDBStorr-clr_keymeta_async}{\code{TileDBStorr$clr_keymeta_async()}} + \item \href{#method-TileDBStorr-fill}{\code{TileDBStorr$fill()}} + \item \href{#method-TileDBStorr-duplicate}{\code{TileDBStorr$duplicate()}} + \item \href{#method-TileDBStorr-clear}{\code{TileDBStorr$clear()}} + \item \href{#method-TileDBStorr-exists}{\code{TileDBStorr$exists()}} + \item \href{#method-TileDBStorr-exists_object}{\code{TileDBStorr$exists_object()}} + \item \href{#method-TileDBStorr-del}{\code{TileDBStorr$del()}} + \item \href{#method-TileDBStorr-keys_with_expiration}{\code{TileDBStorr$keys_with_expiration()}} + \item \href{#method-TileDBStorr-expired_keys}{\code{TileDBStorr$expired_keys()}} + \item \href{#method-TileDBStorr-has_expired_keys}{\code{TileDBStorr$has_expired_keys()}} + \item \href{#method-TileDBStorr-clear_expired_keys}{\code{TileDBStorr$clear_expired_keys()}} + \item \href{#method-TileDBStorr-list}{\code{TileDBStorr$list()}} + \item \href{#method-TileDBStorr-list_hashes}{\code{TileDBStorr$list_hashes()}} + \item \href{#method-TileDBStorr-list_namespaces}{\code{TileDBStorr$list_namespaces()}} + \item \href{#method-TileDBStorr-gc}{\code{TileDBStorr$gc()}} + \item \href{#method-TileDBStorr-import}{\code{TileDBStorr$import()}} + \item \href{#method-TileDBStorr-export}{\code{TileDBStorr$export()}} + \item \href{#method-TileDBStorr-index_export}{\code{TileDBStorr$index_export()}} + \item \href{#method-TileDBStorr-index_import}{\code{TileDBStorr$index_import()}} + \item \href{#method-TileDBStorr-export_tdb}{\code{TileDBStorr$export_tdb()}} + } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-TileDBStorr-new}{}}} -\subsection{Method \code{new()}}{ -Initialise \code{TileDBStorr}. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$new(driver, default_namespace, async = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{driver}}{A TileDB driver, see \code{\link[=driver_tiledb]{driver_tiledb()}}.} - -\item{\code{default_namespace}}{The default namespace.} - -\item{\code{async}}{Should the \link[mirai:mirai]{mirai::mirai} daemons be enabled for async +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-TileDBStorr-initialize}{}}} +\subsection{\code{TileDBStorr$new()}}{ + Initialise \code{TileDBStorr}. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$new(driver, default_namespace, async = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{driver}}{A TileDB driver, see \code{\link[=driver_tiledb]{driver_tiledb()}}.} + \item{\code{default_namespace}}{The default namespace.} + \item{\code{async}}{Should the \link[mirai:mirai]{mirai} daemons be enabled for async functions? Default is \code{FALSE}.} + } + \if{html}{\out{
}} + } } -\if{html}{\out{
}} -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-destroy}{}}} -\subsection{Method \code{destroy()}}{ -Destroy (delete) 'storr'. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$destroy()}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$destroy()}}{ + Destroy (delete) 'storr'. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$destroy()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{NULL}, invisibly. + } } -\subsection{Returns}{ -\code{NULL}, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-flush_cache}{}}} -\subsection{Method \code{flush_cache()}}{ -Flush the cache of \code{R} objects. +\subsection{\code{TileDBStorr$flush_cache()}}{ + Flush the cache of \code{R} objects. It removes all items from the hash tables (R objects and their metadata). -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$flush_cache()}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$flush_cache()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + The object, invisibly. + } } -\subsection{Returns}{ -The object, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set}{}}} -\subsection{Method \code{set()}}{ -Set a key value pair. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set(key, value, namespace = self$default_namespace, expires_at, - notes, use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$set()}}{ + Set a key value pair. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set(key, value, namespace = self$default_namespace, expires_at, + notes, use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A scalar character of key name.} + \item{\code{value}}{An R object to store.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} + \item{\code{notes}}{A scalar string of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The hash value, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A scalar character of key name.} - -\item{\code{value}}{An R object to store.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A scalar string of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The hash value, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset}{}}} -\subsection{Method \code{mset()}}{ -Set multiple key value pairs. +\subsection{\code{TileDBStorr$mset()}}{ + Set multiple key value pairs. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset(key, value, namespace = self$default_namespace, expires_at, - notes, use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset(key, value, namespace = self$default_namespace, expires_at, + notes, use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{value}}{A vector of values to store.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} + \item{\code{notes}}{A character vector of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hash values, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{value}}{A vector of values to store.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A character vector of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hash values, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set_async}{}}} -\subsection{Method \code{set_async()}}{ -Set a key value pair asynchronously. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set_async(key, value, namespace = self$default_namespace, +\subsection{\code{TileDBStorr$set_async()}}{ + Set a key value pair asynchronously. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set_async(key, value, namespace = self$default_namespace, expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE), - cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A scalar character of key name.} - -\item{\code{value}}{An R object to store.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A scalar string of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -Invisibly, a named list with two elements: + cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A scalar character of key name.} + \item{\code{value}}{An R object to store.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} + \item{\code{notes}}{A scalar string of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + Invisibly, a named list with two elements: \itemize{ -\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai::mirai()}} objects, \code{obj} and \code{key}; +\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai()}} objects, \code{obj} and \code{key}; \code{obj} refers to object table and \code{key} to key table. Both return logical \code{TRUE} if an evaluation is successful. \item \code{hash}: the hash value } + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset_async}{}}} -\subsection{Method \code{mset_async()}}{ -Set multiple key value pairs asynchronously. +\subsection{\code{TileDBStorr$mset_async()}}{ + Set multiple key value pairs asynchronously. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset_async(key, value, namespace = self$default_namespace, + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset_async(key, value, namespace = self$default_namespace, expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE), - cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{value}}{A vector of values to store.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A character vector of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -Invisibly, a named list with two elements: + cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{value}}{A vector of values to store.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} + \item{\code{notes}}{A character vector of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + Invisibly, a named list with two elements: \itemize{ -\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai::mirai()}} objects, \code{obj} and \code{key}; +\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai()}} objects, \code{obj} and \code{key}; \code{obj} refers to object table and \code{key} to key table. Both return logical \code{TRUE} if an evaluation is successful. \item \code{hash}: a vector with hash values } + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set_by_value}{}}} -\subsection{Method \code{set_by_value()}}{ -Set a key value pair using its hash as key. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set_by_value(value, namespace = self$default_namespace, - expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$set_by_value()}}{ + Set a key value pair using its hash as key. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set_by_value(value, namespace = self$default_namespace, + expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{value}}{An R object to store.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} + \item{\code{notes}}{A scalar string of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The hash value, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{value}}{An R object to store.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A scalar string of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The hash value, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset_by_value}{}}} -\subsection{Method \code{mset_by_value()}}{ -Set multiple key value pairs using their +\subsection{\code{TileDBStorr$mset_by_value()}}{ + Set multiple key value pairs using their hashes as keys. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset_by_value(value, namespace = self$default_namespace, - expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset_by_value(value, namespace = self$default_namespace, + expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{value}}{A vector of values to store.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} + \item{\code{notes}}{A character vector of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hash values, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{value}}{A vector of values to store.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A character vector of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hash values, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set_by_value_async}{}}} -\subsection{Method \code{set_by_value_async()}}{ -Set a key value pair using its hash as key, +\subsection{\code{TileDBStorr$set_by_value_async()}}{ + Set a key value pair using its hash as key, asynchronously. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set_by_value_async(value, namespace = self$default_namespace, + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set_by_value_async(value, namespace = self$default_namespace, expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE), - cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{value}}{An R object to store.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A scalar string of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -Invisibly, a named list with two elements: + cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{value}}{An R object to store.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} + \item{\code{notes}}{A scalar string of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + Invisibly, a named list with two elements: \itemize{ -\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai::mirai()}} objects, \code{obj} and \code{key}; +\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai()}} objects, \code{obj} and \code{key}; \code{obj} refers to object table and \code{key} to key table. Both return logical \code{TRUE} if an evaluation is successful. \item \code{hash}: the hash value } + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset_by_value_async}{}}} -\subsection{Method \code{mset_by_value_async()}}{ -Set multiple key value pairs using their +\subsection{\code{TileDBStorr$mset_by_value_async()}}{ + Set multiple key value pairs using their hashes as keys, asynchronously. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset_by_value_async(value, namespace = self$default_namespace, + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset_by_value_async(value, namespace = self$default_namespace, expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE), - cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{value}}{A vector of values to store.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A character vector of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -Invisibly, a named list with two elements: + cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{value}}{A vector of values to store.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} + \item{\code{notes}}{A character vector of notes (optional).} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + Invisibly, a named list with two elements: \itemize{ -\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai::mirai()}} objects, \code{obj} and \code{key}; +\item \code{mirai}: a named list of two \code{\link[mirai:mirai]{mirai()}} objects, \code{obj} and \code{key}; \code{obj} refers to object table and \code{key} to key table. Both return logical \code{TRUE} if an evaluation is successful. \item \code{hash}: a vector with hash values } + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set_value}{}}} -\subsection{Method \code{set_value()}}{ -Add an R object without key. +\subsection{\code{TileDBStorr$set_value()}}{ + Add an R object without key. This is used internally. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set_value(value, use_cache = getOption("storr.tiledb.cache", - TRUE))}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set_value(value, use_cache = getOption("storr.tiledb.cache", + TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{value}}{An R object to store.} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The hash value, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{value}}{An R object to store.} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The hash value, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset_value}{}}} -\subsection{Method \code{mset_value()}}{ -Add a vector of R objects. +\subsection{\code{TileDBStorr$mset_value()}}{ + Add a vector of R objects. This is used internally. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset_value(values, use_cache = getOption("storr.tiledb.cache", - TRUE))}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset_value(values, use_cache = getOption("storr.tiledb.cache", + TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{values}}{A vector of values to store.} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hash values, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{values}}{A vector of values to store.} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hash values, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-get}{}}} -\subsection{Method \code{get()}}{ -Get an object given a key-namespace pair. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$get(key, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$get()}}{ + Get an object given a key-namespace pair. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$get(key, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A scalar character of key name.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The \code{R} object if available. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A scalar character of key name.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{R} object if available. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mget}{}}} -\subsection{Method \code{mget()}}{ -Get multiple objects. +\subsection{\code{TileDBStorr$mget()}}{ + Get multiple objects. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mget(key, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE), missing = NULL)}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mget(key, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE), missing = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + \item{\code{missing}}{Value to use for missing elements.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A list of \code{R} objects. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} - -\item{\code{missing}}{Value to use for missing elements.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A list of \code{R} objects. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-get_hash}{}}} -\subsection{Method \code{get_hash()}}{ -Get hash value. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$get_hash(key, namespace = self$default_namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$get_hash()}}{ + Get hash value. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$get_hash(key, namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A scalar character of key name.} + \item{\code{namespace}}{A scalar character of namespace name.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The hash value. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A scalar character of key name.} - -\item{\code{namespace}}{A scalar character of namespace name.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The hash value. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mget_hash}{}}} -\subsection{Method \code{mget_hash()}}{ -Get hash values. +\subsection{\code{TileDBStorr$mget_hash()}}{ + Get hash values. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mget_hash(key, namespace = self$default_namespace)}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mget_hash(key, namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hashes. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hashes. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-hash_object}{}}} -\subsection{Method \code{hash_object()}}{ -Create a hash digest for an R object. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$hash_object(object)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{object}}{An R object.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A character string of a fixed length containing the +\subsection{\code{TileDBStorr$hash_object()}}{ + Create a hash digest for an R object. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$hash_object(object)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{object}}{An R object.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A character string of a fixed length containing the requested digest (hash) of the supplied R object. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-get_value}{}}} -\subsection{Method \code{get_value()}}{ -Get an object given its hash. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$get_value(hash, use_cache = getOption("storr.tiledb.cache", - TRUE))}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$get_value()}}{ + Get an object given its hash. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$get_value(hash, use_cache = getOption("storr.tiledb.cache", + TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{The hash value of the object.} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The \code{R} object if available. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{The hash value of the object.} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{R} object if available. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mget_value}{}}} -\subsection{Method \code{mget_value()}}{ -Get multiple objects given their hashes. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mget_value(hash, use_cache = getOption("storr.tiledb.cache", - TRUE), missing = NULL)}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$mget_value()}}{ + Get multiple objects given their hashes. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mget_value(hash, use_cache = getOption("storr.tiledb.cache", + TRUE), missing = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values."} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + \item{\code{missing}}{Value to use for missing elements.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A list of \code{R} objects. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values."} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} - -\item{\code{missing}}{Value to use for missing elements.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A list of \code{R} objects. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set_keymeta}{}}} -\subsection{Method \code{set_keymeta()}}{ -Set key metadata. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set_keymeta(key, namespace = self$default_namespace, expires_at, - notes, use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A scalar character of key name.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A scalar string of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used to retrieve the metadata? +\subsection{\code{TileDBStorr$set_keymeta()}}{ + Set key metadata. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set_keymeta(key, namespace = self$default_namespace, expires_at, + notes, use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A scalar character of key name.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} + \item{\code{notes}}{A scalar string of notes (optional).} + \item{\code{use_cache}}{Should the cache be used to retrieve the metadata? Default is \code{TRUE}. If a key:namespace not found in the cache, it will be fetched from database. Note that when setting \code{FALSE}, the cache will always be cleared for this key-namespace; this is to avoid mismatch between cache and database when reading back with \code{use_cache = TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{key:namespace} string, invisibly. If both arguments + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The \code{key:namespace} string, invisibly. If both arguments \code{"expires_at"} and \code{"notes"} are missing, then nothing is set and a zero length character vector is returned. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset_keymeta}{}}} -\subsection{Method \code{mset_keymeta()}}{ -Set multiple key metadata. +\subsection{\code{TileDBStorr$mset_keymeta()}}{ + Set multiple key metadata. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset_keymeta(key, namespace = self$default_namespace, expires_at, - notes, use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A character vector of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used to retrieve the metadata? + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset_keymeta(key, namespace = self$default_namespace, expires_at, + notes, use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} + \item{\code{notes}}{A character vector of notes (optional).} + \item{\code{use_cache}}{Should the cache be used to retrieve the metadata? Default is \code{TRUE}. If a key:namespace not found in the cache, it will be fetched from database. Note that when setting \code{FALSE}, the cache will always be cleared for this key-namespace; this is to avoid mismatch between cache and database when reading back with \code{use_cache = TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{key:namespace} character vector of the recycled length, + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The \code{key:namespace} character vector of the recycled length, invisibly. If both arguments \code{"expires_at"} and \code{"notes"} are missing, then nothing is set and a zero length character vector is returned. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-set_keymeta_async}{}}} -\subsection{Method \code{set_keymeta_async()}}{ -Set key metadata asynchronously. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$set_keymeta_async(key, namespace = self$default_namespace, +\subsection{\code{TileDBStorr$set_keymeta_async()}}{ + Set key metadata asynchronously. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$set_keymeta_async(key, namespace = self$default_namespace, expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE), - cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A scalar character of key name.} - -\item{\code{namespace}}{A scalar character of namespace name.} - -\item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A scalar string of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used to retrieve the metadata? + cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A scalar character of key name.} + \item{\code{namespace}}{A scalar character of namespace name.} + \item{\code{expires_at}}{A date-time object of class \code{POSIXct} (optional).} + \item{\code{notes}}{A scalar string of notes (optional).} + \item{\code{use_cache}}{Should the cache be used to retrieve the metadata? Default is \code{TRUE}. If a key:namespace not found in the cache, it will be fetched from database. Note that when setting \code{FALSE}, the cache will always be cleared for this key-namespace; this is to avoid mismatch between cache and database when reading back with \code{use_cache = TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A named list with two elements (invisibly): + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A named list with two elements (invisibly): \itemize{ \item \code{mirai}: a mirai object \item \code{keyns}: The \code{key:namespace} string @@ -780,46 +758,43 @@ A named list with two elements (invisibly): If both arguments \code{"expires_at"} and \code{"notes"} are missing, then nothing is set and a zero length character vector is returned. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mset_keymeta_async}{}}} -\subsection{Method \code{mset_keymeta_async()}}{ -Set multiple key metadata. +\subsection{\code{TileDBStorr$mset_keymeta_async()}}{ + Set multiple key metadata. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mset_keymeta_async(key, namespace = self$default_namespace, + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mset_keymeta_async(key, namespace = self$default_namespace, expires_at, notes, use_cache = getOption("storr.tiledb.cache", TRUE), - cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} - -\item{\code{notes}}{A character vector of notes (optional).} - -\item{\code{use_cache}}{Should the cache be used to retrieve the metadata? + cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{expires_at}}{A vector of date-times of class \code{POSIXct} (optional).} + \item{\code{notes}}{A character vector of notes (optional).} + \item{\code{use_cache}}{Should the cache be used to retrieve the metadata? Default is \code{TRUE}. If a key:namespace not found in the cache, it will be fetched from database. Note that when setting \code{FALSE}, the cache will always be cleared for this key-namespace; this is to avoid mismatch between cache and database when reading back with \code{use_cache = TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A named list with two elements (invisibly): + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A named list with two elements (invisibly): \itemize{ \item \code{mirai}: a mirai object \item \code{keyns}: The \code{key:namespace} character vector of the recycled length @@ -827,72 +802,72 @@ A named list with two elements (invisibly): If both arguments \code{"expires_at"} and \code{"notes"} are missing, then nothing is set and a zero length character vector is returned. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-get_keymeta}{}}} -\subsection{Method \code{get_keymeta()}}{ -Get key's metadata. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$get_keymeta(key, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{The key name to get metadata values from.} - -\item{\code{namespace}}{The namespace to look the key within.} - -\item{\code{use_cache}}{Should it be retrieved from cache? Default is +\subsection{\code{TileDBStorr$get_keymeta()}}{ + Get key's metadata. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$get_keymeta(key, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{The key name to get metadata values from.} + \item{\code{namespace}}{The namespace to look the key within.} + \item{\code{use_cache}}{Should it be retrieved from cache? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A named list with the key-metadata: \code{"expires_at"} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A named list with the key-metadata: \code{"expires_at"} and \verb{"notes".} + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-mget_keymeta}{}}} -\subsection{Method \code{mget_keymeta()}}{ -Get multiple key metadata. +\subsection{\code{TileDBStorr$mget_keymeta()}}{ + Get multiple key metadata. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$mget_keymeta(key, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE), missing = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector with keys to get metadata values from.} - -\item{\code{namespace}}{A character vector of namespaces to look the keys within.} - -\item{\code{use_cache}}{Should it be retrieved from cache? Default is + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$mget_keymeta(key, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE), missing = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector with keys to get metadata values from.} + \item{\code{namespace}}{A character vector of namespaces to look the keys within.} + \item{\code{use_cache}}{Should it be retrieved from cache? Default is \code{TRUE}.} - -\item{\code{missing}}{Fill value for missing keys. Default is \code{NULL}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A list with key metadata for each key-namespace + \item{\code{missing}}{Fill value for missing keys. Default is \code{NULL}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A list with key metadata for each key-namespace pair. For not found pairs will return the \code{missing} value. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-clr_keymeta}{}}} -\subsection{Method \code{clr_keymeta()}}{ -Remove key metadata. +\subsection{\code{TileDBStorr$clr_keymeta()}}{ + Remove key metadata. This method is a convenient wrapper around \code{set_keymeta()} and \code{mset_keymeta()} and sets the key metadata fields to \code{NA} values, i.e., \code{as.POSIXct(NA)} and @@ -900,37 +875,37 @@ and sets the key metadata fields to \code{NA} values, i.e., \code{as.POSIXct(NA) The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$clr_keymeta(key, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{use_cache}}{Should the cache be used to retrieve the metadata? + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$clr_keymeta(key, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{use_cache}}{Should the cache be used to retrieve the metadata? Default is \code{TRUE}. If a key:namespace not found in the cache, it will be fetched from database. Note that when setting \code{FALSE}, the cache will always be cleared for this key-namespace; this is to avoid mismatch between cache and database when reading back with \code{use_cache = TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -The \code{key:namespace} character vector of the recycled length, + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The \code{key:namespace} character vector of the recycled length, invisibly. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-clr_keymeta_async}{}}} -\subsection{Method \code{clr_keymeta_async()}}{ -Remove key metadata asynchronously. +\subsection{\code{TileDBStorr$clr_keymeta_async()}}{ + Remove key metadata asynchronously. This method is a convenient wrapper around \code{set_keymeta_async()} and \code{mset_keymeta_async()} and sets the key metadata fields to \code{NA} values, i.e., \code{as.POSIXct(NA)} and @@ -938,481 +913,498 @@ and sets the key metadata fields to \code{NA} values, i.e., \code{as.POSIXct(NA) The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$clr_keymeta_async(key, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE), cfg = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{use_cache}}{Should the cache be used to retrieve the metadata? + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$clr_keymeta_async(key, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE), cfg = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{use_cache}}{Should the cache be used to retrieve the metadata? Default is \code{TRUE}. If a key:namespace not found in the cache, it will be fetched from database. Note that when setting \code{FALSE}, the cache will always be cleared for this key-namespace; this is to avoid mismatch between cache and database when reading back with \code{use_cache = TRUE}.} - -\item{\code{cfg}}{Pass a \code{\link[tiledb:generics]{tiledb::config()}} object to override context's configuration.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A named list with two elements (invisibly): + \item{\code{cfg}}{Pass a \code{\link[tiledb:config]{tiledb::config()}} object to override context's configuration.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A named list with two elements (invisibly): \itemize{ \item \code{mirai}: a mirai object \item \code{keyns}: The \code{key:namespace} character vector of the recycled length } + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-fill}{}}} -\subsection{Method \code{fill()}}{ -Set one or more keys to the same value. +\subsection{\code{TileDBStorr$fill()}}{ + Set one or more keys to the same value. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$fill(key, value, namespace = self$default_namespace, - use_cache = getOption("storr.tiledb.cache", TRUE))}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$fill(key, value, namespace = self$default_namespace, + use_cache = getOption("storr.tiledb.cache", TRUE))} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{value}}{An R object to store.} + \item{\code{namespace}}{A character vector of namespaces.} + \item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of hash values, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{value}}{An R object to store.} - -\item{\code{namespace}}{A character vector of namespaces.} - -\item{\code{use_cache}}{Should the cache be used? Default is \code{TRUE}.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of hash values, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-duplicate}{}}} -\subsection{Method \code{duplicate()}}{ -Duplicate a set of keys. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$duplicate(key_src, key_dest, namespace = self$default_namespace, - namespace_src = namespace, namespace_dest = namespace)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key_src}}{A character vector of source keys.} - -\item{\code{key_dest}}{A character vector of destination keys.} - -\item{\code{namespace}}{The namespace to copy keys within (used only of +\subsection{\code{TileDBStorr$duplicate()}}{ + Duplicate a set of keys. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$duplicate(key_src, key_dest, namespace = self$default_namespace, + namespace_src = namespace, namespace_dest = namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key_src}}{A character vector of source keys.} + \item{\code{key_dest}}{A character vector of destination keys.} + \item{\code{namespace}}{The namespace to copy keys within (used only of \code{namespace_src} and \code{namespace_dest} are not provided.} - -\item{\code{namespace_src}}{The source namespace - use this where keys are + \item{\code{namespace_src}}{The source namespace - use this where keys are duplicated across namespaces.} - -\item{\code{namespace_dest}}{The destination namespace - use this where keys are duplicated + \item{\code{namespace_dest}}{The destination namespace - use this where keys are duplicated across namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{NULL}, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{NULL}, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-clear}{}}} -\subsection{Method \code{clear()}}{ -Clear a storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$clear(namespace = self$default_namespace)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A scalar character of namespace name or \code{NULL} to +\subsection{\code{TileDBStorr$clear()}}{ + Clear a storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$clear(namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A scalar character of namespace name or \code{NULL} to clear all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + The number of deleted namespaces. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -The number of deleted namespaces. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-exists}{}}} -\subsection{Method \code{exists()}}{ -Check a key-namespace pair exists. +\subsection{\code{TileDBStorr$exists()}}{ + Check a key-namespace pair exists. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$exists(key, namespace = self$default_namespace)}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$exists(key, namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector indicating which key-namespace pair exists. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector indicating which key-namespace pair exists. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-exists_object}{}}} -\subsection{Method \code{exists_object()}}{ -Check a serialised object exists given a hash. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$exists_object(hash)}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$exists_object()}}{ + Check a serialised object exists given a hash. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$exists_object(hash)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{hash}}{A vector of hash values.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector indicating which object exists. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{hash}}{A vector of hash values.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector indicating which object exists. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-del}{}}} -\subsection{Method \code{del()}}{ -Delete an object from the storr. +\subsection{\code{TileDBStorr$del()}}{ + Delete an object from the storr. The arguments \code{key} and \code{namespace} can be recycled if any of them is a scalar character and the other is a vector. No other recycling rule is permitted. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$del(key, namespace = self$default_namespace)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of key names.} - -\item{\code{namespace}}{A character vector of namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical vector indicating which key-namespace pair was + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$del(key, namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of key names.} + \item{\code{namespace}}{A character vector of namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical vector indicating which key-namespace pair was deleted, invisibly. + } } -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-keys_with_expiration}{}}} -\subsection{Method \code{keys_with_expiration()}}{ -Get the key-namespace pairs with expiration timestamps. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$keys_with_expiration(namespace = self$default_namespace, - datetimes = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{datetimes}}{Should the \code{expires_at} column be returned? +\subsection{\code{TileDBStorr$keys_with_expiration()}}{ + Get the key-namespace pairs with expiration timestamps. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$keys_with_expiration(namespace = self$default_namespace, + datetimes = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{datetimes}}{Should the \code{expires_at} column be returned? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An object of class \code{data.table}. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -An object of class \code{data.table}. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-expired_keys}{}}} -\subsection{Method \code{expired_keys()}}{ -Get the expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$expired_keys(namespace = self$default_namespace, - datetimes = TRUE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{datetimes}}{Should the \code{expires_at} column be returned? +\subsection{\code{TileDBStorr$expired_keys()}}{ + Get the expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$expired_keys(namespace = self$default_namespace, + datetimes = TRUE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{datetimes}}{Should the \code{expires_at} column be returned? Default is \code{TRUE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An object of class \code{data.table}. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -An object of class \code{data.table}. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-has_expired_keys}{}}} -\subsection{Method \code{has_expired_keys()}}{ -Check for expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$has_expired_keys(namespace = self$default_namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$has_expired_keys()}}{ + Check for expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$has_expired_keys(namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE} for expired keys, \code{FALSE} otherwise. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE} for expired keys, \code{FALSE} otherwise. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-clear_expired_keys}{}}} -\subsection{Method \code{clear_expired_keys()}}{ -Remove the expired key-namespace pairs. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$clear_expired_keys(namespace = self$default_namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$clear_expired_keys()}}{ + Remove the expired key-namespace pairs. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$clear_expired_keys(namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A boolean value \code{TRUE} indicating success, invisibly. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A boolean value \code{TRUE} indicating success, invisibly. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-list}{}}} -\subsection{Method \code{list()}}{ -List all keys stored in a namespace. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$list(namespace = self$default_namespace)}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$list()}}{ + List all keys stored in a namespace. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$list(namespace = self$default_namespace)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A scalar character of namespace name.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A sorted character vector with keys. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A scalar character of namespace name.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -A sorted character vector with keys. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-list_hashes}{}}} -\subsection{Method \code{list_hashes()}}{ -List all hashes stored in the storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$list_hashes()}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$list_hashes()}}{ + List all hashes stored in the storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$list_hashes()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A sorted character vector with hashes. + } } -\subsection{Returns}{ -A sorted character vector with hashes. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-list_namespaces}{}}} -\subsection{Method \code{list_namespaces()}}{ -List all namespaces in the storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$list_namespaces()}\if{html}{\out{
}} +\subsection{\code{TileDBStorr$list_namespaces()}}{ + List all namespaces in the storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$list_namespaces()} + \if{html}{\out{
}} + } + \subsection{Returns}{ + A sorted character vector with namespaces. + } } -\subsection{Returns}{ -A sorted character vector with namespaces. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-gc}{}}} -\subsection{Method \code{gc()}}{ -Garbage collect the storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$gc(clear_expired = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{clear_expired}}{Should the expired keys be deleted? +\subsection{\code{TileDBStorr$gc()}}{ + Garbage collect the storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$gc(clear_expired = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{clear_expired}}{Should the expired keys be deleted? Default is \code{FALSE}.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector of unused hashes, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector of unused hashes, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-import}{}}} -\subsection{Method \code{import()}}{ -Import objects to storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$import(src, list = NULL, namespace = self$default_namespace, - skip_missing = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{src}}{A source to import objects from. It can be a storr, list, or environment.} - -\item{\code{list}}{Names of objects to import (or \code{NULL} for all objects) . If given it must be a character vector. +\subsection{\code{TileDBStorr$import()}}{ + Import objects to storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$import(src, list = NULL, namespace = self$default_namespace, + skip_missing = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{src}}{A source to import objects from. It can be a storr, list, or environment.} + \item{\code{list}}{Names of objects to import (or \code{NULL} for all objects) . If given it must be a character vector. If named, the names of the character vector will be the names of the objects as created in the storr.} - -\item{\code{namespace}}{Namespace to get objects from, and to put objects into. + \item{\code{namespace}}{Namespace to get objects from, and to put objects into. If \code{NULL}, all namespaces from \code{src} will be imported. If named, then the same rule is followed as \code{list}; \code{namespace = c(a = b)} will import the contents of namespace \code{b} as namespace \code{a}.} - -\item{\code{skip_missing}}{Logical, indicating if missing keys (specified in \code{list}) + \item{\code{skip_missing}}{Logical, indicating if missing keys (specified in \code{list}) should be skipped over, rather than being treated as an error (the default).} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A vector with destination namespaces, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -A vector with destination namespaces, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-export}{}}} -\subsection{Method \code{export()}}{ -Export objects from storr. +\subsection{\code{TileDBStorr$export()}}{ + Export objects from storr. Use list() to export to a brand new list, or use as.list(object) for a shorthand. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$export(dest, list = NULL, namespace = self$default_namespace, - skip_missing = FALSE)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{dest}}{A destination to export objects to. It can be a storr, list, or environment.} - -\item{\code{list}}{Names of objects to import (or \code{NULL} for all objects) . If given it must be a character vector. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$export(dest, list = NULL, namespace = self$default_namespace, + skip_missing = FALSE)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{dest}}{A destination to export objects to. It can be a storr, list, or environment.} + \item{\code{list}}{Names of objects to import (or \code{NULL} for all objects) . If given it must be a character vector. If named, the names of the character vector will be the names of the objects as created in the storr.} - -\item{\code{namespace}}{Namespace to get objects from, and to put objects into. If \code{NULL}, + \item{\code{namespace}}{Namespace to get objects from, and to put objects into. If \code{NULL}, then this will export namespaces from this (source) storr into the destination; if there is more than one namespace, this is only possible if \code{dest} is a storr (otherwise there will be an error).} - -\item{\code{skip_missing}}{Logical, indicating if missing keys (specified in \code{list}) + \item{\code{skip_missing}}{Logical, indicating if missing keys (specified in \code{list}) should be skipped over, rather than being treated as an error (the default).} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{dest} object, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{dest} object, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-index_export}{}}} -\subsection{Method \code{index_export()}}{ -Generate a \code{data.table} with an index of objects +\subsection{\code{TileDBStorr$index_export()}}{ + Generate a \code{data.table} with an index of objects present in a storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$index_export(namespace = NULL)}\if{html}{\out{
}} + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$index_export(namespace = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + An object of class \code{data.table}. + } } -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} -} -\if{html}{\out{
}} -} -\subsection{Returns}{ -An object of class \code{data.table}. -} -} \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-index_import}{}}} -\subsection{Method \code{index_import()}}{ -Import an index of objects from a storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$index_import(index)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{index}}{A \code{data.frame} with minimum required columns 'namespace', 'key' +\subsection{\code{TileDBStorr$index_import()}}{ + Import an index of objects from a storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$index_import(index)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{index}}{A \code{data.frame} with minimum required columns 'namespace', 'key' 'hash' and optionally 'expires_at' and 'notes'. It is an error if not all hashes are present in the storr.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + \code{TRUE}, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -\code{TRUE}, invisibly. -} -} + \if{html}{\out{
}} \if{html}{\out{}} \if{latex}{\out{\hypertarget{method-TileDBStorr-export_tdb}{}}} -\subsection{Method \code{export_tdb()}}{ -Export objects from storr to another TileDB storr. -\subsection{Usage}{ -\if{html}{\out{
}}\preformatted{TileDBStorr$export_tdb(key = character(0), - namespace = self$default_namespace, uri_dest, context_dest = NULL)}\if{html}{\out{
}} -} - -\subsection{Arguments}{ -\if{html}{\out{
}} -\describe{ -\item{\code{key}}{A character vector of source keys.} - -\item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} - -\item{\code{uri_dest}}{The URI path of destination storr.} - -\item{\code{context_dest}}{Optional \link[tiledb:tiledb_ctx]{tiledb_ctx} object +\subsection{\code{TileDBStorr$export_tdb()}}{ + Export objects from storr to another TileDB storr. + \subsection{Usage}{ + \if{html}{\out{
}} + \preformatted{TileDBStorr$export_tdb(key = character(0), + namespace = self$default_namespace, uri_dest, context_dest = NULL)} + \if{html}{\out{
}} + } + \subsection{Arguments}{ + \if{html}{\out{
}} + \describe{ + \item{\code{key}}{A character vector of source keys.} + \item{\code{namespace}}{A character vector of namespaces or \code{NULL} for all namespaces.} + \item{\code{uri_dest}}{The URI path of destination storr.} + \item{\code{context_dest}}{Optional \link[tiledb:tiledb_ctx]{tiledb_ctx} object for destination storr.} + } + \if{html}{\out{
}} + } + \subsection{Returns}{ + A logical \code{TRUE} indicating successful export, invisibly. + } } -\if{html}{\out{
}} -} -\subsection{Returns}{ -A logical \code{TRUE} indicating successful export, invisibly. -} -} + } diff --git a/man/storr.tiledb-package.Rd b/man/storr.tiledb-package.Rd index 38a553b..8948f5f 100644 --- a/man/storr.tiledb-package.Rd +++ b/man/storr.tiledb-package.Rd @@ -20,5 +20,10 @@ Useful links: \author{ \strong{Maintainer}: Constantinos Giachalis \email{xx@github.com} +Authors: +\itemize{ + \item Constantinos Giachalis \email{xx@github.com} +} + } \keyword{internal} diff --git a/man/storr_copy.Rd b/man/storr_copy.Rd index 44b4d5e..23574f7 100644 --- a/man/storr_copy.Rd +++ b/man/storr_copy.Rd @@ -20,8 +20,8 @@ The new uri path, invisibly. Copy Storr to another URI } \seealso{ -Other storr-utilities: -\code{\link{storr_move}()}, -\code{\link{storr_rename}()} +Other storr-utilities: +\code{\link[=storr_move]{storr_move()}}, +\code{\link[=storr_rename]{storr_rename()}} } \concept{storr-utilities} diff --git a/man/storr_fragments.Rd b/man/storr_fragments.Rd index 2d05339..1c4294f 100644 --- a/man/storr_fragments.Rd +++ b/man/storr_fragments.Rd @@ -20,7 +20,7 @@ work with TileDB Fragments. } \details{ The class includes fragment consolidation and vacuuming methods but also -provides access to \link[R6.tiledb:TileDBFragments]{R6.tiledb::TileDBFragments} instances for \code{keys} and \code{data} arrays +provides access to \link[R6.tiledb:TileDBFragments]{TileDBFragments} instances for \code{keys} and \code{data} arrays where you can further inspect and manage the fragments for the specify arrays. } \examples{ diff --git a/man/storr_move.Rd b/man/storr_move.Rd index cbb331d..db5df02 100644 --- a/man/storr_move.Rd +++ b/man/storr_move.Rd @@ -20,8 +20,8 @@ The new uri path, invisibly. Move Storr to another URI } \seealso{ -Other storr-utilities: -\code{\link{storr_copy}()}, -\code{\link{storr_rename}()} +Other storr-utilities: +\code{\link[=storr_copy]{storr_copy()}}, +\code{\link[=storr_rename]{storr_rename()}} } \concept{storr-utilities} diff --git a/man/storr_rename.Rd b/man/storr_rename.Rd index 57abb37..d93d11b 100644 --- a/man/storr_rename.Rd +++ b/man/storr_rename.Rd @@ -20,8 +20,8 @@ The new uri path, invisibly. It renames the driver's basename, i.e., 'path/oldname' to 'path/newname'. } \seealso{ -Other storr-utilities: -\code{\link{storr_copy}()}, -\code{\link{storr_move}()} +Other storr-utilities: +\code{\link[=storr_copy]{storr_copy()}}, +\code{\link[=storr_move]{storr_move()}} } \concept{storr-utilities} diff --git a/man/storr_tiledb.Rd b/man/storr_tiledb.Rd index 05bc124..b771d81 100644 --- a/man/storr_tiledb.Rd +++ b/man/storr_tiledb.Rd @@ -19,7 +19,7 @@ storr_tiledb(uri, default_namespace = "objects", context = NULL, \item{hash_algorithm}{Select a hash algorithm supported by \link[digest:digest]{digest}: 'md5', 'sha1', 'crc32', 'sha256', 'sha512', 'xxhash32', 'xxhash64', 'murmur32', 'spookyhash', 'blake3', 'crc32c', 'xxh3_64', 'xxh3_128'. If not given, the default is 'md5'.} -\item{async}{Should the \link[mirai:mirai]{mirai::mirai} daemons be enabled for async +\item{async}{Should the \link[mirai:mirai]{mirai} daemons be enabled for async functions? Default is \code{FALSE}.} \item{...}{Other arguments passed to driver when \code{init = TRUE}. @@ -58,7 +58,7 @@ can be used to disable it, like so: \code{options(storr.tiledb.cache = FALSE)}. \subsection{Buffer size}{ The buffer allocation size is set to 3 MB per column when fetching data. Use -\code{\link[tiledb:save_allocation_size_preference]{tiledb::set_allocation_size_preference()}} to set a different limit. +\code{\link[tiledb:set_allocation_size_preference]{tiledb::set_allocation_size_preference()}} to set a different limit. } } From 333b2367cd601c0e91b289b36550d0230e8f8cc1 Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Sun, 3 May 2026 14:46:23 +0300 Subject: [PATCH 3/5] Website subsection: re-exports --- _pkgdown.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/_pkgdown.yml b/_pkgdown.yml index 128f1e4..9311f13 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -79,6 +79,11 @@ reference: - storr_fragments - storr_consolidate - storr_vacuum + +- subtitle: Re-exported Functions + contents: + - reexports + - title: R6 Classes desc: | R6 classes that represent the storr interface and TileDB driver. From c36a7349095dde5be1276579146ba0e21316b9f6 Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Sun, 3 May 2026 14:46:44 +0300 Subject: [PATCH 4/5] Add two more badges --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 49efddd..7d5526c 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![CRAN status](https://img.shields.io/badge/CRAN-not%20published-orange)](https://CRAN.R-project.org/package=storr.tiledb) [![repo-status](https://img.shields.io/badge/repo%20status-experimental-orange.svg)](#) [![License](https://img.shields.io/badge/License-MIT-003366.svg)](https://opensource.org/licenses/MIT) +[![R CMD Check](https://github.com/cgiachalis/storr.tiledb/actions/workflows/R-CMD-check.yaml/badge.svg?branch=master)](https://github.com/cgiachalis/storr.tiledb/actions/workflows/R-CMD-check.yaml) +[![Last Commit](https://img.shields.io/github/last-commit/cgiachalis/storr.tiledb)](https://github.com/cgiachalis/storr.tiledb) [![Documentation](https://img.shields.io/badge/docs-GitHub_Pages-blue)](https://cgiachalis.github.io/storr.tiledb/) From 602ab5932c0a813e8d87137b8a7583b6b3a83fea Mon Sep 17 00:00:00 2001 From: Constantinos Giachalis Date: Sun, 3 May 2026 14:48:51 +0300 Subject: [PATCH 5/5] Update NEW.md and DESCRIPTION --- DESCRIPTION | 4 ++-- NEWS.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index ec10c2c..f4715bb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: storr.tiledb Title: A TileDB Storage Driver for Storr -Version: 0.0.36 -Date: 2026-04-21 +Version: 0.0.37 +Date: 2026-05-03 Authors@R: person("Constantinos", "Giachalis", , "xx@github.com", role = c("aut", "cre")) Maintainer: Constantinos Giachalis diff --git a/NEWS.md b/NEWS.md index ce70497..e603c6e 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,3 @@ -# storr.tiledb 0.0.36 +# storr.tiledb 0.0.37 * Initial GitHub release.