koa-session-mysql

Features

• Simple mysql based session storage for koa-session

Install

1$ npm install koa-session-mysql --save
2$ yarn add koa-session-mysql

Usage

MySQL Table Layout (required fields)

1CREATE TABLE IF NOT EXISTS `session` (
2  `session_id` varchar(50) NOT NULL,
3  `created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
4  `modified` timestamp NULL DEFAULT NULL,
5  `payload` text
6) ENGINE=InnoDB;
7
8ALTER TABLE `session` ADD PRIMARY KEY (`session_id`);

Examples

1const _Koa = require('koa');
2const _koaSession = require('koa-session');
3const _mysql = require('mysql-magic');
4const _koaSessionMysql = require('koa-session-mysql');
5
6// initialize connection pool - koa-session-mysql access it by its name
7// somewhere during your applications bootstrap...initialize a custom pool. 
8// It consumes any pool-options of [mysqljs](https://github.com/mysqljs/mysql)
9_mysql.initPool('koa-session', {
10    host     : 'localhost',
11    user     : 'dev',
12    password : 'dev',
13    database : 'koa_test'
14});
15
16// set db pool + table for storage
17_koaSessionMysql.init('koa-session', 'session');
18
19// new Koa app + keygrip keys
20const _webapp = new _Koa();
21_webapp.keys = ['1234567890'];
22
23// initialize session middleware
24cwebapp.use(_koaSession({
25    store: _koaSessionMysql,
26    key: 'sid',
27    maxAge: 86400000,
28}, _webapp));
29
30_webapp.use(ctx => {
31    // ignore favicon
32    if (ctx.path === '/favicon.ico') return;
33
34    // increase counter
35    let n = ctx.session.views || 0;
36    ctx.session.views = ++n;
37
38    // show counter
39    ctx.body = n + ' views';
40});
41
42_webapp.listen(3000);
43console.log('listening on port 3000');

License

koa-session-mysql is OpenSource and licensed under the Terms of The MIT License (X11) - your're welcome to contribute