This is a simple MySQL backed session store for connect.
It uses the node-mysql module already installed in your project to establish and pool connections.
table: the name of the database table that should be used for storing sessions. Defaults to
pool: a node-mysql connection pool or
trueif the store should instantiate its own pool
config: the configuration that will be passed to
createPool()if pool is
retries: how many times to retry connecting to the database before failing. Defaults to
keepalive: keep pooled connections open by periodically pinging them. Set to
trueto use the default interval of
30000ms or provide a positive number to set your own. Defaults to
cleanup: a boolean specifying whether to enable the cleanup events. note that if this is disabled, cleanup will not take place at all and should be done externally. Sessions with an expiration time of
0will always be ignored and should also be cleaned up externally.
secret: key that will be used to encrypt session data. If this option is not provided then data will be stored in plain text
algorithm: the algorithm that should be used to encrypt session data. Defaults to
Here are some example use cases to get your application up and running.
Default use case
Simple use case using the
express framework &
connect-session middleware with
connect-mysql as the data store.
var express =session =MySQLStore = sessionoptions =config:user: 'dbuser'password: 'dbpassword'database: 'db';var app = express;app;app
Connection pooling example
For those MySQL installations that make use of pools the following examples are available.
var mysql =options =pool: mysql;
var options =pool: trueconfig:user: 'dbuser'password: 'dbpassword'database: 'db';
Ssession encryption example
This option enables transparent session encryption assisting
var options =secret: 'thesessionsecret'config:user: 'dbuser'password: 'dbpassword'database: 'db';
Contributions are welcome & appreciated. Refer to the contributing document to help facilitate pull requests.
This software is licensed under the MIT License.
Nathan LaFreniere, Copyright (c) 2012 &Yet