View Source Nostrum.Cache.PresenceCache.Mnesia (Nostrum v0.10.0)

An Mnesia-based cache for presences.

Please note that this module is only compiled if Mnesia is available on your system. See the Mnesia section of the State documentation for more information.

To retrieve the table name used by this cache, use table/0.

Summary

Functions

Bulk create a chunk of presences for the given guild in the cache.

Returns a specification to start this module under a supervisor.

Clear any objects in the cache.

Add the given presence to the cache.

Retrieve a presence from the cache.

Set up the cache's Mnesia table.

Start the supervisor.

Retrieve the table name used by the cache.

Drop the table used for caching.

Update the given presence in the cache.

Wrap query operations in a transaction.

Functions

Link to this function

bulk_create(guild_id, presences)

View Source (since 0.8.0)

Bulk create a chunk of presences for the given guild in the cache.

Link to this function

child_spec(init_arg)

View Source (since 0.8.0)

Returns a specification to start this module under a supervisor.

See Supervisor.

@spec clear() :: {:atomic, :ok} | {:aborted, term()}

Clear any objects in the cache.

Link to this function

create(presence)

View Source (since 0.8.0)
@spec create(map()) :: :ok

Add the given presence to the cache.

Link to this function

get(guild_id, user_id)

View Source (since 0.8.0)

Retrieve a presence from the cache.

Link to this function

init(init_arg)

View Source (since 0.8.0)

Set up the cache's Mnesia table.

Link to this function

start_link(init_arg)

View Source (since 0.8.0)

Start the supervisor.

@spec table() :: atom()

Retrieve the table name used by the cache.

Link to this function

teardown()

View Source (since 0.8.0)
@spec teardown() :: {:atomic, :ok} | {:aborted, term()}

Drop the table used for caching.

Link to this function

update(new)

View Source (since 0.8.0)
@spec update(map()) :: {Nostrum.Struct.Guild.id(), presence | nil, presence} | :noop
when presence: Nostrum.Cache.PresenceCache.presence()

Update the given presence in the cache.

Link to this function

wrap_query(fun)

View Source (since 0.8.0)

Wrap query operations in a transaction.