Quentin01/esq

Simple query builder for elasticsearch

ESQ

ESQ is a helper module for elasticsearch. It aims to provide an easy way of creating elasticsearch queries. Run node examples to see all of the examples from the elasticsearch docs generated using esq!

Quick Examples

var ESQ = require('esq');
var esq = new ESQ();

esq.query('bool', ['must'], { match: { user: 'kimchy' } });
esq.query('bool', ['must_not'], { range: { age: { from: 10, to: 20 } } });
esq.query('bool', ['should'], { term: { tag: 'wow' } });
esq.query('bool', ['should'], { term: { tag: 'elasticsearch' } });
esq.query('bool', 'minimum_should_match', 1);
esq.query('bool', 'boost', 1.0);

// query == {
//   "bool": {
//     "must": [
//       {
//         "match": {
//           "user": "kimchy"
//         }
//       }
//     ],
//     "must_not": [
//       {
//         "range": {
//           "age": {
//             "from": 10,
//             "to": 20
//           }
//         }
//       }
//     ],
//     "should": [
//       {
//         "term": {
//           "tag": "wow"
//         }
//       },
//       {
//         "term": {
//           "tag": "elasticsearch"
//         }
//       }
//     ],
//     "minimum_should_match": 1,
//     "boost": 1
//   }
// }

---

var ESQ = require('esq');
var esq = new ESQ();

esq.query('query', 'match', 'foo', 'bar');
esq.query('query', 'range', 'x', { gte: 1, lte: 5 });
esq.query('query', 'wildcard', 'test', 'value', 'what*');

var query = esq.getQuery();

// query == {
//   "query": {
//     "match": {
//       "foo": "bar"
//     },
//     "range": {
//       "x": {
//         "gte": "1",
//         "lte": "5"
//       }
//     },
//     "wildcard": {
//       "test": {
//         "value": "what*"
//       }
//     }
//   }
// }

Download

npm install esq

In the Browser

Currently it's not been tested in any browsers, but i'm sure it'll work with most modern browsers.

Usage:

<script src="esq.js"></script>
<script>
  var esq = new ESQ();
  esq.query('query', { match: { foo: 'bar' } });
  var query = esq.getQuery();
</script>

Documentation

esq.getQuery();

This will return the query at the current stage.

Example

esq.query('query', 'match', 'foo', 'bar');
var query = esq.getQuery();

Generates

{
  query: {
    match: {
      foo: 'bar'
    }
  }
}

---

esq.query(str, ..., str, value);

You can pass this function as many strings as you want and you'll receive a nested object with the arguments as keys. The final argument should always be the value you want to assign to the second to last argument. This function will always return the query at its current state.

Example

esq.query('filtered', 'query', 'match', 'foo', 'bar');

Generates

{
  filtered: {
    query: {
      match: {
        foo: 'bar'
      }
    }
  }
}

The function also allows you to pass in an argument as an array (this array should only be one element). This tells the function that you want that key to be an array and so it'll push the following arguments into the array.

Example

esq.query('filtered', 'query', 'bool', ['must'], 'match', 'foo', 'bar');

Generates

{
  filtered: {
    query: {
      bool: {
        must: [
          {
            match: {
              foo: 'bar'
            }
          }
        ]
      }
    }
  }
}