Elasticsearch adapter for Sails / Waterline

Usage no npm install needed!

<script type="module">
  import sgadekar81SailsElastic from 'https://cdn.skypack.dev/@sgadekar81/sails-elastic';



Join the chat at https://gitter.im/mie00/sails-elasticsearch


To install this adapter, run:

$ npm install sails-elastic



    adapter: 'sails-elastic',
    hosts: [''],
    keepAlive: false,
    sniffOnStart: true,
    maxRetries: 10,
    deadTimeout: 40000,
    sniffOnConnectionFault: true,
    apiVersion: '2.0'



sails-elastic does not support attributes inside the model. It gets its attributes from another attribute in the model called elasticSearch. There you can tell elasticsearch how to create the index. You can find more information here.

// person model
module.exports = {
    elasticSearch: {
        mappings: {
            person: {
                properties: {
                    name: {
                        type: "string",
                    adress: {
                        type: "string",
                        index: "not_analyzed"
                    age: {
                        type: "integer",
Multiple adapters

To use multiple adapters for the same model. you have to make elasticsearch the last one, and manually sync create, update, destroy between adapters

module.exports = {
    connection: ['mongoConnection','elasticConnection'],
    elasticSearch: {/*...*/},
    attributes: {/*...*/},
    afterCreate: function (value, callback){
        this.createIndex(value, callback)
    afterUpdate: function (value, callback){
        this.updateIndex(value.id, value, callback)
    afterDestroy: function (value, callback){
        this.destroyIndex(value.id, callback)

Warning: for sails v11.0 and earlier, connection attribute used to be defined with an 's'.


This adapter exposes the following methods (you can pass a callback function to them or use them as bluebird promises):

  • search(criteria, callback)

  • createIndex(value, callback) === create(value, callback)

  • updateIndex(id, value, callback) === update(id, value, callback)

  • destroyIndex(id, callback) === destroy(id, callback)

  • countIndex(criteria, callback) === count(criteria, callback)

  • bulk(body, callback)

  • client()

  • returns
    • Elasticsearch client instance to call methods directly to elasticsearch API. You can find API reference here


Fully support Semantic and Queryable interfaces.