connect-mssql-v2 (original) (raw)
connect-mssql-v2
SQL Server session store for Connect/Express based on node-mssql and the deprecated/abandoned project connect-mssql.
Installation
npm install connect-mssql-v2
Prerequisites
Before you can use session store, you must create a table. Recommended table name is sessions but you can change it via options. The database user must have db_datareader, db_datawriter, and db_ddladmin permissions.
CREATE TABLE [dbo].[sessions]( [sid] nvarchar NOT NULL PRIMARY KEY, [session] nvarchar NOT NULL, [expires] [datetime] NOT NULL )
Usage
Javascript
const MSSQLStore = require('connect-mssql-v2');
const config = { user: '...', password: '...', server: 'localhost', // You can use 'localhost\instance' to connect to named instance database: '...', options: { encrypt: true, // Use this if you're on Windows Azure trustServerCertificate: true, // use this if your MS SQL instance uses a self signed certificate }, };
app.use( session({ store: new MSSQLStore(config, options), // options are optional secret: 'supersecret', }), );
Typescript
import MSSQLStore from 'connect-mssql-v2';
const config = { user: '...', password: '...', server: 'localhost', // You can use 'localhost\instance' to connect to named instance database: '...', options: { encrypt: true, // Use this if you're on Windows Azure trustServerCertificate: true, // use this if your MS SQL instance uses a self signed certificate }, };
app.use( session({ store: new MSSQLStore(config, options), // options are optional secret: 'supersecret', }), );
Options
- options.table - Table to use as session store. Default:
[sessions] - options.ttl - (Time To Live) Determines the expiration date. Default:
1000 * 60 * 60 * 24(24 hours) - options.autoRemove - Determines if expired sessions should be autoremoved or not. If value is
truethen a new function,destroyExpired(), will autodelete expired sessions on a set interval. Default:false - options.autoRemoveInterval - Sets the timer interval for each call to
destroyExpired(). Default:1000 * 60 * 10(10 min) - options.preRemoveCallback - Is the callback function for
destroyExpired()that is called before the actual removal. If this returns a promise, the removal will wait for the promise to resolve. Default:undefined - options.autoRemoveCallback - Is the callback function for
destroyExpired(). Default:undefined - options.useUTC - Determines if we are to use the
GETUTCDATEinstead ofGETDATEDefault:true
Advanced usage
const store = new MSSQLStore(config, options);
store.on('connect', () => { // ... connection established });
store.on('error', (error) => { // ... connection error });
store.on('sessionError', (error, classMethod) => { // ... any error that occurs within a store method // classMethod will return the method name (get, set, length, etc) }) app.use(session({ store: store secret: 'supersecret' }));
Configuration
To see all options please visit node-mssql docs.
Upgrading from v4.x.x to v5.x.x
Ensure you're running Node >=v15
Upgrading from v3.x.x to v4.x.x
Ensure you're running Node >=v13
Upgrading from v2.x.x to v3.x.x
The key step to upgrading is to include
trustServerCertificate: true;
in your options object for the store config (see either javascript or typescript example) if running a local instance of MS SQL with a self signed certificate. If you do not provide this, you will get a connection error
ConnectionError: Failed to connect to databaseserver:1433 - self signed certificate
Upgrading from v1.x.x to v2.x.x
It is no longer required to pass in the express-session store. Please see the Usage section on the updated import/require method.
Contributions
Contributions are welcome, please submit a PR which will be reviewed.
Reporting Issues
Please report issues/errors to Github's issue tracker: connect-mssql-v2 issue tracker. Include issue, expected behavior, and how to replicate the issue.