level-sublevel

What is level-sublevel?

The level-sublevel package is a plugin for LevelDB that allows you to create sublevel sections within a LevelDB database. This can help in organizing and managing data more effectively by creating isolated namespaces within the same database.

What are level-sublevel's main functionalities?

Creating Sublevels

This feature allows you to create sublevels within your LevelDB database. In the example, two sublevels 'users' and 'posts' are created, and data is added to each sublevel.

const level = require('level');
const sublevel = require('level-sublevel');

const db = level('./mydb');
const sub = sublevel(db);
const users = sub.sublevel('users');
const posts = sub.sublevel('posts');

users.put('user1', { name: 'Alice' }, function (err) {
  if (err) return console.log('Ooops!', err);
  console.log('User added!');
});

posts.put('post1', { title: 'Hello World' }, function (err) {
  if (err) return console.log('Ooops!', err);
  console.log('Post added!');
});

Batch Operations

This feature allows you to perform batch operations on a sublevel. In the example, multiple user records are added in a single batch operation.

const level = require('level');
const sublevel = require('level-sublevel');

const db = level('./mydb');
const sub = sublevel(db);
const users = sub.sublevel('users');

users.batch()
  .put('user2', { name: 'Bob' })
  .put('user3', { name: 'Charlie' })
  .write(function (err) {
    if (err) return console.log('Ooops!', err);
    console.log('Batch operation complete!');
  });

Stream Operations

This feature allows you to create a read stream to iterate over all entries in a sublevel. In the example, all user records are read and printed to the console.

const level = require('level');
const sublevel = require('level-sublevel');

const db = level('./mydb');
const sub = sublevel(db);
const users = sub.sublevel('users');

users.createReadStream()
  .on('data', function (data) {
    console.log(data.key, '=', data.value);
  })
  .on('error', function (err) {
    console.log('Error:', err);
  })
  .on('end', function () {
    console.log('Stream ended');
  });

Other packages similar to level-sublevel

levelup

LevelUP is a higher-level module for working with LevelDB. It provides a more user-friendly API compared to the lower-level LevelDB bindings. While it does not provide sublevel functionality out of the box, it can be extended with plugins like level-sublevel.

subleveldown

Subleveldown is another package that provides sublevel functionality for LevelDB. It is similar to level-sublevel but is designed to work with the latest versions of LevelUP and LevelDB. It offers a more modern and maintained approach to creating sublevels.

level-party

Level-party is a package that allows multiple processes to safely share a single LevelDB instance. While it does not provide sublevel functionality directly, it can be used in conjunction with subleveldown or level-sublevel to achieve similar results.

README

level-sublevel

Separate sections of levelup, with hooks!

This module allows you to create separate sections of a levelup database, kinda like tables in an sql database, but evented, and ranged, for real-time changing data.

level-sublevel@6 BREAKING CHANGES

The long awaited level-sublevel rewrite is out! You are hereby warned this is a significant breaking change. So it's good to use it with a new project, The user api is mostly the same as before, but the way that keys are encoded has changed, and this means you cannot run 6 on a database you created with 5.

Also, createWriteStream has been removed, in anticipation of this change use something like level-write-stream

Legacy Mode

Using leveldb with legacy mode is the simplest way to get the new sublevel on top of a database that used old sublevel. Simply require sublevel like this:

var level = require('level')
                                   //  V *** require legacy.js ***
var sublevel = require('level-sublevel/legacy')
var db = sublevel(level(path))

Migration Tool

@calvinmetcalf has created a migration tool: sublevel-migrate

This can be used to copy an old level-sublevel into the new format.

Stability

Unstable: Expect patches and features, possible api changes.

This module is working well, but may change in the future as its use is further explored.

Example

var LevelUp = require('levelup')
var Sublevel = require('level-sublevel')

var db = Sublevel(LevelUp('/tmp/sublevel-example'))
var sub = db.sublevel('stuff')

//put a key into the main levelup
db.put(key, value, function () {})

//put a key into the sub-section!
sub.put(key2, value, function () {})

Sublevel prefixes each subsection so that it will not collide with the outer db when saving or reading!

Hooks

Hooks are specially built into Sublevel so that you can do all sorts of clever stuff, like generating views or logs when records are inserted!

Records added via hooks will be atomically inserted with the triggering change.

Hooks Example

Whenever a record is inserted, save an index to it by the time it was inserted.

var sub = db.sublevel('SEQ')

db.pre(function (ch, add) {
  add({
    key: ''+Date.now(), 
    value: ch.key, 
    type: 'put',
    // NOTE: pass the destination db to add the value to that subsection!
    prefix: sub
  })
})

db.put('key', 'VALUE', function (err) {
  // read all the records inserted by the hook!
  sub.createReadStream().on('data', console.log)
})

Notice that the prefix property to add() is set to sub, which tells the hook to save the new record in the sub section.

Batches

In sublevel batches also support a prefix: subdb property, if set, this row will be inserted into that database section, instead of the current section, similar to the pre hook above.

var sub1 = db.sublevel('SUB_1')
var sub2 = db.sublevel('SUM_2')

sub.batch([
  {key: 'key', value: 'Value', type: 'put'},
  {key: 'key', value: 'Value', type: 'put', prefix: sub2},
], function (err) {...})

License

MIT