Git Product home page Git Product logo

redis-oplog's Introduction

Welcome to Redis Oplog

LICENSE: MIT

Build Status

RedisOplog

A full re-implementation of the Meteor's MongoDB oplog tailing. This time, reactivity is controlled by the app, opening a new world into building reactive applications, highly scalable chat apps, games, and added reactivity for non-persistent data.

Incrementally adoptable & works with your current Meteor project.

Premium Support

If you are looking to scale your business using this package and you need to have your back covered. We are here to help. Feel free to contact-us at [email protected].

Installation

meteor add cultofcoders:redis-oplog
meteor add disable-oplog

Configure it via Meteor settings:

// settings.json 
{
    ...
    "redisOplog": {}
}

// default full configuration
{
  ...
  "redisOplog": {
    "redis": {
      "port": 6379, // Redis port
      "host": "127.0.0.1" // Redis host
    },
    "mutationDefaults": {
        "optimistic": false, // Does not to a sync processing on the diffs
        "pushToRedis": true // Pushes to redis the changes by default
    }
    "debug": false, // Will show timestamp and activity of redis-oplog.
    "overridePublishFunction": true // Meteor.publish becomes Meteor.publishWithRedis, set to false if you don't want to override it
  }
}
meteor run --settings settings.json

Notes

RedisOplog is fully backwards compatible, so there won't be any change in how you use Meteor, unless you want to fine-tune your application for absolute performance.

To make sure it is compatible with other packages which extend the Mongo.Collection methods, make sure you go to .meteor/packages and put cultofcoders:redis-oplog as the first option.

RedisOplog does not work with insecure package, which is used for bootstrapping your app.

Redis Unavailability

If redis server fails, it will console.error this fact, and it will keep retrying to connect every 30 seconds. Once connection is resumed reactivity will be resumed. However, changes that happened while Redis was down will not be visible. In future we will treat this scenario.

Stats

If you are interested in viewing how many observers are registered or memory consumption:

meteor shell
import { RedisOplog } from 'meteor/cultofcoders:redis-oplog';

// works only server-side
RedisOplog.stats()

If you are using optimistic ui in your application, you should give this a read.

Find out what Redis Oplog does behind the scenes

Find out how you can use the advantages of Redis Oplog to make your app very performant.

redis-oplog's People

Contributors

theodordiaconu avatar maxnowack avatar jamesgibson14 avatar claudiuroman avatar ramezrafla avatar

Watchers

hems.io avatar James Cloos 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.