RAD

RAD is a storage adapter for GUN that stores data at disk using a radix tree, it looks like this:

As you see, we are able to store 3 records (Alex, Alexandria, Andrew) in only 2 rows because "Alex" and "Alexandria" share a common prefix.

Because writing storage adapters for GUN has a bunch of nuances and performance tradeoffs, we've designed RAD to handle these nuances for you and chunk GUN's graph into traditional files that can be dumped to disk. It handles correctly merging updates into each batch, managing memory allocation on heavy load, reads across ranges of chunks, and more with generalizable performance strategy.

However, RAD does not have an opinion on what storage engine should actually be used, and requires you pass it a storage interface - whether that be fs, S3, indexedDB, localStorage, IPFS, or others.

Install

RAD is now the default with GUN in NodeJS. If you want to use RAD by itself, skip this section.

To use RAD with GUN in the browser, include:

<script src="https://cdn.jsdelivr.net/npm/gun/gun.js"></script>
<script src="https://cdn.jsdelivr.net/npm/gun/lib/radix.js"></script>
<script src="https://cdn.jsdelivr.net/npm/gun/lib/radisk.js"></script>
<script src="https://cdn.jsdelivr.net/npm/gun/lib/store.js"></script>
<script src="https://cdn.jsdelivr.net/npm/gun/lib/rindexed.js"></script>

To use it directly:

// var Rad = require('gun/lib/radisk'); // in NodeJS
var Rad = window.Radisk;
var rad = Rad(opt);

What is opt?

API

RAD takes 1 parameter, an option object, with at least these 2 properties:

• put function key, data, cb for saving chunks.
• get function key, cb for reading chunks.

It is easier to understand with some examples, here is a localStorage plugin for RAD:

var opt = {}, store = localStorage;
opt.put = function(key, data, cb){
  store[''+key] = data;
  cb(null, 1);
}
opt.get = function(key, cb){
  cb(null, store[''+key])
}

That is all! It should be easy to implement or integrate any storage engine, or use any of the several already included.

WIP

More docs coming soon!