https://github.com/deepstreamio/deepstream.io-storage-rethinkdb
A deepstream.io storage connector for RethinkDB
https://github.com/deepstreamio/deepstream.io-storage-rethinkdb
Last synced: 7 months ago
JSON representation
A deepstream.io storage connector for RethinkDB
- Host: GitHub
- URL: https://github.com/deepstreamio/deepstream.io-storage-rethinkdb
- Owner: deepstreamIO
- License: other
- Created: 2015-01-28T09:27:17.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:32:43.000Z (about 3 years ago)
- Last Synced: 2025-08-19T13:55:22.726Z (8 months ago)
- Language: TypeScript
- Size: 655 KB
- Stars: 25
- Watchers: 9
- Forks: 19
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# deepstream.io-storage-rethinkdb
[](https://coveralls.io/github/deepstreamIO/deepstream.io-storage-rethinkdb?branch=master)
[](https://www.npmjs.com/package/deepstream.io-storage-rethinkdb)
[](https://david-dm.org/deepstreamIO/deepstream.io-storage-rethinkdb)
[](https://david-dm.org/deepstreamIO/deepstream.io-storage-rethinkdb#info=devDependencies)
[](https://david-dm.org/deepstreamIO/deepstream.io-storage-rethinkdb#info=devDependencies)
[Deepstream](http://deepstream.io) storage connector for [RethinkDB](http://rethinkdb.com/)
This connector uses [the npm rethinkdb package](https://www.npmjs.com/package/rethinkdb). Please have a look there for detailed options.
**Warning**: This plugin will automatically create a table, if it doesn't exist yet. But be aware, in case you create a table manually, use "ds_id" as the primary key. Otherwise the plugin won't be able to find your records.
## Configuration Options
```yaml
plugins:
storage:
name: rethinkdb
options:
host: ${RETHINKDB_HOST}
port: ${RETHINKDB_PORT}
db: 'someDb'
defaultTable: 'someTable'
splitChar: '/'
```
```javascript
{
//The host that RethinkDb is listening on
host: 'localhost',
//The port that RethinkDb is listening on
port: 28015,
//(Optional) Authentication key for RethinkDb
authKey: 'someString',
//(Optional, defaults to 'deepstream')
db: 'someDb',
//(Optional, defaults to 'deepstream_records')
defaultTable: 'someTable',
/* (Optional) A character that's used as part of the
* record names to split it into a tabel and an id part, e.g.
*
* books/dream-of-the-red-chamber
*
* would create a table called 'books' and store the record under the name
* 'dream-of-the-red-chamber'
*/
splitChar: '/'
}
```
## Basic Setup
```javascript
const { Deepstream } = require('@deepstream/server')
const server = new Deepstream({
storage: {
name: 'rethinkdb',
options: {
host: 'localhost',
port: 28015
}
},
})
server.start();
```