sails-hook-mongoat

Provides advanced mongo indexing options for sails.js models that use the sails-mongo adapter. Working with sails1, check previuos version to work with sails v0.10, v0.11 and v0.12: https://github.com/Josebaseba/sails-hook-mongoat/blob/81d6783be379ccb6e86e396d173f4659ab16abdd/index.js

Usage

To use this forked repository clone this repository inside the api/hooks/ folder:

  cd api/hooks
  
  git clone https://github.com/Josebaseba/sails-hook-mongoat

Then simply add an 'indexes' array property to your sails model(s) that you want to add custom indexers on. This contains all your indexes.

Index properties:

• attributes - an object with the attributes to index (can also be text indexes)
• options (optional) - index options (see Mongo Index Options)

In the config.model set createIndexes attribute as true

  config.model.createIndexes = true

To force the indexes creations on each lift: https://github.com/Josebaseba/sails-hook-mongoat/blob/master/index.js#L45

Just go to the models file and set:

module.exports.models = {

  createIndexes: true, // Generate the indexes in each lift

  //etc...

  //connection: 'mongodb-development'

  migrate:"safe",

  schema: true

};

Examples

Creating a 'expires after' index

// MY MODEL WITH A DATE FIELD
module.exports = {
  attributes: {
    myDate: {
      type: 'date',
      required: true
    }
  },
  indexes: [
    {
      attributes: {
        myDate: 1
      },
      options: {
        expireAfterSeconds: 60  // expire 60s after myDate
      }
    }
  ]
};

Creating a composite unique index

// MY EVENTS MODEL
module.exports = {
  attributes: {
    event_id: {
      type: 'integer',
      required: true
    },
    match_id: {
      type: 'integer',
      required: true
    }
  },
  indexes: [
    //event & match composite index
    {
      attributes: {
        event_id: -1,    // desc
        match_id: 1      // asc
      },
      options: {
        unique: true
      }
    }
  ]
};

Creating a different indexes

// MY EVENTS MODEL
module.exports = {
  attributes: {
    event_id: {
      type: 'integer',
      required: true
    },
    match_id: {
      type: 'integer',
      required: true
    }
  },
  indexes: [
    {
      attributes: {
        match_id: 1   // asc
      },
      options: {
        unique: true
      }
    }, {
      attributes: {
        match_id: 1   // asc
      }
    }
  ]
};

Contributing

Fork the repo, make your changes and submit a pull request.