node package manager


Connect Session Store using Sequelize

Build Status

connect-session-sequelize is a SQL session store using Sequelize.js.


Please note that the most recent version requires express 4. If you use express 3 you should install version 0.0.5 and follow the instructions in the previous README.

$ npm install connect-session-sequelize


  • db a successfully connected Sequelize instance
  • table (optional) a table/model which has already been imported to your Sequelize instance, this can be used if you want to use a specific table in your db
  • extendDefaultFields (optional) a way add custom data to table columns. Useful if using a custom model definition


With connect

var connect = require('connect')
    // for express, just call it with 'require('express-session').Store' 
    , SequelizeStore = require('connect-session-sequelize')(connect.session.Store);
    store: new SequelizeStore(options)
    , secret: 'CHANGEME'

With express 4:

// load dependencies 
var express = require('express')
var Sequelize = require('sequelize')
var cookieParser = require('cookie-parser')
var session = require('express-session');
// initalize sequelize with session store 
var SequelizeStore = require('connect-session-sequelize')(session.Store);
// create database, ensure 'sqlite3' in your package.json 
var sequelize = new Sequelize(
"password", {
    "dialect": "sqlite",
    "storage": "./session.sqlite"
// configure express 
var app = express()
  secret: 'keyboard cat',
  store: new SequelizeStore({
    db: sequelize
  proxy: true // if you do SSL outside of node. 
// continue as normal 

SequelizeStore.sync() - will run a sequelize sync() operation on the model for an initialized SequelizeStore object. Use this if you would like the the db table to be created for you.

Session expiry

Session records are automatically expired and removed from the database on an interval. The cookie.expires property is used to set session expiry time. If that property doesn't exist, a default expiry of 24 hours is used. Expired session are removed from the database every 15 minutes by default. That interval as well as the default expiry time can be set as store options:

new SequelizeStore({
  checkExpirationInterval: 15 * 60 * 1000, // The interval at which to cleanup expired sessions in milliseconds.
  expiration: 24 * 60 * 60 * 1000  // The maximum age (in milliseconds) of a valid session.

Add custom field(s) as a column

The extendDefaultFields can be used to add custom fields to the session table. These fields will be read-only as they will be inserted only when the session is first created as defaults. Make sure to return an object which contains unmodified data and expires properties, or else the module functionality will be broken:

var Session = sequelize.define('Session', {
  sid: {
    type: Sequelize.STRING,
    primaryKey: true
  userId: Sequelize.STRING,
  expires: Sequelize.DATE,
  data: Sequelize.STRING(50000)
function extendDefaultFields(defaults, session) {
  return {
    expires: defaults.expires,
    userId: session.userId
var store = new SessionStore({
  db: sequelize,
  table: 'Session',
  extendDefaultFields: extendDefaultFields