View Source ProcessHub.Service.Storage (ProcessHub v0.3.2-alpha)

The local storage service provides API functions for managing local storage. This is mainly used for storing data that is not required to be persisted.

Local storage is implemented using ETS tables and is cleared periodically.

Summary

Types

table_id()

Functions

clear_all(table)

Deletes all objects from the ETS table.

exists?(table, key)

Returns a boolean indicating whether the key exists in local storage.

export_all(table)

Exports all objects from the ETS table.

get(table, key)

Returns the value for the key in local storage.

insert(table, key, value, opts \\ [])

Inserts the key and value into local storage.

remove(table, key)

Removes an entry from the storage.

update(table, key, func)

Updates the value for the key in local storage.

Types

table_id()

@type table_id() :: atom()

Functions

clear_all(table)

@spec clear_all(table_id()) :: boolean()

Deletes all objects from the ETS table.

Never use in custom code. Should only be used for testing purposes.

exists?(table, key)

@spec exists?(table_id(), term()) :: boolean()

Returns a boolean indicating whether the key exists in local storage.

export_all(table)

@spec export_all(table_id()) :: [{atom() | binary(), term(), pos_integer() | nil}]

Exports all objects from the ETS table.

get(table, key)

@spec get(table_id(), term()) :: term()

Returns the value for the key in local storage.

If the key does not exist, nil is returned; otherwise, the value is returned in the format of a tuple: {key, value, ttl}.

insert(table, key, value, opts \\ [])

@spec insert(table_id(), term(), term(), keyword() | nil) :: boolean()

Inserts the key and value into local storage.

Available options:

ttl: The time to live for the key in milliseconds.

remove(table, key)

@spec remove(table_id(), term()) :: boolean()

Removes an entry from the storage.

update(table, key, func)

@spec update(table_id(), term(), function()) :: boolean()

Updates the value for the key in local storage.

The func function is expected to take the current value as an argument and return the new value.

If the key does not exist, the current value is nil.