level-blocked

Blocked data storage on top of LevelUp

npm install level-blocked
20 downloads in the last month

level-blocked

Blocked data storage on top of LevelUp.

build status

testling badge

work in progress

There still are methods and options missing, but eventually the api will mirror the relevant parts of the node.js fs api as closely as possible.

key design

'<key>\xffblocks\xff<block index>'

api

var blocks = blocked(db, [blockSize])

  • db: A LevelUp database.
  • blockSize: Each block's maximum size in bytes, defaults to 1024.
var level = require('level');
var blocked = require('level-blocked');

var db = level(__dirname + '/db');
var blocks = blocked(db, 3);

blocks.createReadStream(key[, opts])

  • key: The address of your data
  • opts.start: Offset the read stream by that number of bytes
  • opts.end: Last byte to read
db.batch()
.put('key\xffblocks\xff0', new Buffer('val'))
.put('key\xffblocks\xff1', new Buffer('ue'))
.write(function(err) {
  if (err) throw err;

  blocks.createReadStream('key').on('data', function(block) {
    console.log('block: %s', block);
    // => block: val
    // => block: ue
  });
});

blocks.read(key[, opts], cb)

Callback version of blocks.createReadStream(). The same options apply.

db.batch()
.put('key\xffblocks\xff0', new Buffer('val'))
.put('key\xffblocks\xff1', new Buffer('ue'))
.write(function(err) {
  if (err) throw err;

  blocks.read('key', function(err, block) {
    if (err) throw err;
    console.log('block: %s', block);
    // => block: value
  });
});

installation

With npm do:

npm install level-blocked

license

(MIT)

Copyright (c) 2013 Julian Gruber <julian@juliangruber.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you