Skip to content

Commit ed97674

Browse files
committed
Update guides
1 parent 6d0672a commit ed97674

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

guides/introduction/nbx-adapters.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Currently we officially support the following adapters:
88
| Generational Local Cache | [Nebulex.Adapters.Local][la] | [nebulex_local][la] |
99
| Partitioned | [Nebulex.Adapters.Partitioned][pa] | [nebulex_distributed][pa] |
1010
| Multilevel | [Nebulex.Adapters.Multilevel][ma] | [nebulex_distributed][ma] |
11+
| Coherent | [Nebulex.Adapters.Coherent][ca] | [nebulex_distributed][ca] |
1112
| Redis | [Nebulex.Adapters.Redis][nbx_redis] | [nebulex_redis_adapter][nbx_redis] |
1213
| Cachex | [Nebulex.Adapters.Cachex][nbx_cachex] | [nebulex_adapters_cachex][nbx_cachex] |
1314
| DiskLFU | [Nebulex.Adapters.DiskLFU][disk_lfu] | [nebulex_disk_lfu][disk_lfu] |
@@ -16,6 +17,7 @@ Currently we officially support the following adapters:
1617
[la]: http://hexdocs.pm/nebulex_local/3.0.0-rc.2/Nebulex.Adapters.Local.html
1718
[pa]: http://hexdocs.pm/nebulex_distributed/3.0.0-rc.2/Nebulex.Adapters.Partitioned.html
1819
[ma]: http://hexdocs.pm/nebulex_distributed/3.0.0-rc.2/Nebulex.Adapters.Multilevel.html
20+
[ca]: http://hexdocs.pm/nebulex_distributed/3.0.0-rc.2/Nebulex.Adapters.Coherent.html
1921
[nbx_redis]: http://hexdocs.pm/nebulex_redis_adapter/3.0.0-rc.2/Nebulex.Adapters.Redis.html
2022
[nbx_cachex]: http://hexdocs.pm/nebulex_adapters_cachex/3.0.0-rc.2/Nebulex.Adapters.Cachex.html
2123
[disk_lfu]: http://github.com/elixir-nebulex/nebulex_disk_lfu

guides/upgrading/v3.0.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@ end
3232

3333
---
3434

35+
## Update Adapter Compile-Time Options
36+
37+
Some adapters support compile-time options like `:primary_storage_adapter` for
38+
configuring the underlying storage adapter. In v3, these options must be wrapped
39+
in the `:adapter_opts` keyword list.
40+
41+
For example, if you're using `Nebulex.Adapters.Partitioned` with a custom
42+
primary storage adapter:
43+
44+
```diff
45+
defmodule MyApp.PartitionedCache do
46+
use Nebulex.Cache,
47+
otp_app: :my_app,
48+
adapter: Nebulex.Adapters.Partitioned,
49+
- primary_storage_adapter: Nebulex.Adapters.Local
50+
+ adapter_opts: [primary_storage_adapter: Nebulex.Adapters.Local]
51+
end
52+
```
53+
54+
---
55+
3556
## Update Cache API Calls
3657

3758
The most significant change is in the [Cache API][cache_api]. Nebulex v3 has a

0 commit comments

Comments
 (0)