shards v1.1.0

View Source shards_meta (shards v1.1.0)

This module encapsulates the partitioned table metadata.

Different properties must be stored somewhere so shards can work properly. Shards perform logic on top of ETS tables, for example, compute the partition based on the Key where the action will be applied. To do so, it needs the number of partitions, the function to select the partition, and also the partition identifier to perform the ETS action.

Link to this section Summary

Types

keyslot_fun/0
meta_map/0
partition_pids/0
partition_tids/0
t/0

Functions

ets_opts(Meta)
from_map(Map)
Builds a new meta from the given Map.
get(Tab)
Returns the tab_info within the metadata.
get(Tab, Key)

Equivalent to get(Tab, Key, undefined).

get(Tab, Key, Def)
Returns the value for the given Key in the metadata, or Def if Key is not set.
get_partition_pids(Tab)
Returns a list with the partition PIDs.
get_partition_tids(Tab)
Returns a list with the partition TIDs.
init(Name, Opts)
Initializes the metadata ETS table.
is_metadata(Meta)
Returns true if Meta is a metadata data type, otherwise, false is returned.
keypos(Meta)
keyslot_fun(Meta)
lookup(Tab, Key)
Returns the value associated to the key Key in the metadata table Tab. If Key is not found, the error {unknown_table, Tab} is raised.
new()
Returns a metadata data type with the default values.
parallel(Meta)
parallel_timeout(Meta)
partitions(Meta)
put(Tab, Key, Val)
Stores the value Val under the given key Key into the metadata table Tab.
rename(Tab, Name)
Renames the metadata ETS table.
tab_pid(Meta)
to_map(Meta)
Converts the given Meta into a map.

Link to this section Types

Link to this type

keyslot_fun/0

View Source 
-type keyslot_fun() :: fun((Key :: term(), Range :: pos_integer()) -> non_neg_integer()).
Link to this type

meta_map/0

View Source 
-type meta_map() ::
    #{tab_pid => pid(),
      keypos => pos_integer(),
      partitions => pos_integer(),
      keyslot_fun => keyslot_fun(),
      parallel => boolean(),
      parallel_timeout => timeout(),
      ets_opts => [term()]}.
Link to this type

partition_pids/0

View Source 
-type partition_pids() :: [{non_neg_integer(), pid()}].
Link to this type

partition_tids/0

View Source 
-type partition_tids() :: [{non_neg_integer(), ets:tid()}].
Link to this type

t/0

View Source 
-type t() :: #meta{}.

Link to this section Functions

Link to this function

ets_opts(Meta)

View Source 
-spec ets_opts(t() | shards:tab()) -> [term()].
Link to this function

from_map(Map)

View Source 
-spec from_map(Map :: #{atom() => term()}) -> t().
Builds a new meta from the given Map.
Link to this function

get(Tab)

View Source 
-spec get(Tab :: shards:tab()) -> t() | no_return().
Returns the tab_info within the metadata.
Link to this function

get(Tab, Key)

View Source

Equivalent to get(Tab, Key, undefined).

Link to this function

get(Tab, Key, Def)

View Source 
-spec get(Tab, Key, Def) -> Val when Tab :: shards:tab(), Key :: term(), Def :: term(), Val :: term().
Returns the value for the given Key in the metadata, or Def if Key is not set.
Link to this function

get_partition_pids(Tab)

View Source 
-spec get_partition_pids(Tab :: shards:tab()) -> partition_pids().
Returns a list with the partition PIDs.
Link to this function

get_partition_tids(Tab)

View Source 
-spec get_partition_tids(Tab :: shards:tab()) -> partition_tids().
Returns a list with the partition TIDs.
Link to this function

init(Name, Opts)

View Source 
-spec init(Name, Opts) -> Tab when Name :: atom(), Opts :: [shards:option()], Tab :: shards:tab().
Initializes the metadata ETS table.
Link to this function

is_metadata(Meta)

View Source 
-spec is_metadata(Meta :: term()) -> boolean().
Returns true if Meta is a metadata data type, otherwise, false is returned.
Link to this function

keypos(Meta)

View Source 
-spec keypos(t() | shards:tab()) -> pos_integer().
Link to this function

keyslot_fun(Meta)

View Source 
-spec keyslot_fun(t() | shards:tab()) -> keyslot_fun().
Link to this function

lookup(Tab, Key)

View Source 
-spec lookup(Tab, Key) -> term() when Tab :: shards:tab(), Key :: term().
Returns the value associated to the key Key in the metadata table Tab. If Key is not found, the error {unknown_table, Tab} is raised.
Link to this function

new()

View Source 
-spec new() -> t().
Returns a metadata data type with the default values.
Link to this function

parallel(Meta)

View Source 
-spec parallel(t() | shards:tab()) -> boolean().
Link to this function

parallel_timeout(Meta)

View Source 
-spec parallel_timeout(t() | shards:tab()) -> timeout().
Link to this function

partitions(Meta)

View Source 
-spec partitions(t() | shards:tab()) -> pos_integer().
Link to this function

put(Tab, Key, Val)

View Source 
-spec put(Tab, Key, Val) -> ok when Tab :: shards:tab(), Key :: term(), Val :: term().
Stores the value Val under the given key Key into the metadata table Tab.
Link to this function

rename(Tab, Name)

View Source 
-spec rename(Tab, Name) -> Name when Tab :: shards:tab(), Name :: atom().
Renames the metadata ETS table.
Link to this function

tab_pid(Meta)

View Source 
-spec tab_pid(t() | shards:tab()) -> pid().
Link to this function

to_map(Meta)

View Source 
-spec to_map(t()) -> meta_map().
Converts the given Meta into a map.