Rethinkdb Connection Helper
This is a simple rethinkdb node tool to easily manage a connection, run queries, handle cursors, etc.
Installation
npm install rethinkdb-helper
Usage
It's very simple to use.
Require necessary items
var r = require('rethinkdb')
var rdbHelper = require('rethinkdb-helper')
Init connection object
The init
method takes two arguments: your rethinkdb driver, and connection options object:
var options = {
db: 'test',
}
var connection = rdbHelper.init(r, options)
Connection Object
The init
method returns a connection
object, which comes with several useful methods/values:
connection.connect()
Takes no arguments. Establishes the connection to the db.
Returns: Promise, which resolves to actual connection.
connection.run(query)
Arguments: Any rethinkdb query.
Returns: Promise, which resolves to JSON. It will handle the cursor for you, it will either return a single object (if asking for one object) or an array, whichever is applicable.
connection.connection
This data is the connection itself, in case you need access to it.
connection.options
This is simply the options object you passed in, in case you need access to any of these values.
Examples
var r = require('rethinkdb')
var rdbHelper = require('rethinkdb-helper')
var dbOptions = {
db: 'test',
host: 'localhost',
port: 28015
}
var connection = rdbHelper.init(r, dbOptions)
connection.connect().then(function(connection) {
})
var query = r.table('users').get('15d-2d4-12a')
connection.run(query).then(function(user) {
})
var query = r.table('users').filter({firstName: 'John'})
connection.run(query).then(function(users) {
})