ag-crud-rethink

ag-crud-rethink

Realtime CRUD data management layer/plugin for SocketCluster using RethinkDB as the database.

See https://github.com/SocketCluster/ag-crud-sample for a full working sample.

Setup

See https://github.com/SocketCluster/ag-crud-sample for sample app which demonstrates this component in action.

This module is a plugin for SocketCluster, so you need to have SocketCluster installed: https://socketcluster.io/ Once SocketCluster is installed and you have created a new project, you should navigate to your project's main directory and run:

npm install ag-crud-rethink --save

Now you will need to attach the plugin to your SocketCluster server - So open server.js and pass the agServer instance to the attach function exposed by this module.

As shown in the sample above, you will need to provide a schema for your data. In the example above, the Category, Product, and User keys represent tables/models within RethinkDB - Inside each of these, you need to declare what fields are allowed and optionally the views which are supported for each model type.

Simply put, a view is an ordered, filtered subset of all documents within a table. Views need to define a filter and/or order function which will be used to construct the view for table's data.