Nebulous Plasma Muffin

    interface-datastore
    TypeScript icon, indicating that this package has built-in type declarations

    6.1.0 • Public • Published

    interface-datastore

    codecov GitHub Workflow Status

    Implementation of the datastore interface in JavaScript

    Lead Maintainer

    Alex Potsides

    Table of Contents

    Implementations

    If you want the same functionality as go-ds-flatfs, use sharding with fs.

    const FsStore from 'datastore-fs')
    const ShardingStore from 'datastore-core').ShardingDatatstore
    const NextToLast from 'datastore-core').shard.NextToLast
    
    const fs = new FsStore('path/to/store')
    
    // flatfs now works like go-flatfs
    const flatfs = await ShardingStore.createOrOpen(fs, new NextToLast(2))

    Install

    $ npm install interface-datastore

    Test suite

    Available via the interface-datastore-tests module

    import { interfaceDatastoreTests } from 'interface-datastore-tests'
    
    describe('mystore', () => {
      interfaceDatastoreTests({
        async setup () {
          return instanceOfMyStore
        },
        async teardown () {
          // cleanup resources
        }
      })
    })

    Aborting requests

    Most API methods accept an AbortSignal as part of an options object. Implementations may listen for an abort event emitted by this object, or test the signal.aborted property. When received implementations should tear down any long-lived requests or resources created.

    Concurrency

    The streaming (put|get|delete)Many methods are intended to be used with modules such as it-parallel-batch to allow calling code to control levels of parallelisation. The batching method ensures results are returned in the correct order, but interface implementations should be thread safe.

    const batch from 'it-parallel-batch')
    const source = [{
      key: ..,
      value: ..
    }]
    
    // put values into the datastore concurrently, max 10 at a time
    for await (const { key, data } of batch(store.putMany(source), 10)) {
      console.info(`Put ${key}`)
    }

    Keys

    To allow a better abstraction on how to address values, there is a Key class which is used as identifier. It's easy to create a key from a Uint8Array or a string.

    const a = new Key('a')
    const b = new Key(new Uint8Array([0, 1, 2, 3]))

    The key scheme is inspired by file systems and Google App Engine key model. Keys are meant to be unique across a system. They are typically hierarchical, incorporating more and more specific namespaces. Thus keys can be deemed 'children' or 'ancestors' of other keys:

    • new Key('/Comedy')
    • new Key('/Comedy/MontyPython')

    Also, every namespace can be parameterized to embed relevant object information. For example, the Key name (most specific namespace) could include the object type:

    • new Key('/Comedy/MontyPython/Actor:JohnCleese')
    • new Key('/Comedy/MontyPython/Sketch:CheeseShop')
    • new Key('/Comedy/MontyPython/Sketch:CheeseShop/Character:Mousebender')

    API

    https://ipfs.github.io/interface-datastore/

    Contribute

    PRs accepted.

    Small note: If editing the Readme, please conform to the standard-readme specification.

    License

    MIT 2017 © IPFS

    Install

    npm i interface-datastore

    DownloadsWeekly Downloads

    59,487

    Version

    6.1.0

    License

    MIT

    Unpacked Size

    45.2 kB

    Total Files

    16

    Last publish

    Collaborators

    • daviddias
    • dignifiedquire
    • achingbrain