Nostrum.Cache.GuildCache.Mnesia (nostrum v0.11.0-dev)

An Mnesia-based cache for guilds.

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

channel_create(guild_id, channel)

Create the given channel for the given guild in the cache.

channel_delete(guild_id, channel_id)

Delete the channel from the given guild in the cache.

channel_update(guild_id, channel)

Update the channel on the given guild in the cache.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

clear()

Clear any objects in the cache.

create(payload)

Create a guild from upstream data.

delete(guild_id)

Remove the given guild from the cache.

emoji_update(guild_id, payload)

Update the emoji list for the given guild in the cache.

get(guild_id)

Get a guild from the cache.

init(opts)

Set up the cache's Mnesia table.

member_count_down(guild_id)

Decrement the guild member count by one.

member_count_up(guild_id)

Increment the guild member count by one.

role_create(guild_id, payload)

Create the given role in the given guild in the cache.

role_delete(guild_id, role_id)

Delete the given role from the given guild in the cache.

role_update(guild_id, role)

Update the given role in the given guild in the cache.

start_link(opts)

Start the supervisor.

stickers_update(guild_id, stickers)

Update the sticker list for the given guild in the cache.

table()

Retrieve the Mnesia table name used for the cache.

teardown()

Drop the table used for caching.

update(payload)

Update the given guild in the cache.

voice_state_update(guild_id, payload)

Update guild voice states with the given voice state in the cache.

wrap_query(fun)

Wrap queries in a transaction.

Functions

channel_create(guild_id, channel)

(since 0.8.0)

@spec channel_create(Nostrum.Struct.Guild.id(), map()) :: Nostrum.Struct.Channel.t()

Create the given channel for the given guild in the cache.

channel_delete(guild_id, channel_id)

(since 0.8.0)

@spec channel_delete(Nostrum.Struct.Guild.id(), Nostrum.Struct.Channel.id()) ::
  Nostrum.Struct.Channel.t() | :noop

Delete the channel from the given guild in the cache.

channel_update(guild_id, channel)

(since 0.8.0)

@spec channel_update(Nostrum.Struct.Guild.id(), map()) ::
  {Nostrum.Struct.Channel.t() | nil, Nostrum.Struct.Channel.t()}

Update the channel on the given guild in the cache.

child_spec(init_arg)

(since 0.8.0)

Returns a specification to start this module under a supervisor.

See Supervisor.

clear()

(since 0.8.0)

@spec clear() :: :ok

Clear any objects in the cache.

create(payload)

(since 0.8.0)

@spec create(map()) :: Nostrum.Struct.Guild.t()

Create a guild from upstream data.

delete(guild_id)

(since 0.8.0)

@spec delete(Nostrum.Struct.Guild.id()) :: Nostrum.Struct.Guild.t() | nil

Remove the given guild from the cache.

emoji_update(guild_id, payload)

(since 0.8.0)

@spec emoji_update(Nostrum.Struct.Guild.id(), [map()]) ::
  {[Nostrum.Struct.Emoji.t()], [Nostrum.Struct.Emoji.t()]}

Update the emoji list for the given guild in the cache.

get(guild_id)

(since 0.8.0)

@spec get(Nostrum.Struct.Guild.id()) ::
  {:ok, Nostrum.Struct.Guild.t()} | {:error, :not_found}

Get a guild from the cache.

init(opts)

(since 0.8.0)

Set up the cache's Mnesia table.

member_count_down(guild_id)

(since 0.7.0)

@spec member_count_down(Nostrum.Struct.Guild.id()) :: true

Decrement the guild member count by one.

member_count_up(guild_id)

(since 0.7.0)

@spec member_count_up(Nostrum.Struct.Guild.id()) :: true

Increment the guild member count by one.

role_create(guild_id, payload)

(since 0.8.0)

@spec role_create(Nostrum.Struct.Guild.id(), map()) ::
  {Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Role.t()}

Create the given role in the given guild in the cache.

role_delete(guild_id, role_id)

(since 0.8.0)

@spec role_delete(Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Role.id()) ::
  {Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Role.t()} | :noop

Delete the given role from the given guild in the cache.

role_update(guild_id, role)

(since 0.8.0)

@spec role_update(Nostrum.Struct.Guild.id(), map()) ::
  {Nostrum.Struct.Guild.id(), Nostrum.Struct.Guild.Role.t() | nil,
   Nostrum.Struct.Guild.Role.t()}

Update the given role in the given guild in the cache.

start_link(opts)

(since 0.8.0)

Start the supervisor.

stickers_update(guild_id, stickers)

(since 0.8.0)

@spec stickers_update(Nostrum.Struct.Guild.id(), [map()]) ::
  {[Nostrum.Struct.Sticker.t()], [Nostrum.Struct.Sticker.t()]}

Update the sticker list for the given guild in the cache.

table()

(since 0.8.0)

@spec table() :: atom()

Retrieve the Mnesia table name used for the cache.

teardown()

(since 0.8.0)

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

Drop the table used for caching.

update(payload)

(since 0.8.0)

@spec update(map()) :: {Nostrum.Struct.Guild.t() | nil, Nostrum.Struct.Guild.t()}

Update the given guild in the cache.

voice_state_update(guild_id, payload)

(since 0.8.0)

@spec voice_state_update(Nostrum.Struct.Guild.id(), map()) ::
  {Nostrum.Struct.Guild.id(), [map()]}

Update guild voice states with the given voice state in the cache.

wrap_query(fun)

(since 0.8.0)

Wrap queries in a transaction.