DAG based key value store.
npm install @web3-storage/pail
DAG based key value store. Sharded DAG that minimises traversals and work to build shards.
* 📖 Read the SPEC.
* 🎬 Watch the Presentation.
``
npm install @web3-storage/pail
`js
import { put, get, del } from '@web3-storage/pail'
import { ShardBlock } from '@web3-storage/pail/shard'
import { MemoryBlockstore } from '@web3-storage/pail/block'
// Initialize a new bucket
const blocks = new MemoryBlockstore()
const init = await ShardBlock.create() // empty root shard
await blocks.put(init.cid, init.bytes)
// Add a key and value to the bucket
const { root, additions, removals } = await put(blocks, init.cid, 'path/to/data0', dataCID0)
console.log(new root: ${root})
// Process the diff
for (const block of additions) {
await blocks.put(block.cid, block.bytes)
}
for (const block of removals) {
await blocks.delete(block.cid)
}
`
If adding many multiple items to the pail together, it is faster to batch them together.
`js
import { put, get, del } from '@web3-storage/pail'
import { ShardBlock } from '@web3-storage/pail/shard'
import { MemoryBlockstore } from '@web3-storage/pail/block'
import * as Batch from '@web3-storage/pail/batch'
// Initialize a new bucket
const blocks = new MemoryBlockstore()
const init = await ShardBlock.create() // empty root shard
await blocks.put(init.cid, init.bytes)
const batch = await Batch.create(blocks, init.cid)
// items is an array of { key: string, value: CID } - the items to add to the pail
for (const item of items) {
await batch.put(item.key, item.value)
}
const { root, additions, removals } = await batch.commit()
console.log(new root: ${root})
// Process the diff
for (const block of additions) {
await blocks.put(block.cid, block.bytes)
}
for (const block of removals) {
await blocks.delete(block.cid)
}
``
Feel free to join in. All welcome. Open an issue!
Dual-licensed under MIT or Apache 2.0