sails-hook-thinky v0.0.9

sails-hook-thinky

A hook to enable the Thinky ORM for RethinkDB in Sails.

DEPRECATED in favor of the more generic thinky-loader.

Installation

npm install sails-hook-thinky

or add to package.json

Usage

The hook configures the thinky orm and expsoses the thinky instance to the global thinky. All model files in the /api/thinky directory will be loaded automatically and exposed in the sails.thinkymodels propery and optionally to the global namespace.

Make model calls from any service, controller, policy, etc. just as you would normally. No need to require thinky or any model files.

Post.getJoin().then(function(posts) {
     console.log(posts);
 });

Configuration

Create a new directory /api/thinky in your sails app (or customize - see below). This will be where your thinky model files will be auto-loaded by the hook.

Create a new configuration file thinky.js in the sails app /config directory.

/**
 * Thinky config
 * (sails.config.thinky)
 *
 */

module.exports.thinky = {

  rethinkdb: {
      host: "localhost",
      port: 28015,
      authKey: "",
      db: "test"
  },
  path: "<path to thinky models directory - default is '/api/thinky'>"
    
};

Optional: edit the .sailsrc file to disable Waterline to prevent any conflicts. (pubsub and blueprints will also need to be disabled due to dependencies on Waterline)

{
  "generators": {
    "modules": {}
  },
  "hooks": {
    "orm": false,
    "pubsub": false,
    "blueprints": false
  }
}

Model file configuration

Create a file for each thinky model object with the contents below. The hook will scan each model definition and load it on startup.

var type = thinky.type;

module.exports = {

    tableName: "Car", // optional, will use name of file if not present
    schema: {
        id: type.string(),
        type: type.string(),
        year: type.string(),
        idOwner: type.string()
    },
    options: {},

    // set up any relationships, indexes or function definitions here
    init: function(model) {
        model.belongsTo(Person, "owner", "idOwner", "id");
        
        model.ensureIndex("type");
        
        model.define("isDomestic", function() {
            return this.type === 'Ford' || this.type === 'GM';
        });
    }

};

*Also see examples directory for sample model files.