Skip to main content

livedata for MongoDB, similar to RDBM triggers or meteorjs livedata

Project description

https://api.travis-ci.org/drorasaf/mongotriggers.svg?branch=master https://coveralls.io/repos/github/drorasaf/mongotriggers/badge.svg?branch=master https://img.shields.io/pypi/v/mongotriggers.svg https://img.shields.io/pypi/dm/mongotriggers.svg Documentation Status

What is this?

mongodb-triggers is a light-weight library to allow real live changes notification. This is similar to triggers in SQL. This capability can be found both in Java and JavaScript(MeteorJS)

What is it good for?

Modern applications have become near real-time response and updates, this leads to the requirement that any changes done in the data to be propagated up to the top level of the application as soon as possible.

In order to allow this to happen, any changes in the databases must be notified, similar project that use this method is https://github.com/meteor/meteor.

More Documentation can be found at http://mongotriggers.readthedocs.io

Installation

Installer is available on PyPI. You can install it through pip:

$ pip install mongotriggers

Why should I use it?

The best functionality is the one that another one is maintaining for you, as well as 100% code coverage. This package follows best practices as published by MongoDB: - https://www.mongodb.com/blog/post/tailing-mongodb-oplog-sharded-clusters - https://www.mongodb.com/blog/post/pitfalls-and-workarounds-for-tailing-the-oplog-on-a-mongodb-sharded-cluster

How to use?

Let’s assume the system in development is a financial one, and every deletion in the database is extremely important, so we would like to notified for each deletion.

from mongotriggers import MongoTrigger
from pymongo import MongoClient

def notify_manager(op_document):
    print ('wake up! someone is adding me money')

client = MongoClient(host='localhost', port=27017)
triggers = MongoTrigger(conn)
triggers.register_op_trigger(notify_manager, 'my_account', 'my_transactions')

triggers.tail_oplog()
client['my_account']['my_transactions'].insert_one({"balance": 1000})
triggers.stop_tail()

Keep in mind that it is meant to run in a defered context in order to run endlessly until it is cancelled.

Testing

In order to develop, the additional requirements are:

  • pytest

  • pytest-cov

  • tox

All packages can be installed using pip. The easiest way to run the tests is to run tox.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mongotriggers-2.0.1.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mongotriggers-2.0.1-py2.py3-none-any.whl (7.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mongotriggers-2.0.1.tar.gz.

File metadata

  • Download URL: mongotriggers-2.0.1.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mongotriggers-2.0.1.tar.gz
Algorithm Hash digest
SHA256 74a31438a9013c72906a3b7f07a13bf2f688832090d03103036f11c7425112a4
MD5 dbba9423fc6fbfc78f1d5257f8dce721
BLAKE2b-256 1e8ffd70e3290242d2c3c02a8878127e2bd91161f380d81c07735c656a1ec1c2

See more details on using hashes here.

File details

Details for the file mongotriggers-2.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for mongotriggers-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 220c69eef774510898ce52ba5bafc39e741d641f34349edc094fde6d8b196ffd
MD5 79bad67ff1fd0e5462b975c358bdfc57
BLAKE2b-256 4984fa233d8888593cca7a8094a7981896ca39579ada056b92330a78e4ed52d6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page