Nebulex
▼
Project version
v2.6.4
v2.6.3
v2.6.2
v2.6.1
v2.6.0
v2.5.2
v2.5.1
v2.5.0
v2.4.2
v2.4.1
v2.4.0
v2.3.2
v2.3.1
v2.3.0
v2.2.1
v2.2.0
v2.1.1
v2.1.0
v2.0.0
v2.0.0-rc.2
v2.0.0-rc.1
v2.0.0-rc.0
v1.2.2
v1.2.1
v1.2.0
v1.1.1
v1.1.0
v1.0.1
v1.0.0
v1.0.0-rc.3
v1.0.0-rc.2
v1.0.0-rc.1
Pages
Modules
Mix
Tasks
API Reference
Modules
Mix Tasks
Getting Started
Adding Nebulex to an application
Inserting entries
Retrieving entries
Updating entries
Counters
Deleting entries
Info
Query and/or Stream entries
Partitioned Cache
Multilevel Cache
Next
Cache Usage Patterns via Nebulex.Caching
Cache-aside
Cache-as-SoR
Read-through
Write-through
Telemetry
Telemetry Events
Nebulex Metrics
Cache Stats
Multi-level Cache Stats
Migrating to v2.x
Configuration
Cache API
Declarative annotation-based caching via decorators
Hooks
Built-In Adapters
Statistics
Mix Tasks
Creating New Adapter
Mix Project
Tests
Implementation
Nebulex
Sections
Caches
Declarative annotation-based caching
Nebulex.Adapter
Summary
Types
adapter_meta/0
metadata/0
t/0
Callbacks
__before_compile__/1
init/1
Functions
defspan/3
with_meta/2
Nebulex.Adapter.Entry
Summary
Types
adapter_meta/0
entries/0
key/0
on_write/0
opts/0
ttl/0
value/0
Callbacks
delete/3
expire/3
get/3
get_all/3
has_key?/2
put/6
put_all/5
take/3
touch/2
ttl/2
update_counter/6
Nebulex.Adapter.Keyslot
Sections
Example
Summary
Callbacks
hash_slot/2
Nebulex.Adapter.Persistence
Sections
Default implementation
Summary
Callbacks
dump/3
load/3
Nebulex.Adapter.Queryable
Sections
Query values
Summary
Types
adapter_meta/0
opts/0
Callbacks
execute/4
stream/3
Nebulex.Adapter.Stats
Summary
Callbacks
stats/1
Functions
incr/3
init/1
Nebulex.Adapter.Transaction
Sections
Default implementation
Summary
Callbacks
in_transaction?/1
transaction/3
Nebulex.Adapters.Local
Sections
Overall features
Options
Usage
Eviction configuration
Stats
Queryable API
Examples
Extended API (convenience functions)
Summary
Functions
entry/1
entry/2
get_/2
take_/2
Nebulex.Adapters.Local.Generation
Sections
Options
Summary
Types
opts/0
server_ref/0
t/0
Functions
child_spec/1
delete_all/1
get_state/1
list/1
memory_info/1
new/2
newer/1
realloc/2
reset_timer/1
server/1
start_link/1
Nebulex.Adapters.Multilevel
Sections
Options
Shared options
Telemetry events
Stats
Extended API
Caveats of multi-level adapter
Nebulex.Adapters.Nil
Sections
Example
Nebulex.Adapters.Partitioned
Sections
Overall features
Partitioned Cache Topology
Additional implementation notes
Usage
Options
Shared options
Telemetry events
Adapter-specific telemetry events
Stats
Extended API
Caveats of partitioned adapter
Summary
Functions
do_put_all/4
eval_stream/3
with_dynamic_cache/3
Nebulex.Adapters.Replicated
Sections
Overall features
Replicated Cache Topology
Usage
Options
Shared options
Telemetry events
Stats
Extended API
Adapter-specific telemetry events
Caveats of replicated adapter
Summary
Functions
with_dynamic_cache/3
Nebulex.Cache
Sections
Telemetry events
Stats
Dispatching stats via Telemetry
Distributed topologies
Summary
Types
entries/0
key/0
opts/0
t/0
value/0
Callbacks
__adapter__/0
__default_key_generator__/0
all/2
config/0
count_all/2
decr/3
delete/2
delete_all/2
dispatch_stats/1
dump/2
expire/2
flush/0
get/2
get!/2
get_all/2
get_and_update/3
get_dynamic_cache/0
has_key?/1
in_transaction?/0
incr/3
init/1
load/2
put/3
put_all/2
put_dynamic_cache/1
put_new/3
put_new!/3
put_new_all/2
replace/3
replace!/3
size/0
start_link/1
stats/0
stop/1
stream/2
take/2
take!/2
touch/1
transaction/2
ttl/1
update/4
with_dynamic_cache/2
with_dynamic_cache/4
Nebulex.Caching
Summary
Functions
keyref/2
Nebulex.Caching.Decorators
Sections
cacheable decorator
cache_put decorator
cache_evict decorator
Shared Options
Putting all together
Summary
Types
keyref/0
match_fun/0
on_error_opt/0
references/0
Functions
build_keyref/2
cache_evict/1
cache_evict/3
cache_put/1
cache_put/3
cache_put/4
cacheable/1
cacheable/3
eval_cacheable/7
eval_match/5
run_cmd/5
Nebulex.Caching.KeyGenerator
Sections
Caveats when using the key generator
Summary
Types
t/0
Callbacks
generate/3
Nebulex.Caching.SimpleKeyGenerator
Nebulex.Entry
Summary
Types
t/0
Functions
decode/2
encode/2
expired?/1
ttl/1
Nebulex.Hook
Sections
before decorator
after_return decorator
around decorator
Putting all together
Summary
Types
hook_fun/0
t/0
Functions
after_return/1
after_return/3
around/1
around/3
before/1
before/3
eval_hook/3
Nebulex.RPC
Summary
Types
callback/0
node_callback/0
node_group/0
reducer/0
reducer_fun/0
task_sup/0
Functions
call/6
multi_call/3
multi_call/6
rpc_multi_call/3
rpc_multi_call/6
Nebulex.Stats
Sections
Measurements
Metadata
Summary
Types
t/0
Nebulex.Telemetry
Summary
Functions
attach_many/4
detach/1
execute/3
span/3
Nebulex.Telemetry.StatsHandler
Nebulex.Time
Summary
Functions
now/1
timeout?/1
Exceptions
Nebulex.KeyAlreadyExistsError
Summary
Types
t/0
Nebulex.QueryError
Summary
Types
t/0
Nebulex.RPCError
Summary
Types
t/0
Nebulex.RPCMultiCallError
Summary
Types
t/0
Nebulex.RegistryLookupError
Summary
Types
t/0
mix nbx
mix nbx.gen.cache
Sections
Command line options
Search documentation of Nebulex
Settings
View Source
mix nbx
(Nebulex v2.6.4)
Prints Nebulex tasks and their information.
mix
nbx
copy
×