Code Monkey home page Code Monkey logo

rethinkdb-changefeed-reconnect's Introduction

rethinkdb-changefeed-reconnect

Code Climate GPA Code Climate Issue Count Test Coverage

Simple helper module for having RethinkDB changefeed listeners automatically reconnect if they lose their connection (i.e., if the database server goes down or restarts).

Right now, there is a single (default) function exported: processChangeFeedWithAutoReconnect.

Getting Started

  1. Install the module in your project

     $ npm install --save rethinkdb-changefeed-reconnect
    

How to Use

Basically, you need to implement 3 functions and configure your options:

  1. getFeed(): this should return a RethinkDB .changes() query Promise
  2. onFeedItem(item): this is the function that processes each new data item
  3. onError(err): this function is where errors will be sent

The available options are:

  • changefeedName: used for logging purposes so you can differentiate your different feeds
  • attemptDelay: how long (in milliseconds) to wait between reconnect attempts
  • maxAttempts: how many reconnect attempts to try before giving up
  • silent: whether or not you want the logger to be silenced (default = false)
  • logger: must be an object with 4 functions: log, info, warn, and error (default = global.console)

Example

import rethinkdbdash from 'rethinkdbdash'
import processChangefeed from 'rethinkdb-changefeed-reconnect'

const r = rethinkdbdash({servers: {host: 'localhost', port: 28015, db: 'todo'}, silent: true})

processChangefeed(newTasksFeed, handleNewTask, handleError, {
  changefeedName: 'my changefeed',
  attemptDelay: 3000,
  maxAttempts: 3,
  silent: false,
  logger: global.console,
})

function newTasksFeed() {
  r.table('tasks')
    .changes()
    .filter(r.row('old_val').eq(null))
}

function handleNewTask(task) {
  console.log({task})
}

function handleError(err) {
  console.error(err.stack)
}

See also the provided example.

You can run it like so: node example

Then, after you run it, stop your RethinkDB server and watch what gets logged (assuming you passed silent: false in your options).

Notes

This module was developed on top of rethinkdbdash.

Contributing

Read the instructions for contributing.

  1. Clone the repository.

  2. Run the setup tasks:

     $ npm install
     $ npm test
    

License

See the LICENSE file.

rethinkdb-changefeed-reconnect's People

Contributors

internalfx avatar jeffreywescott avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.