README.md

This is a NoSQL Database, to be precise: a JSON document store with MQTT interface, CouchDB/MapReduce inspired views, implemented in Node.js. 🤠

It's intended to be used as a database for storing metadata in systems that use MQTT as message bus, I'm using it in conjunction with mqtt-smarthome, but I think it could be useful in other MQTT based environments also.

You can create and modify documents by publishing JSON payloads to MQTT and receive document changes by simply subscribing to certain topics. You can create views by defining map and reduce functions and filter document ids with MQTT style wildcards.

Note that this project is not associated with or endorsed by http://mqtt.org

Documentation

• Introduction
• Install
• Command Line Parameters
  • Connecting to the MQTT Broker
• WebUI
• Documents
  • Document IDs
  • Create or Overwrite Documents
  • Extend Documents
  • Delete Documents
  • Property Access
  • Internal Properties
• Views
  • What are Views?
  • Create Views
  • Delete Views
  • Javascript
  • How Views are Composed
• View Examples
• Topic Reference
  • Topics on which mqttDB publishes
  • Topics subscribed by mqttDB
• Sandbox Reference
• Performance

Contributing

Any form of feedback is highly appreciated, may it be questions, suggestions, feature requests, bug reports, critics, salutes or rants! 😉 Feel free to create an Issue!

Pull Requests Welcome!

License

MIT (c) 2017 Sebastian Raff