https://github.com/mcartoixa/connect-tedious

Connect session store for SQL Server, using Tedious.
https://github.com/mcartoixa/connect-tedious

Last synced: about 1 month ago
JSON representation

Connect session store for SQL Server, using Tedious.

• Host: GitHub
• URL: https://github.com/mcartoixa/connect-tedious
• Owner: mcartoixa
• License: mit
• Created: 2013-08-15T12:52:29.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-08-11T13:29:42.000Z (over 7 years ago)
• Last Synced: 2024-11-20T12:18:38.148Z (about 1 month ago)
• Language: JavaScript
• Size: 44.9 KB
• Stars: 3
• Watchers: 2
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
#connect-tedious

[![Build Status](https://ci.appveyor.com/api/projects/status/lychn2r7d0cs36qa/branch/master?svg=true)](https://ci.appveyor.com/project/mcartoixa/connect-tedious/branch/master)

[![Dependency Status](https://david-dm.org/mcartoixa/connect-tedious.png)](https://david-dm.org/mcartoixa/connect-tedious)

[![NPM version](https://badge.fury.io/js/connect-tedious.svg)](http://badge.fury.io/js/connect-tedious)

[connect](https://github.com/senchalabs/connect) session store for SQL Server, using [tedious](http://github.com/pekim/tedious).

## Usage

### Sample

The simplest sample requires a SQL Server 2008+ database with a table created as follows

```javascript

CREATE TABLE [dbo].[Sessions](

  [Sid] varchar(255) NOT NULL

    CONSTRAINT [PK_Sessions] PRIMARY KEY CLUSTERED ([Sid] ASC),

  [Expires] datetimeoffset NOT NULL,

  [Sess] nvarchar(MAX) NULL

)

```

The session store can then be created

```javascript

var express = require('express');

var session = require('express-session');

var TediousStore = require('connect-tedious')(session);

var app = express.createServer()

    .use(express.cookieParser())

    .use(express.session({

        secret: 'mysecret',

        store: new TediousStore({

            config: {

                userName: 'mydbuser',

                password: 'mydbpassword',

                server: 'localhost',

                options: {

                  instanceName: 'SQLEXPRESS',

                  database: 'mydatabase'

                }

            }

        })

    )

);

```

### Syntax

Class `TediousStore`:

* `new TediousStore(options, connectionString)`

  * `options`: *Object*

    * `config`: *Object* The same configuration that would be used to [create a tedious Connection](http://pekim.github.com/tedious/api-connection.html#function_newConnection).

    * `tableName`: *String* The table name. Defaults to `[dbo].[Sessions]`.

    * `sidColumnName`: *String* The session Id column name. Defaults to `[Sid]`.

    * `sessColumnName`: *String* The session content column name. Defaults to `[Sess]`.

    * `expiresColumnName`: *String* The session expiration column name. Defaults to `[Expires]`.

    * `minConnections`: *Number* The minimum number of connections to keep in the pool. Defaults to `0`.

    * `maxConnections`: *Number* The maximum number of connections to keep in the pool. Defaults to `100`.

    * `idleTimeout`: *Number* The number of milliseconds before closing an unused connection. Defaults to `30000`.

  * `connectionString`: *String* A [connection string](https://github.com/ttrider/node-connection-string-builder) that can be used to specify all database related options.

## License

View the [LICENSE](https://github.com/mcartoixa/connect-tedious/blob/master/LICENSE) file