hyperdb-storage

    0.1.1 • Public • Published

    hyperdb-storage

    Use a hyperdb as a storage backend for Dat, or any other hyper*-structure (eg. hypercore, hyperdrive, hypertrie).

    Note: this is a pretty experimental package, it's unclear if this is actually useful - I intended this as a way of sharing hypercore keys between devices, but there are probably better solutions for this now.

    npm i hyperdb-storage
    

    Example

    const hyperdb = require('hyperdb')
    const storage = require('hyperdb-storage')
     
    // This hyperdb is stored on disk.
    const db = hyperdb('my.db')
     
    // This hyperdb is stored inside the hyperdb `db`.
    // All of its contents are stored under the prefix 'example-db'.
    const nestedDb = hyperdb(storage(db, 'example-db'))
     
    // You can also store other hyper*-structures...
    const nestedFeed = hypercore(storage(db, 'example-feed'))
     
    // ...or store a Dat inside a hyperdb.
    const nestedDat = Dat(storage(db, 'example-dat'))

    API

    storage(db, prefix, [storageOverrides])
    • db is an instance of hyperdb.

    • prefix is a string. All 'files' will be stored under this prefix.

    • storageOverrides is an optional object which maps the SLEEP file names to storage providers.

      A storage provider is either a string defining the directory where you want to store files, or a function which takes a filename string and returns a random-access-storage instance.

      Example:

      // The metadata for this hyperdb is stored inside `db`, but the data files are
      // stored on disk, and the secret keys are stored in the system keychain.
      const keychain = require('random-access-keychain')
      const exampleDb = hyperdb(storage(db, 'example-db', {
        data: 'data',
        secret_key: file => keychain('hyperdb secret key', file),
      }))

    Important: You need to be careful with conflicts in the parent db if you have granted write access to multiple keys. You should use the conflict resolution options in the hyperdb constructor, eg:

    hyperdb('my.db', {
      firstNode: true, // just return the first node found
      // ...or...
      reduce: (a, b) => a, // perform app-specific conflict resolution
    })

    If you don't use either of these, and more than one node is found for a given key, this module will emit a warning and use the first node.

    Contribute

    PRs accepted.

    License

    MIT © 2018 harry lachenmayer

    Install

    npm i hyperdb-storage

    DownloadsWeekly Downloads

    1

    Version

    0.1.1

    License

    MIT

    Unpacked Size

    5.84 kB

    Total Files

    4

    Last publish

    Collaborators

    • lachenmayer