Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
interface-datastore
Advanced tools
datastore interface
$ npm i interface-datastore
<script>
tagLoading this module through a script tag will make it's exports available as InterfaceDatastore
in the global namespace.
<script src="https://unpkg.com/interface-datastore/dist/index.min.js"></script>
datastore-core/memory
datastore-level
(supports any levelup compatible backend)datstore-fs
datstore-s3
datastore-core/src/mount
datstore-core/src/keytransform
datastore-core/src/sharding
datstore-core/src/tiered
datastore-core/src/namespace
If you want the same functionality as go-ds-flatfs, use sharding with fs.
import FsStore from 'datastore-fs'
import { ShardingDataStore, shard } from 'datastore-core'
const fs = new FsStore('path/to/store')
// flatfs now works like go-flatfs
const flatfs = await ShardingStore.createOrOpen(fs, new shard.NextToLast(2))
Available via the interface-datastore-tests
module
import { interfaceDatastoreTests } from 'interface-datastore-tests'
describe('mystore', () => {
interfaceDatastoreTests({
async setup () {
return instanceOfMyStore
},
async teardown () {
// cleanup resources
}
})
})
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.
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.
import 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}`)
}
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')
https://ipfs.github.io/interface-datastore/
Licensed under either of
Contributions welcome! Please check out the issues.
Also see our contributing document for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
FAQs
datastore interface
The npm package interface-datastore receives a total of 77,544 weekly downloads. As such, interface-datastore popularity was classified as popular.
We found that interface-datastore demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.