connect-leveldb

connect-leveldb

This module provides a session store for connect which uses leveldb and is heavily based on the connect-redis module.

Installation

npm install connect-leveldb

Options

• db An existing db
• dbLocation The location of the database to open / create.
• ttl Session time to live (TTL) in seconds.
• prefix Key prefix defaults to "sess:"

Usage

Very simple to setup.

var connect = require('connect')
var LeveldbStore = require('connect-leveldb')(connect)

connect()
  .use(connect.session({ store: new LeveldbStore(options), secret: 'keyboard cat' }))

Express 3.x users

var express = require('express');
var LeveldbStore = require('connect-leveldb')(express);
var app = express();
app.use(express.cookieParser());
app.use(express.session({ store: new LeveldbStore({ dbLocation: __dirname + '/db' }), secret: 'keyboard cat' }));

Express 4.x users

var express = require('express');
var cookieParser = require('cookie-parser')
var session = require('express-session')
var LeveldbStore = require('connect-leveldb')(session);
var app = express();
app.use(cookieParser());
app.use(session({ store: new LeveldbStore({ dbLocation: __dirname + '/db' }), secret: 'keyboard cat' }));

With Sublevel you need to specify the value encoding:

var express = require('express');
var LevelUp = require('level');
var Sublevel = require('level-sublevel');
var LeveldbStore = require('connect-leveldb')(express);
var db = Sublevel(LevelUp(__dirname + '/db'));
var sessions = db.sublevel('sessions', { valueEncoding: 'json' });

Things to Note

This module uses a lazy deletion model which means it will only clean up sessions IF a user access the site after they expire. It is primarily designed for use on sites with users who regularly revisit the site for updates.

Licence

Copyright (c) 2013 Mark Wolfe Licensed under the MIT license.