orbit-db-xdocs
Extended-Document Store for OrbitDB
Extended-document store format for OrbitDB. Allows SET opcode to make updating databases simpler and lighter. Stores documents by _id field by default but you can also specify a custom field to index by.
Table of Contents
Install
This project uses npm and nodejs
npm install orbit-db-xdocs
Usage
const IPFS = require('ipfs')
const OrbitDB = require('orbit-db')
const ipfs = new IPFS()
const orbitdb = await OrbitDB.createInstance(ipfs)
OrbitDB.addDatabaseType(XDocumentStore.type, XDocumentStore) //XDocumentStore.type is equivalent to 'xdocs'
const xdocstore = await orbitdb.create('db name', 'xdocs')
xdocstore.put({ _id: 'hello world', doc: 'all the things' })
.then(() => xdocstore.put({ _id: 'sup world', doc: 'other things' }))
.then(() => xdocstore.set('hello world', {doc: 'new things'})
.then(() => xdocstore.get('hello'))
.then((value) => console.log(value))
// [{ _id: 'hello world', doc: 'new things'}]You can specify the field to index by in the options:
const xdocstore = await orbitdb.xdocs('db name', { indexBy: 'doc' })
xdocstore.put({ _id: 'hello world', doc: 'some things' })
.then(() => xdocstore.put({ _id: 'hello universe', doc: 'all the things' }))
.then(() => xdocstore.get('all'))
.then((value) => console.log(value))
// [{ _id: 'hello universe', doc: 'all the things'}]You can also use a mapper to query the documents
const xdocstore = await orbitdb.xdocs('db name')
xdocstore.put({ _id: 'hello world', doc: 'some things', views: 10 })
.then(() => xdocstore.put({ _id: 'hello universe', doc: 'all the things', views: 100 }))
.then(() => xdocstore.put({ _id: 'sup world', doc: 'other things', views: 5 }))
.then(() => xdocstore.query((e)=> e.views > 5))
.then((value) => console.log(value))
// [{ _id: 'hello world', doc: 'some things', views: 10}, { _id: 'hello universe', doc: 'all the things', views: 100}]API
See orbit-db API documentation for full details
docstore(name, options)
Package: orbit-db-xdocs
const db = await orbitdb.xdocs('orbit.users.shamb0t.profile')By default, documents are indexed by field '_id'. You can also specify the field to index by:
const db = await orbitdb.xdocs('orbit.users.shamb0t.profile', { indexBy: 'name' })-
put(doc)
db.put({ _id: 'QmAwesomeIpfsHash', name: 'shamb0t', followers: 500 }).then((hash) => ...)
-
get(key)
const profile = db.get('shamb0t') .map((e) => e.payload.value) // [{ _id: 'shamb0t', name: 'shamb0t', followers: 500 }]
-
query(mapper)
const all = db.query((doc) => doc.followers >= 500) // [{ _id: 'shamb0t', name: 'shamb0t', followers: 500 }]
-
del(key)
db.del('shamb0t').then((removed) => ...)
-
set(key,edits)
db.set('shamb0t',{newvalue: 101, modified: true}).then((edited) => ...)
-
events
db.events.on('data', (dbname, event) => ... )
See events for full description.
Contributing
Feel free to contribute if you'd like.
License
GNU AGPLv3, see LICENSE.