Miss any of our Open RFC calls?Watch the recordings here! »


1.0.3 • Public • Published

deepstream.io-storage-cockroachdb npm version Build Status

Deepstream.io storage connector for CockroachDB

What is CockroachDB?

CockroachDB is database server which is used as scalable replacement of MySQL. It partially supports PostgreSQL syntax involving some unique stylings. It is scalable by default and running seemlessly local, so properly configurated server instances may be manipulated even by Bash script. CockroachDB is initially distributed and performs proper data exchange between nodes automatically which makes possible strong consistence and high stability of your data storage.

Why use CockroachDB with Deepstream?

CockroachDB is one of supported connectors for Deepstream which is used for data recording. It is modified to get PostgreSQL-based relational storage working with Deepstream data structure which are JSON blobs identified by keys. CockroachDB is focused on high stability and scalability of several separated workers with access to same data storages.


You need at least one properly working CockroachDB worker to get this connector running. Also there is no SSL-certs authentication yet supported for accessing CockroachDB workers so you must use classic login/password credentials.

Using CockroachDB with Deepstream

Deepstream can connect to CockroachDB using the "CockroachDB storage connector", a plugin that connects to the database and automatically syncs incoming and outgoing record updates.

Installing the CockroachDB storage connector

You can install the CockroachDB storage connector via Deepstream's commandline interface, using:

deepstream install storage cockroachdb

or in Windows:

deepstream.exe install storage cockroachdb

resulting in Deepstream CockroachDB connector install command line output.

If you're using Deepstream's Node.js interface, you can also install it as an NPM module:

npm i perimetral/deepstream.io-storage-cockroachdb

Configuring the CockroachDB storage connector

You can configure the storage connector plugin in deepstream with the following options considering there are additional ones which are must be set at CockroachDB config (look here for details):

You may use Deepstream YAML config file with such formatting:

    name: deepstream.io-storage-cockroachdb
      ds_cockroach: 'postgresql://root@localhost:26257?sslmode=disable'
      ds_dbName: 'deepstream'
      ds_tableName: 'deepstream_storage'
      ds_keyType: 'text'
      ds_valueType: 'text'
      ds_splitter: '/'


  • ds_cockroach: PostgreSQL connection string
  • ds_databaseName, ds_tableName: data preferences (if such database or table are missing new one is created with specified name)
  • ds_keyType, ds_valueType: data types for data recording (all of input will be converted to this types)
  • ds_splitter: string which determines symbols to split category and exactly key in key argument passed for data manipulating

Usage example

Here is simple example of connecting and using of CockroachDB connector:

let ds = require('deepstream.io');
let connector = require('deepstream.io-storage-cockroachdb');
let server = new ds();
server.set('storage', new connector({}));

Configuring from Javascript

If you installed connector as NPM plugin, you may reconfigure it right in runtime like here:

server.set('storage', new connector({
  cockroach: 'postgresql://root@localhost:26257?sslmode=disable',
  dbName: 'deepstream',
  tableName: 'deepstream_storage',
  keyType: 'text',
  valueType: 'text',
  splitter: '/',

Do not forget to run server.start() after connecting and configuring connector. Yay!




npm i deepstream.io-storage-cockroachdb

DownloadsWeekly Downloads






Last publish


  • avatar
  • avatar