# rethinkdb-express-session

> RethinkDB (official driver) session store for Express

Latest version **1.1.0** (published 2016-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install rethinkdb-express-session
pnpm add rethinkdb-express-session
yarn add rethinkdb-express-session
bun add rethinkdb-express-session
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2016-03-05 |
| First published | 2016-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ilya Radchenko |
| Maintainers | knownasilya |
| Keywords | expressjs, session, store, rethinkdb, rethink, db, connect |

## Links

- npm: https://www.npmjs.com/package/rethinkdb-express-session
- Repository: https://github.com/knownasilya/rethinkdb-express-session
- Homepage: https://github.com/knownasilya/rethinkdb-express-session#readme
- Issues: https://github.com/knownasilya/rethinkdb-express-session/issues
- npm.io page: https://npm.io/package/rethinkdb-express-session

## Dependencies (3)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [rethinkdb](https://npm.io/package/rethinkdb.md) ^2.2.2
- [express-session](https://npm.io/package/express-session.md) ^1.13.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2016-03-05
- 1.0.2 — 2016-03-05
- 1.0.1 — 2016-03-04
- 1.0.0 — 2016-03-04

## README

# rethinkdb-express-session

RethinkDB session store for Express.

This module is a fork off of the [express-session-rethinkdb] module. This module takes the approach
of using the official driver, with the option of using your own instance/version.

## Installation

```
npm install rethinkdb-express-session --save
```

## Getting started

Note that you must already have Express Session already installed (`npm install express-session --save`).

```javascript
var express = require('express');
var cookie = require('cookie-parser');
var session = require('express-session');
var RDBStore = require('rethinkdb-express-session')(session);

var app = express();
var rdbStore = new RDBStore({
  // required, user specified
  database: 'mydb',
  connection: createConnection(),

  // optional, values shown are defaults default
  table: 'sessions',
  sessionTimeout: 86400000,
  flushInterval: 60000,
  instance: require('rethinkdb') // ^2.2.2
});

app.use(cookie());
app.use(session({
  key: 'sid',
  secret: 'my5uperSEC537(key)!',
  cookie: { maxAge: 860000 },
  store: rdbStore
}));

// the rest of your server code..
```

## Constructor options

### `database`
Required. Sets the database you want to use for your sessions table. Throws an error if not specified.

### `connection`
Required. Rethinkdb connection from the `rethinkdb` module. This can be a function that expects a callback, or
a promise. Throws an error if not specified.

### `instance`
Defaults to `require('rethinkdb')` which is set to `^2.2.2`. Specify your own if you need
a different version.

### `table`
Name of the table in which session data will be stored.
`Default: 'sessions'`

### `sessionTimeout`
If you do not set `cookie.maxAge` in `session` middleware, sessions will last until the user closes their browser.
However we cannot keep the session data infinitely (for size and security reasons).
In this case, this setting defines the maximum length of a session, even if the user does not close their browser.
`Default: 86400000` *1 day*

### `flushInterval`
RethinkDB does not yet provide an expiration function ( like `SETEX` for Redis ), so we have to remove the
old expired sessions from the database intermittently. This is the time interval in milliseconds between flushing of expired sessions.
`Default: 60000` *60 seconds*

## Debugging

We use the `debug` module under the hood, so you can set the `DEBUG` env to get debug details.
You can set the following log levels:

- `DEBUG=rethinkdb-express-session:errors npm start` - Will return all errors that might help with debugging.
- `DEBUG=rethinkdb-express-session:status npm start` - Will let you know where it is, with minimal console output.
- `DEBUG=rethinkdb-express-session:details npm start` - Will return any raw responses from the server.
- `DEBUG=rethinkdb-express-session:* npm start` - Will return all logs.


## Attribution

* Forked from armenfilipetyan's [express-session-rethinkdb].
* Inspired by TJ Holowaychuk's [Connect Redis](https://github.com/visionmedia/connect-redis)
* Inspired by guillaumervls [Connect RethinkDB](https://github.com/guillaumervls/connect-rethinkdb)

[express-session-rethinkdb]: https://github.com/armenfilipetyan/express-session-rethinkdb

---
_Source: https://npm.io/package/rethinkdb-express-session · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._