RethinkDB Proxy

Reverse proxy for RethinkDB

Make your RethinkDB publicly accessible through limiting what kind of queries can be executed on your RethinkDB database.

Introduction by Example

First, start the proxy.

$ rethinkdb-proxy --port 8125

Using the proxy, getting all users in the users table is allowed.

r.connect({ port: 8125 }).then((conn) => {
  r.table('users').coerceTo('array').run(conn)
    .then((results) => {
      // We have some results!
      console.log(results); // [{ name: 'jorge' }, ... ]
    });
});

But deleting the users is not:

import rethinkDBProxy from 'rethinkdb-proxy';
rethinkDBProxy({ port: 8125 });
 
r.connect({ port: 8125 }).then((conn) => {
  r.table('users').delete('array').run(conn)
    .catch((err) => {
      // We get an error!
      console.log(err); // RqlClientError: Cannot execute query. "DELETE" query not allowed
    });
});

Running rethinkdb-proxy

CLI

rethinkdb-proxy comes with a CLI out-of-the box:

rethinkdb-proxy --port 8125 

Module

You can also import rethinkdb-proxy into Node.js:

import rethinkDBProxy from 'rethinkdb-proxy';
rethinkDBProxy({ port: 8125, allowInsert: true });

Options

• port
• rdbHost
• rdbPort
• dbs
• allowSysDbAccess
• tables
• allowWrites
• allowInsert
• allowUpdate
• allowDelete
• allowReplace
• allowDbCreate
• allowDbDrop
• allowTableCreate
• allowTableDrop
• allowIndexes
• allowIndexCreate
• allowIndexDrop
• allowIndexRename
• allowReconfigure
• allowRebalance
• allowHttp
• allowJavascript

Port

Port in which to listen for driver connections. You should point your driver to this port.

RethinkDB Host

Host in which RethinkDB is running.

RethinkDB Port

Host in which RethinkDB is running.

Databases

Database to allow access to. By default, all database are allowed except rethinkdb.

Allow System Database Access

Allow access to the rethinkdb database. This is not allowed by default, because access to this database allows to delete all other data.

Tables

Tables to allow access to. Tables must include their database db.table.

Allow Writes

Allow all operations that write to the database (insert, update, delete).

Allow insert

Allow insert queries.

Allow update

Allow update queries.

Allow delete

Allow delete queries.

Allow replace

Allow replace queries.

Allow dbCreate

Allow dbCreate queries

Allow dbDrop

Allow dbDrop queries

Allow tableCreate

Allow tableCreate queries.

Allow tableDrop

Allow tableDrop queries.

Allow Indexes

Allow all operations on indexes (indexCreate, indexDrop, indexRename).

Allow indexCreate

Allow indexCreate queries.

Allow indexDrop

Allow indexDrop queries.

Allow indexRename

Allow indexRename queries.

Allow reconfigure

Allow reconfigure queries.

Allow rebalance

Allow rebalance queries.

Allow http

Allow queries with the http term.

Allow js

Allow queries with the js term.