lmangani / gun-elastic

Elasticsearch storage adapter for Gun DB :gun:

Gun-Elastic

Elasticsearch native persistence layer for Gun, a realtime, distributed, offline-first, graph database engine.

This gun storage adapter interfaces with Elasticsearch using an extended flint node strategy:

• get request expect to read an entire Gun node.
• put requests write an entire Gun node.
  • node key-value structure (soul,relation,field,value,state) optionally saved to secondary index

THIS WORK IS EXPERIMENTAL WORK IN PROGRESS! USE AT YOUR OWN RISK!

Comments and PR/Contributions are super welcome!

---

Installation

npm install gun-elastic.

const Gun = require('gun');

// Must be added after Gun but before instantiating Gun
require('gun-elastic');

// Instantiate Gun
const gun = new Gun({
    file: false,
    web: httpServer,

    // The following are defaults.
    elastic: {
        host: 'localhost',
        port: '9200',
        index: 'gun_es',
        type: 'gun_data',
        
        store_keys: false,
        store_keys_index: 'gun_es_keys'
    }
});

Screenshots

Filtered Network Relations

Search and Display node relations using the kbn_graph plugin

Todo

• Optional Key Storage in secondary index
• Authentication support, array of servers, etc
• Add tests with ES mockups

Acknowledgement

Gun is open-sourced and copyrighted by Mark Nadal

Elasticsearch and Kibana are trademarks of Elasticsearch BV, registered in the U.S. and in other countries.

This extension is made possible by gun-flint @sjones6

Issues & Contributing

Issues welcome on Github.

Community contributions welcome. PRs accepted after code review.