Store Koa sessions in a database using Sequelize.
Sequelize 4.12.0 or higher is supported.
Notice: This is an older module that works best with
koa-generic-session. However, most Koa apps today use the more modern koa-session library. Unfortunately, this module is not designed to work with that.
It stores session data in a database defined by you, using the Sequelize ORM.
It has been tested with SQLite, MySQL, PostgreSQL, and Microsoft SQL Server.
npm install --save koa-generic-session-sequelize
Full example in examples/basic_sqlite.js.
const SequelizeStore = ;// set up Sequelize in the usual manner// for a quick example using the sqlite3 module:const sequelize =logging: falsedialect: 'sqlite'storage: __dirname + '/example.db';app;
tableName- Name of the session table in the db (default:
modelName- Name of the session model to be registered with Sequelize (default:
sync- Create the sessions table if it doesn’t exist (default:
true, how long to wait, in ms, for the sync to complete (default:
gcFrequency- Do garbage collection after approximately this many requests. This deletes expired session data from the table. Set to
0to never do garbage collection. (default:
10000, or approximately every 10,000 requests)
timestamps- If true, the table will have
browserSessionLifetime- How long, in ms, to remember sessions without a TTL: sessions that only last until the browser is closed. Some session managers, including
koa-session-minimal, will ignore this and use a reasonable default. (default:
Sequelize supports replication (configured as
options.replication). This lets you use one server for writes and another server, or a group of servers, for reads.
However, if there is any lag between the time a write is committed and when it becomes visible on your read servers, you should not use that configuration for session data. Create a separate Sequelize instance for the session data that does not use replication.
To run the test suite, clone this repository and run
npm install in the checkout directory. Then run
npm test. This will exercise the library against SQLite.
To test against MySQL, PostgreSQL, or SQL Server, edit
test/config.js. Uncomment sections referencing those servers and enter your credentials. The table
_sess_test will be created during testing.