Title:	Datastore for 'fiery' Web Servers
Version:	0.1.0
Description:	Provides a persistent datastore for 'fiery' apps. The datastore is build on top of the 'storr' package and can thus be based on a variety of backends. The datastore contains both a global and session-scoped section.
License:	MIT + file LICENSE
Encoding:	UTF-8
RoxygenNote:	7.3.2
Imports:	cli, R6, reqres, rlang, storr
Suggests:	fiery (≥ 1.3.0), later, testthat (≥ 3.0.0)
URL:	https://github.com/thomasp85/firesale
BugReports:	https://github.com/thomasp85/firesale/issues
Config/testthat/edition:	3
NeedsCompilation:	no
Packaged:	2025-08-21 11:33:24 UTC; thomas
Author:	Thomas Lin Pedersen [aut, cre], Posit Software, PBC [cph, fnd]
Maintainer:	Thomas Lin Pedersen <thomas.pedersen@posit.co>
Repository:	CRAN
Date/Publication:	2025-08-27 11:20:02 UTC

firesale: Datastore for 'fiery' Web Servers

Description

Provides a persistent datastore for 'fiery' apps. The datastore is build on top of the 'storr' package and can thus be based on a variety of backends. The datastore contains both a global and session-scoped section.

Author(s)

Maintainer: Thomas Lin Pedersen thomas.pedersen@posit.co (ORCID)

Other contributors:

• Posit Software, PBC (03wc8by49) [copyright holder, funder]

See Also

Useful links:

• https://github.com/thomasp85/firesale

• Report bugs at https://github.com/thomasp85/firesale/issues

A FireSale plugin

Description

A FireSale plugin

A FireSale plugin

Details

The class encapsulates the firesale functionality into a fiery plugin. You use it by creating and attaching it to a fiery server object.

Initialization

A new 'FireSale'-object is initialized using the new() method on the generator (shown here with the environment driver):

Usage

Fiery plugin

This class is mainly intended to be used as a fiery plugin, by attaching it to a fiery server object. It works by providing a datastore element (name can be modified with the arg_name argument during initialization) in the arg_list argument to request handlers. The object contains two elements, global and session. The first contains data shared by all sessions, while the latter is scoped to the current session. Both of these elements are list-like, but in reality are interfaces to the underlying data store

Active bindings

Methods

Public methods

• FireSale$new()

• FireSale$format()

• FireSale$get_mall()

• FireSale$shiny_mall()

• FireSale$on_attach()

• FireSale$clone()

Method new()

Initializes a new FireSale object

Usage

FireSale$new(
  driver,
  arg_name = "datastore",
  gc_interval = 3600,
  max_age = gc_interval
)

Arguments

Method format()

Textual representation of the plugin

Usage

FireSale$format(...)

Arguments

Method get_mall()

Create a mall (a collection of storefronts) containing a global and a session-specific storefront

Usage

FireSale$get_mall(id)

Arguments

Method shiny_mall()

Create a mall from a shiny session object. If the shiny app has been launched from a plumber2 server the session id is automatically resolved. If not, you must provide an id function that extracts the session id from a reqres::Request object.

Usage

FireSale$shiny_mall(session, id_fun = NULL)

Arguments

Method on_attach()

Method for use by fiery when attached as a plugin. Should not be called directly.

Usage

FireSale$on_attach(app, ...)

Arguments

Method clone()

The objects of this class are cloneable with this method.

Usage

FireSale$clone(deep = FALSE)

Arguments

Examples

# Create a datastore object
ds <- FireSale$new(storr::driver_environment())


# Attach it to a fiery server
app <- fiery::Fire$new()

app$attach(ds)