const kvstore = orbit.kvstore('db name')
const events = orbit.eventlog('db name')
const feed = orbit.feed('db name')
const counters = orbit.counter('db name')

Documentation for individual stores are WIP, please see each store's source code for available public methods.

Install

npm install orbit-db

Examples

To run the examples below, make sure to run a local orbit-server

Browser examples

Build the examples:

npm install
npm run build:examples

Then open examples/browser.html or examples/index.html. See the full example here.

<html>
  <head>
    <meta charset="utf-8">
  </head>
  <body>
    <script type="text/javascript" src="../dist/orbitdb.min.js" charset="utf-8"></script>
    <script type="text/javascript" src="../node_modules/logplease/dist/logplease.min.js" charset="utf-8"></script>
    <script type="text/javascript" src="../node_modules/ipfs/dist/index.min.js" charset="utf-8"></script>

    <script type="text/javascript">
      const ipfs = window.Ipfs();
      OrbitDB.connect('localhost:3333', 'user1', '', ipfs)
        .then((orbit) => orbit.kvstore('test'))
        .then((db) => db.put('hello', 'world'))
        .then((res) => {
            const result = db.get(key)
            console.log(result)
        })
    </script>
  </body>
</html>

Node.js examples

Before running the examples, install dependencies with:

npm install

Key-Value store example:

node examples/keyvalue.js <host:port> <username> <channel> <key> <value>

Event log example (run several in separate shells):

node examples/eventlog.js <host:port> <username> <channel> <data> <interval in ms>

Benchmark writes:

node examples/benchmark.js <host:port> <username> <channel>;

API

NOTE: the API documentation is currently out of date. It will be updated soon!

See usage example below

OrbitDB calls its namespaces channels. A channel is similar to "table", "keyspace", "topic", "feed" or "collection" in other db systems.

connect(<host:port>, username, password)

channel(name, password)

    .add(data: String) // Insert an event to a channel, returns <ipfs-hash> of the event

    .iterator([options]) // Returns an iterator of events

        // options : { 
        //   gt: <ipfs-hash>,   // Return events newer than <ipfs-hash>
        //   gte: <ipfs-hash>,  // Return events newer then <ipfs-hash> (inclusive)
        //   lt: <ipfs-hash>,   // Return events older than <ipfs-hash>
        //   lte: <ipfs-hash>,  // Return events older than <ipfs-hash> (inclusive)
        //   limit: -1,         // Number of events to return, -1 returns all, default 1
        //   reverse: true      // Return items oldest first, default latest first
        // }

    .put(key, data: String) // Insert (key,value) to a channel

    .get(key) // Retrieve value

    .del({ key: <key or hash> }) // Remove entry

    .delete() // Deletes the channel, all data will be "removed" (unassociated with the channel, actual data is not deleted from ipfs)

Usage

const async   = require('asyncawait/async');
const ipfsAPI = require('ipfs-api');
const OrbitDB = require('orbit-db');

// local ipfs daemon
const ipfs = ipfsAPI();

async(() => {
    // Connect
    const orbit = await(OrbitClient.connect('localhost:3333', 'usernamne', '', ipfs));

    /* Event Log */
    const eventlog = orbit.eventlog('eventlog test');
    const hash = await(eventlog.add('hello')); // <ipfs-hash>

    // Remove event
    await(eventlog.remove(hash));

    // Iterator options
    const options = { limit: -1 }; // fetch all messages

    // Get events
    const iter = eventlog.iterator(options); // Symbol.iterator
    const next = iter.next(); // { value: <item>, done: false|true}

    // OR:
    // var all = iter.collect(); // returns all elements as an array

    // OR:
    // for(let i of iter)
    //   console.log(i.hash, i.item);

    /* Delete database locally */
    eventlog.delete();

    /* KV Store */
    const kvstore = orbit.kvstore('kv test');
    await(kvstore.put('key1', 'hello world'));
    kvstore.get('key1'); // returns "hello world"
    await(kvstore.del('key1'));
})();

Development

Run Tests

npm test

Keep tests running while development:

mocha -w

Build distributables

npm install
npm run build